-
Notifications
You must be signed in to change notification settings - Fork 829
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
Document TraceConfig #1550
Document TraceConfig #1550
Conversation
Signed-off-by: Sergei Malafeev <sergei@malafeev.org>
Signed-off-by: Sergei Malafeev <sergei@malafeev.org>
Codecov Report
@@ Coverage Diff @@
## master #1550 +/- ##
=========================================
Coverage 91.45% 91.45%
Complexity 960 960
=========================================
Files 116 116
Lines 3440 3440
Branches 281 281
=========================================
Hits 3146 3146
Misses 205 205
Partials 89 89
Continue to review full report at Codecov.
|
QUICKSTART.md
Outdated
| otel.config.sampler.probability | OTEL_CONFIG_SAMPLER_PROBABILITY | Sampler which is used when constructing a new span | | ||
| otel.config.max.attrs | OTEL_CONFIG_MAX_ATTRS | Max number of attributes per span | | ||
| otel.config.max.events | OTEL_CONFIG_MAX_EVENTS | Max number of Events per span | | ||
| otel.config.max.links | OTEL_CONFIG_MAX_LINKS | Max number of Link} entries per span | |
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.
extra }
after Link
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.
fixed
QUICKSTART.md
Outdated
| System property | Environment variable | Purpose | | ||
|----------------------------------|----------------------------------|----------------------------------------------------| | ||
| otel.config.sampler.probability | OTEL_CONFIG_SAMPLER_PROBABILITY | Sampler which is used when constructing a new span | | ||
| otel.config.max.attrs | OTEL_CONFIG_MAX_ATTRS | Max number of attributes per span | |
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.
For all MAX attributes it would be useful to say what happens if that limit is exceeded.
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.
javadoc doesn't say what happens, I suppose exceeded should be dropped.
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.
Yes, extra attributes/links/events will be dropped. Too long values will be truncated.
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.
updated
Thanks for documentation PRs! |
Signed-off-by: Sergei Malafeev <sergei@malafeev.org>
Signed-off-by: Sergei Malafeev <sergei@malafeev.org>
QUICKSTART.md
Outdated
@@ -402,6 +403,43 @@ tracerProvider.addSpanProcessor(BatchSpanProcessor.newBuilder( | |||
).build()); | |||
``` | |||
|
|||
### TraceConfig | |||
|
|||
`TraceConfig` associated with `TracerSdkProvider` can be updated via system properties, |
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.
`TraceConfig` associated with `TracerSdkProvider` can be updated via system properties, | |
The `TraceConfig` associated with a `TracerSdkProvider` can be updated via system properties, |
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.
done
Looks good! Just one tiny update to the text desired. Thanks for the contribution! |
Maybe document the default values? (and if you don't mind, a PR to sync https://github.com/open-telemetry/opentelemetry-java-instrumentation#trace-config) |
Signed-off-by: Sergei Malafeev <sergei@malafeev.org>
@trask I added default values |
fix #1496