docs(mesh): add MeshOpenTelemetryBackend doc#5310
Merged
Merged
Conversation
✅ Deploy Preview for kongdeveloper ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Migrated from kumahq/kuma-website. Splits the page into Overview, Examples, Configuration reference, and Troubleshooting tabs. Signed-off-by: Bart Smykla <bartek@smykla.com>
bartsmykla
force-pushed
the
docs/mesh-meshopentelemetrybackend
branch
from
af3fad5 to
cf82298
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new Mesh reference page documenting the MeshOpenTelemetryBackend resource and wires it into Mesh navigation and cross-links so users can discover it from related observability policies.
Changes:
- Introduces
app/mesh/meshopentelemetrybackend.mdwith overview, examples, schema, and troubleshooting content. - Adds related-resource backlinks to the MeshMetric/MeshTrace/MeshAccessLog policy pages and the general observability page.
- Registers the new page in the Mesh docs index under Resource References.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| app/mesh/observability.md | Adds a related-resource link to the new MeshOpenTelemetryBackend page. |
| app/mesh/meshopentelemetrybackend.md | New reference page for MeshOpenTelemetryBackend (overview/examples/schema/troubleshooting). |
| app/_mesh_policies/meshtrace/index.md | Adds related-resource link to MeshOpenTelemetryBackend. |
| app/_mesh_policies/meshmetric/index.md | Adds related-resource link to MeshOpenTelemetryBackend. |
| app/_mesh_policies/meshaccesslog/index.md | Adds related-resource link to MeshOpenTelemetryBackend. |
| app/_indices/mesh.yaml | Adds the new page to the Mesh index under Resource References. |
Comments suppressed due to low confidence (1)
app/mesh/meshopentelemetrybackend.md:442
- Same placeholder issue here: use an ALL_CAPS placeholder instead of
<name>(for example,DATAPLANE_NAME) so the command is more consistent and copy/paste friendly.
```sh
kumactl inspect dataplane <name>
</details>
- Add tech_preview: true to mark the 2.14 preview - Use ALL_CAPS placeholders (BACKEND_NAME, DATAPLANE_NAME) - Fix "fail loud" → "fail loudly" - Correct DataplaneInsight field path: spec.openTelemetry → status.openTelemetry Signed-off-by: Bart Smykla <bartek@smykla.com>
Contributor
|
@bartsmykla I reviewed this and made some changes, can you take a look and let me know what you think? The main structural change I made was removing the top-level navtabs. These reproduced a layout that is generated automatically for policies, but in other references we want to avoid using nested navtabs. We should think about having a similar layout for resources, but for now I changed the structure to match other references. |
Contributor
Author
|
@lmilan lgtm, we can merge it |
lmilan
approved these changes
May 21, 2026
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.
Motivation
MeshOpenTelemetryBackend lets MeshMetric, MeshTrace, and MeshAccessLog share one OTel collector endpoint via
backendRefinstead of duplicating it on each policy. Ships in 2.14 as preview and needs its own reference page.Implementation information
meshopentelemetrybackend.mdfrom kumahq/kuma-website toapp/mesh/{% navtabs %}block with Overview, Examples, Configuration reference, and Troubleshooting tabs. Setno_wrap: trueto skip section wrapping (the wrapper chokes when everyh2lives inside a navtab)environmentgroup so picking once syncs every example on the pagerelated_resourcesback-links frommeshmetric,meshtrace,meshaccesslog, andobservabilityso readers can find the backend from the policies that consume itapp/_indices/mesh.yamlhttps://deploy-preview-5310--kongdeveloper.netlify.app/mesh/meshopentelemetrybackend/dev/