-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
otlpmetricgrpc otlpmetrichttp: Add README.md #4336
otlpmetricgrpc otlpmetrichttp: Add README.md #4336
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit (general comment): What do you think of adding (almost the same) README.md
for otlpmetrichttp
and otlpmetricgrpc
directories instead?
Removed the unified readme. Added make target to lint markdown locally.
The filename is in lowercase, while every other readme in the repo is uppercase. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
few nit comments. Nice work 👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The description for OTEL_EXPORTER_OTLP_TRACES_*
are missing.
Co-authored-by: Robert Pająk <pellared@hotmail.com>
Yes, I have not included any of the Trace environment variables in the Metrics documentation PR. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@MadVikingGod PTAL, I did my best to update this PR. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I found out that we can document WithURLPath
Codecov Report
@@ Coverage Diff @@
## main #4336 +/- ##
=====================================
Coverage 81.7% 81.7%
=====================================
Files 225 225
Lines 18044 18044
=====================================
+ Hits 14750 14752 +2
+ Misses 2996 2994 -2
Partials 298 298 |
This is a first pass at adding a readme to the otlpmetric exporter.
It is mostly a copy of the otlptrace readme. The attempt is to make this look presentable in github's markdown, and in pkg.go.dev.