docs: Document OpenTelemetry tracing backend and deprecate OpenTracing#2082
docs: Document OpenTelemetry tracing backend and deprecate OpenTracing#2082promptless[bot] wants to merge 2 commits intoprodfrom
Conversation
![promptless[bot]](https://avatars.githubusercontent.com/in/979718?s=60&v=4){kind=small}
| Vitess allows you to generate trace events from major server components: `vtgate`, `vttablet`, and `vtctld`. Starting with v24, [OpenTelemetry](https://opentelemetry.io/) is the recommended tracing backend, exporting traces via OTLP/gRPC to any compatible backend. The legacy OpenTracing-based backends (`opentracing-jaeger` and `opentracing-datadog`) are deprecated and will be removed in v25. | ||
|
|
||
| ## Configuring tracing | ||
| ## OpenTelemetry (Recommended) |
There was a problem hiding this comment.
Citation: New OpenTelemetry backend implementation in go/trace/otel.go and go/trace/plugin_otel.go. Registers the "opentelemetry" factory with an OTLP/gRPC exporter.
View source
|
|
||
| The available OpenTelemetry flags are: | ||
|
|
||
| * `--otel-endpoint`: OpenTelemetry collector endpoint (host:port for gRPC). Defaults to `localhost:4317`. |
There was a problem hiding this comment.
Citation: Flag definitions from go/trace/plugin_otel.go: --otel-endpoint (default localhost:4317) and --otel-insecure (default true). The --tracing-sampling-rate flag moved from plugin_jaeger.go to trace.go so all backends can use it.
View source
| ## OpenTracing (Deprecated) | ||
|
|
||
| Now that you have the Jaeger server running, you can add the necessary startup options to `vtgate`, `vttablet` and `vtctld`. This will enable you to send trace spans to the server. The command line options for doing this are the same across `vtgate`, `vttablet` and `vtctld`. Add the following options for a tracing agent running on the `localhost`: | ||
| The following OpenTracing-based tracing backends are deprecated as of v24 and will be removed in v25: |
There was a problem hiding this comment.
Citation: Deprecation warnings added to go/trace/plugin_jaeger.go and go/trace/plugin_datadog.go. Both backends now log: tracer "opentracing-jaeger" is deprecated; migrate to "opentelemetry" (OTLP) at startup.
View source
| * The tracing sample rate (`--tracing-sampling-rate`) is expressed as a fraction from 0.0 (no sampling) to 1.0 (100% of all events are sent to the server). In the example, this option is set to zero, because we will be passing custom span contexts to the queries we want to trace. In this way, we only instrument the queries we want. This is recommended for large installations because it is typically very hard to organize and consume the volume of tracing events generated by even a small fraction of events from a non-trivial production Vitess system. However, if you just want events to flow automatically without you having to instrument queries, you can set this to a value other than `0.0` and skip the following section on instrumenting queries. | ||
| * The tracing sample rate (`--tracing-sampling-rate`) is expressed as a fraction from 0.0 (no sampling) to 1.0 (100% of all events are sent to the server). If set to zero, you can pass custom span contexts to trace only specific queries. This is recommended for large installations because it is typically very hard to organize and consume the volume of tracing events generated by even a small fraction of events from a non-trivial production Vitess system. | ||
|
|
||
| ### Migrating from OpenTracing to OpenTelemetry |
There was a problem hiding this comment.
Citation: Migration guidance from the PR's changelog entry in changelog/24.0/24.0.0/summary.md: replace --tracer opentracing-jaeger with --tracer opentelemetry and --jaeger-agent-host host:port with --otel-endpoint host:4317.
View source
✅ Deploy Preview for vitess ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
The PR states the flag defaults to false, not true.
Open this suggestion in Promptless to view citations and reasoning process
Updates the tracing guide to document the new
--tracer opentelemetrybackend introduced in v24, which exports traces via OTLP/gRPC. Marks the legacyopentracing-jaegerandopentracing-datadogbackends as deprecated (removal in v25), and provides a migration guide with flag mappings for users transitioning to OpenTelemetry.Trigger Events
vitessio/vitess PR #19619: trace: add OpenTelemetry backend, deprecate OpenTracing
Promptless Research (4 files, 1 GitHub PR)
.long_term_context/product_knowledge/product_overview.md.long_term_context/doc_workflow/client_instructions.md.long_term_context/style/client_style_guide.mdcontent/en/docs/24.0/user-guides/configuration-advanced/tracing.mdAgent Response
Tip: Tell your friends working on non-commercial open-source projects to apply for free Promptless access at promptless.ai/oss ❤️