Skip to content

Add interactive config-to-DC converter#9456

Draft
zeitlinger wants to merge 6 commits intoopen-telemetry:mainfrom
zeitlinger:fix/dc-converter
Draft

Add interactive config-to-DC converter#9456
zeitlinger wants to merge 6 commits intoopen-telemetry:mainfrom
zeitlinger:fix/dc-converter

Conversation

@zeitlinger
Copy link
Copy Markdown
Member

Summary

  • Adds an interactive converter shortcode that translates existing configuration (system properties, env vars, application.yaml) into declarative configuration YAML
  • Supports both Java agent and Spring Boot starter modes
  • Handles special mappings, /development suffix for experimental features, enable/disable lists, and SDK properties
  • Shows recommended base DC skeleton on page load, with converted config appearing as you type

Depends on #9448.

Test plan

  • Verify converter renders on both DC pages (agent + Spring Boot starter)
  • Test system properties input (with and without -D prefix)
  • Test environment variable input (with special mapping lookup)
  • Test application.yaml input (Spring only)
  • Test combined inputs across all three boxes
  • Verify copy button works
  • Verify unknown properties appear as comments with warnings

- New declarative-configuration.md page with getting started, mapping rules,
  differences from agent DC, env var overrides, and duration format
- New programmatic-configuration.md page (extracted from sdk-configuration.md)
  with warning that AutoConfigurationCustomizerProvider doesn't work with DC
- DC flavor tabs on out-of-the-box-instrumentation, sdk-configuration,
  additional-instrumentations, and other-spring-autoconfig pages
- DC note on annotations page for enable/disable mapping
- Update agent DC page: remove stale Spring Boot limitation, add cross-link
- Mention DC as a configuration option in _index.md
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
…ty paths

- Convert non-DC tab property tables to application.yaml style
- Fix DC property paths: add /development suffix, correct db-statement-sanitizer mapping
- Add step 4 to default algorithm about /development suffix
- Move db-statement-sanitizer to special mappings table
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
- Run prettier on changed files
- Add Dotel to cSpell ignore list
- Run fix:dict for page-local word lists
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
Adds a shortcode with inline JS that converts existing configuration
(system properties, env vars, application.yaml) to declarative
configuration YAML for both the Java agent and Spring Boot starter.
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
@otelbot-docs otelbot-docs bot requested review from a team March 19, 2026 10:58
@otelbot-docs otelbot-docs bot added missing:docs-approval Co-owning SIG has provided approval, PR needs approval from docs maintainer missing:sig-approval Co-owning SIG didn't provide an approval labels Mar 19, 2026
@github-actions github-actions bot added sig:java and removed missing:sig-approval Co-owning SIG didn't provide an approval labels Mar 19, 2026
… repo

Add opentelemetry-configuration as a submodule and use the canonical
otel-getting-started.yaml in both the DC getting started docs and
the interactive converter (via Hugo readFile injection).

Also fix CI by adding js-yaml to the reduced-dependencies allowlist.
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
@otelbot-docs otelbot-docs bot requested a review from a team March 20, 2026 07:37
@otelbot-docs otelbot-docs bot added the missing:sig-approval Co-owning SIG didn't provide an approval label Mar 20, 2026
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

missing:docs-approval Co-owning SIG has provided approval, PR needs approval from docs maintainer missing:sig-approval Co-owning SIG didn't provide an approval sig:java

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

1 participant