Skip to content

docs: traces of an experiment run live in your own tracing backend - #220

Open
achoimet wants to merge 2 commits into
mainfrom
docs/opentelemetry-own-backend
Open

achoimet wants to merge 2 commits into
mainfrom
docs/opentelemetry-own-backend

Conversation

@achoimet

Copy link
Copy Markdown
Member

Why

The platform no longer stores experiment spans or offers them as a zip download (steadybit/platform#2057), and the agent no longer uploads them (steadybit/agent#593). The OpenTelemetry Integration page still led with "Download through the Experiment Run View" and its 28-day retention, and presented export as experimental. The run page's Tracing tab links to this page.

BusinessMap: https://steadybitgmbh.kanbanize.com/ctrl_board/2/cards/14146

What (use-steadybit/experiments/opentelemetry-integration/README.md)

  • Intro: traces go only to the backend you configure; Steadybit doesn't store them.
  • Find a Run's Traces (replaces the download section): the experiment.execution.id attribute, and the Tempo / Jaeger / Datadog queries the Tracing tab offers, plus a note that the search window has to cover the run.
  • Export OpenTelemetry Data (no longer "experimental"):
    • Agent: OTEL_JAVA_GLOBAL_AUTOCONFIGURE_ENABLED=true is the on/off switch, with a Helm agent.env example and OTEL_SDK_DISABLED to turn it off.
    • Extensions (extension-kit ≥ 1.12.1 extotel): OTEL_EXPORTER_OTLP_ENDPOINT, and OTEL_EXPORTER_OTLP_PROTOCOL=grpc for port 4317, because they default to HTTP. Includes an extraEnv example.
    • On-prem platform: the same switch as the agent.
  • Local Jaeger/Zipkin/collector sample unchanged.
  • Removed the now-unreferenced traces-download.png (page folder and .gitbook/assets).

python3 .github/scripts/docs_lint.py --base origin/main: 0 errors, 0 warnings.

Merge together with, or after, the agent release containing steadybit/agent#593. Before that release, the agent still uploads spans, although the platform no longer keeps them.

The platform no longer stores spans or offers them as a zip download.
Describe the Tracing tab's experiment.execution.id queries and how to
switch on export for the agent, the extensions and an on-prem platform.

(ticket 14146)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant