https://github.com/nimbushq/otel-validator

https://github.com/nimbushq/otel-validator

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/nimbushq/otel-validator
• Owner: nimbushq
• License: apache-2.0
• Created: 2023-08-19T00:52:32.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-08T17:52:07.000Z (about 1 year ago)
• Last Synced: 2024-06-28T05:38:55.172Z (5 months ago)
• Language: TypeScript
• Size: 1.59 MB
• Stars: 24
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# OTEL Validator

OTEL Validator is a tool for validating your [otel-collector](https://opentelemetry.io/docs/collector/) configuration. 

It supports autocomplete of fields, inline documentation, and validation of the your otel configuration. 

## Features

### Autocomplete

Intellisense for all components and properties

![autocomplete](./media/complete-with-defaults.gif)

### Inline Documentation

Documentation for supported configurations

![inline docs](./media/inline-docs-50.gif)

### Config Validation

Real time validation of fields

![config validation](./media/validation.gif)

## Getting Started

Open up an otel-config. If you don't have one handy, feel free to copy and paste the following example into a new file: "otel-config.yaml".

> NOTE: currently, OTEL validator will automatically check all `yaml` files that match the prefix `otel*`

```yaml

exporters:

  logging:

    verbosity: sda

  zipkin:

    endpoint: "http://zipkin-all-in-one:9411/api/v2/spans"

    format: proto

  jaeger:

    endpoint: jaeger-all-in-one:14250

    tls:

      insecure: true

processors:

  batch:

extensions:

  health_check:

  pprof:

    endpoint: :1888

  zpages:

    endpoint: :55679

service:

  extensions: [pprof, zpages, health_check]

  pipelines:

    traces:

      receivers: [otlp]

      processors: [batch]

      exporters: [logging, zipkin, jaeger]

    metrics:

      receivers: [otlp]

      processors: [batch]

      exporters: [logging, prometheus]

```

## Limitations

- doesn't currently support [connectors](https://opentelemetry.io/docs/collector/configuration/#connectors)

- all components can be null - we currently don't detect whether a property is required or optional

- `durations` are currently tread as strings. this means values like `5m_foobar` will not be flagged

## Acknowledgements

This extension makes use of the output of [cfgmetadatagen](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/cmd/configschema/cfgmetadatagen/cfgmetadatagen/README.md) which extracts configuration metadata from various collector components.