Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Are there any plans to create a tool for checking deployment configuration and instrumentation patterns? #101

Open
tejaswiniVadlamudi opened this issue Mar 28, 2022 · 4 comments
Assignees
Labels
question Further information is requested

Comments

@tejaswiniVadlamudi
Copy link

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?

@arminru
Copy link
Member

arminru commented Apr 20, 2022

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 arminru added the question Further information is requested label Apr 20, 2022
@tejaswiniVadlamudi
Copy link
Author

@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.

@mtwo
Copy link
Member

mtwo commented Jul 9, 2024

Moving to the configuration SIG to see if they're interested in providing this

@mtwo mtwo transferred this issue from open-telemetry/opentelemetry-specification Jul 9, 2024
@tsloughter
Copy link
Member

I'd not used promtool before but it looks like it validates stuff in the prometheus server which would correspond to the collector not the SDK configuration.

It looks like it does much more than just validate rules, I just looked quick, but all seemed outside the scope of configuration of the SDK (and instrumentations). The configuration is validated by the jsonschema which each SDK will perform, or use the tool in #94 -- but again, not similar to promtool as far as I can tell.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

4 participants