opentelemetry-rust
opentelemetry-rust copied to clipboard
open-telemetry
Some questions about trace/sampler/jaeger_remote
- Could you please add a README?
- Show sample usage
- Explain configuration options
- List env variables supported
- Which endpoint the SDK is expected to query for sampling strategy?
- Which servers was the SDK tested against? For comparison, Go SDK uses deprecated format not supported by OTel Collector: https://github.com/open-telemetry/opentelemetry-go-contrib/issues/3184
cc @TommyCpp
Sorry spent this weekend to chase some memory issue but I will try to write some more doc tomorrow.
Which endpoint the SDK is expected to query for sampling strategy?
The default endpoint is /sampling
Which servers was the SDK tested against? For comparison, Go SDK uses deprecated format not supported by OTel Collector
IIRC I was using jaeger all in one docker image as the backend. We have unit test to make sure we can deserialize the response from jaeger and an example for jaeger remote sampler. But need to add an integration test.
Please find the example in https://github.com/open-telemetry/opentelemetry-rust/tree/main/examples/jaeger-remote-sampler.
It contains a docker-compose file where we point the rust remote sampler to the jaeger container which loaded the strategies files in the example.
We don't support env vars in jaeger remote sampler yet.
As for the configuration we currently use a builder pattern where the user provides the required parameters to start the builder and can provide optional parameters using functions. We provide documents including the default value for all builder methods.
Typically, we do not include READMEs for features that are part of the SDK. However, I can include a configuration list in the example's README if it would be helpful.
Typically, we do not include READMEs for features that are part of the SDK.
why not? I think a readme is the actual module is a lot more discoverable than a readme tucked away in examples/. Unless you have some other form of documentation (which I would still keep close to the module code).