otelcol-lsp

README

otelcol-lsp

A WIP Implementation of an LSP for OpenTelemetry Collector configurations.

⚠ This is currently not designed for standalone IDE usage. This package is meant to be used as an LSP API to be embedded in other applications.

Supports:

• Validates yaml format
• Validates top-level OpenTelemetry Collector structure:
  • Can only specify receivers, connectors, processors, extensions, exporters and service as top-level keys
  • Validates component and pipeline ID syntax (type / type/name)
  • Validates that components referenced in service pipelines are defined in their component sections
  • Validates that component types are valid for their kind, and that connectors are referenced as exporter/receiver on valid signals
  • Validates that pipelines have the minimum required references
• Distribution-aware validation:
  • Detects the target collector distribution and version
  • Validates configs against real OpenTelemetry Collector binaries and their per-distribution component metadata

Planned:

• Hover and complete functionality for top level components
• Per-component static validation against a YAML schema
• Per-component hover and complete functionality
• Validating extension ID where applicable. E.g. a processor that requires a storage extension type/ID must have that type/id defined.
• OTTL LSP
• Validating yaml of specific components, e.g. a standalone receiver definition, by adding support for components using document URIs, e.g. receiver://<...>

Not planned, but would be nice to have:

• Support formats other than YAML
• Publishing LSP as IDE extensions, vscode, jetbrains, etc...

Distribution aware validation

Clients connecting to this LSP should specify distribution=<otel-distro> and version=<otel-distro-version> in the Document URI.

Relies on a filesystem structure that looks like <base-path>/<distribution>/<version>/otelcol.

For the lsp you can specify the base path at with the flag --cache <base-path>. Defaults to var/lib/cache/otelconf.

For example:

├── otelcol
│   ├── 0.156.0
│   │   └── otelcol
│   └── 0.157.0
│       └── otelcol
├── otelcol-contrib
│   ├── 0.156.0
│   │   └── otelcol
│   └── 0.157.0
│       └── otelcol
├── otelcol-ebpf-profiler
│   ├── 0.156.0
│   │   └── otelcol
│   └── 0.157.0
│       └── otelcol
├── otelcol-k8s
│   ├── 0.156.0
│   │   └── otelcol
│   └── 0.157.0
│       └── otelcol
└── otelcol-otlp
    ├── 0.156.0
    │   └── otelcol
    └── 0.157.0
        └── otelcol

bindistgen is available to generate these paths based on a config file. See examples

Special thanks

• goccy/go-yaml for the amazing YAML library.
• OpenTelemetry project for the amazing on-going work.