opentelemetry-specification
opentelemetry-specification copied to clipboard
Are there any plans to create a tool for checking deployment configuration and instrumentation patterns?
All the 3 data types can be validated at design time using static analysis and also evaluated at run-time. For metrics exposed in Prometheus exposition format, we have Promtool, an official binary part of Prometheus delivery to verify application instrumentation and also validate the configuration of Prometheus deployment. Check out https://github.com/prometheus/prometheus/tree/main/cmd/promtool for inspiration.
Do we have any handy utility to serve the need in OTel?
Hi @tejaswiniVadlamudi! The OTel collector validates its config on startup and logs errors, so one could use the otelcorecol/otelcontribcol executable or the respective Docker image directly to validate the config. The ability to validate instrumentation code at compile time would highly depend on the respective language SDK you're interested in. I recommend asking directly in the respective repo or reaching out to SDK maintainers in the CNCF Slack (see https://github.com/open-telemetry/community#discussions). There is no overall validation tool available or planned as far as I'm aware.
@arminru I was after a tool in OTEL that does similar work to Promtool. Not sure how OTEL-specific config files are planned to be handled today at design time.