[operator/java] Add instrumentation doc for java #2253
Conversation
|
/cc @jack-berg |
TylerHelmuth
force-pushed
the
java-operator-instrumentation
branch
from
fb8af85
to
915515f
Compare
Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
Co-authored-by: Phillip Carter <pcarter@fastmail.com>
| - baggage | ||
| sampler: | ||
| type: parentbased_traceidratio | ||
| argument: "1" |
There was a problem hiding this comment.
Can you link to the documentation for these configuration options? I'm not familiar with where this is defined or how it translates to the environment variable based config scheme the otel java agent used.
There was a problem hiding this comment.
For propagators the valid values are tracecontext;baggage;b3;b3multi;jaeger;xray;ottrace;none (https://github.com/open-telemetry/opentelemetry-operator/blob/1a12ac7bb23f78a39a1b6a7f216faa034342b2f7/apis/v1alpha1/propagators.go#L19). The operator will add them to the OTEL_PROPAGATORS environment variable.
For sampler the valid values are always_on, always_off, traceidratio, parentbased_always_on, parentbased_always_off, parentbased_traceidratio, jaeger_remote, xray (https://github.com/open-telemetry/opentelemetry-operator/blob/main/docs/api.md#instrumentationspecsampler). The operator will add the sampler and its args to OTEL_TRACES_SAMPLER and OTEL_TRACES_SAMPLER_ARG.
I agree that this page doesn't discuss those aspects clearly, and neither does the Operator docs. I will get an operator docs PR created to address this so that I have something to link to from this doc.
There was a problem hiding this comment.
Is this blob required, or is this sorta a best practice?
There was a problem hiding this comment.
Are you asking if a propagator and sampler are required or only a best practice? They are best practices.
There was a problem hiding this comment.
@jack-berg since @TylerHelmuth is adding this content upstream, are you satisfied with the changes for now? We can file a tracking issue to link to the config options (or pull them in here) separately.
|
Since the remaining question was about additional configuration options, which are in-progress here, I'll merge this in for now and file a tracking issue to link to them once they are merged in the upstream operator repository. Alternatively, that information can also be brought into docs here, but I think the sequencing is still likely to involve getting open-telemetry/opentelemetry-operator#1442 merged first. Either way, let's not hold up the party here. |
|
Filed #2341 |
|
@cartermp - this broke the build since the PR was submitted before the CI formatting checks were in place Can someone submit a followup PR? If not, let me know and I'll do it. |
|
Actually, here's a fix: |
|
Fixed! |
|
Followup issue (FYI): |
Adds a section in the k8s operator instrumentation docs for Java.
Preview: https://deploy-preview-2253--opentelemetry.netlify.app/docs/k8s-operator/automatic/#java