Add declarative configuration docs for Spring Boot starter#9448
Open
zeitlinger wants to merge 7 commits intoopen-telemetry:mainfrom
Open
Add declarative configuration docs for Spring Boot starter#9448zeitlinger wants to merge 7 commits intoopen-telemetry:mainfrom
zeitlinger wants to merge 7 commits intoopen-telemetry:mainfrom
Conversation
- 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>
otelbot-docs
bot
added
the
missing:docs-approval
otelbot-docs
bot
added
the
missing:sig-approval
…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>
7 tasks
zeitlinger
commented
Mar 19, 2026
| | System property | Type | Default | Description | | ||
| | --------------------------------------------- | ------- | ------- | ----------------------------------------------------------------------------------------------- | | ||
| | `otel.instrumentation.log4j-appender.enabled` | Boolean | true | Enables the configuration of the Log4j OpenTelemetry appender with an `OpenTelemetry` instance. | | ||
| {{< tabpane text=true >}} {{% tab "not Declarative Configuration" %}} |
Member
Author
There was a problem hiding this comment.
I'm looking for a good name here.
For agent, we use "Properties" - but with spring, you can also use properties with declarative config - so I fear that this would be confusing.
- Fix broken anchor link to #configure-the-exporter-programmatically (section moved from sdk-configuration to programmatic-configuration) - Rename mapping table headers from "Properties" to "System property / env var" for clarity - Fix pre-existing prettier issue in programmatic-configuration.md Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
zeitlinger
force-pushed
the
fix/java-agent-declarative-config-updates
branch
from
2434a18 to
9a90c12
Compare
Add stub heading in the zh agent DC page so that cross-links from the zh spring-boot-starter pages resolve correctly. Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
This reverts commit 3af123c. Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
Member
Author
|
@jaydeluca please have a look |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
declarative-configuration.mdpage for the Spring Boot starter covering getting started, mapping rules, differences from agent DC, env var overrides, and duration formatprogrammatic-configuration.mdpage (extracted fromsdk-configuration.md) with a warning thatAutoConfigurationCustomizerProviderdoesn't work with DCout-of-the-box-instrumentation,sdk-configuration,additional-instrumentations, andother-spring-autoconfigpagesannotationspage for enable/disable mapping_index.mdFollow-up
Automatic converter: #9456
Test plan
npm run serve)/docs/zero-code/java/spring-boot-starter/declarative-configuration/