Document the OTel Collector details view in Fleet - #8127
Draft
vishaangelova wants to merge 1 commit into
Draft
Conversation
Contributor
Elastic Docs AI PR menuCheck the box to run an AI review for this pull request.
Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team. |
Contributor
🔍 Preview links for changed docs |
Contributor
Elastic Docs Style Checker (Vale)Summary: 1 warning found
|
| File | Line | Rule | Message |
|---|---|---|---|
| reference/fleet/view-otel-collectors.md | 212 | Elastic.Spelling | 'otlp' is a possible misspelling. |
The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale.
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
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
This PR documents the redesigned OTel Collector view in Fleet, which replaces the classic Agent details view for OpAMP-managed collectors in 9.5. The feature is gated behind the
enableOtelUIflag, which is absent in 9.4 and enabled by default in 9.5.0.Because 9.4 uses the classic Agent details view,
view-otel-collectors.mddocuments both, but is now organized by task, with row-levelapplies_tobadges in the metadata table andapplies-switchblocks for the two divergent navigation paths.Resolves #7412
Changes
reference/fleet/view-otel-collectors.md(rewrite): Restructured into task-oriented sections (also making this ahow-to). New coverage for the pipeline graph (selector, layout, connector edges, canvas controls), the component detail panel (Health, Metrics, Config tabs, including the internal-telemetry prerequisite for metrics), and the Error patterns table. Health states are now documented per version: named states with color indicators on 9.5, raw OTel status strings on 9.4, plus the 9.5 "Collector is not active" behavior. The metadata table merges both versions into one table with row-level badges.reference/fleet/add-otel-collector.md: Aligns the Start the collector tab labels with the UI and adds a 9.5-badged paragraph for the runtime selector that swaps the command. Adds a 9.5-badged note for the managed OTLP endpoint path, where the step asks for an mOTLP API key and the generated config exports throughotlp/managedinstead ofelasticsearch/otel. Corrects the confirmation step, which names View connected collectors.reference/fleet/monitor-otel-collectors.md: Adds a badged paragraph pointing at the new collector details view.Corrections to existing content
Fixes to existing content on the
view-otel-collectors.mdpage:elastic-otel-collectororotel-contribaccording to collector type. Fleet Server derives the tag from the collector'sservice.nameattribute (internal/pkg/api/handleOpAMP.go), which is the Service name from the Add collector flow.elastic-otel-collectoris just what Elastic Agent in OTel mode happens to report.Generative AI disclosure
Tool(s) and model(s) used: Cursor / Claude Opus 5