docs: fix SPM jaeger_query metrics YAML#1075
docs: fix SPM jaeger_query metrics YAML#1075chinaran wants to merge 1 commit intojaegertracing:mainfrom
Conversation
Signed-off-by: 王然 <ranwang@alauda.io>
There was a problem hiding this comment.
Pull request overview
Updates the SPM documentation configuration snippets to use the correct jaeger_query metrics field name, aligning the examples with Jaeger’s query extension configuration.
Changes:
- Replaced
metrics_storage:withmetrics:in the SPMjaeger_queryYAML snippets. - Applied the fix consistently across
_devand multiple versioned docs pages (v2.1–v2.16).
Reviewed changes
Copilot reviewed 17 out of 17 changed files in this pull request and generated 17 comments.
Show a summary per file
| File | Description |
|---|---|
| content/docs/v2/_dev/architecture/spm.md | Fixes SPM jaeger_query metrics field name in the example YAML. |
| content/docs/v2/2.1/architecture/spm.md | Same docs fix for v2.1 SPM example YAML. |
| content/docs/v2/2.2/architecture/spm.md | Same docs fix for v2.2 SPM example YAML. |
| content/docs/v2/2.3/architecture/spm.md | Same docs fix for v2.3 SPM example YAML. |
| content/docs/v2/2.4/architecture/spm.md | Same docs fix for v2.4 SPM example YAML. |
| content/docs/v2/2.5/architecture/spm.md | Same docs fix for v2.5 SPM example YAML. |
| content/docs/v2/2.6/architecture/spm.md | Same docs fix for v2.6 SPM example YAML. |
| content/docs/v2/2.7/architecture/spm.md | Same docs fix for v2.7 SPM example YAML. |
| content/docs/v2/2.8/architecture/spm.md | Same docs fix for v2.8 SPM example YAML. |
| content/docs/v2/2.9/architecture/spm.md | Same docs fix for v2.9 SPM example YAML. |
| content/docs/v2/2.10/architecture/spm.md | Same docs fix for v2.10 SPM example YAML. |
| content/docs/v2/2.11/architecture/spm.md | Same docs fix for v2.11 SPM example YAML. |
| content/docs/v2/2.12/architecture/spm.md | Same docs fix for v2.12 SPM example YAML. |
| content/docs/v2/2.13/architecture/spm.md | Same docs fix for v2.13 SPM example YAML. |
| content/docs/v2/2.14/architecture/spm.md | Same docs fix for v2.14 SPM example YAML. |
| content/docs/v2/2.15/architecture/spm.md | Same docs fix for v2.15 SPM example YAML. |
| content/docs/v2/2.16/architecture/spm.md | Same docs fix for v2.16 SPM example YAML. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| jaeger_query: | ||
| traces: some_trace_storage | ||
| metrics_storage: some_metrics_storage | ||
| metrics: some_metrics_storage |
There was a problem hiding this comment.
This jaeger_query snippet configures traces/metrics directly under jaeger_query, but the Configuration docs for this version use jaeger_query.storage for these fields. Consider adding the missing storage: level and indenting traces/metrics under it to keep the snippet consistent with the documented schema.
| jaeger_query: | ||
| traces: some_trace_storage | ||
| metrics_storage: some_metrics_storage | ||
| metrics: some_metrics_storage |
There was a problem hiding this comment.
This jaeger_query snippet configures traces/metrics directly under jaeger_query, but elsewhere in the docs (e.g., the versioned Configuration page and the later Elasticsearch/OpenSearch example in this same doc) these live under jaeger_query.storage. As written, users may copy/paste a config that doesn’t match the documented schema. Consider adding the missing storage: level and indenting traces/metrics under it.
| jaeger_query: | ||
| traces: some_trace_storage | ||
| metrics_storage: some_metrics_storage | ||
| metrics: some_metrics_storage |
There was a problem hiding this comment.
This jaeger_query snippet configures traces/metrics directly under jaeger_query, but elsewhere in the docs (including the versioned Configuration page and the later Elasticsearch/OpenSearch example in this same doc) these are under jaeger_query.storage. Consider adding the missing storage: level and indenting traces/metrics under it to avoid an invalid copy/paste configuration.
| jaeger_query: | ||
| traces: some_trace_storage | ||
| metrics_storage: some_metrics_storage | ||
| metrics: some_metrics_storage |
There was a problem hiding this comment.
This jaeger_query snippet configures traces/metrics directly under jaeger_query, but the Configuration docs for this version (and the later Elasticsearch/OpenSearch example below) place these under jaeger_query.storage. Consider adding the missing storage: mapping and indenting traces/metrics beneath it to avoid a misleading config example.
| jaeger_query: | ||
| traces: some_trace_storage | ||
| metrics_storage: some_metrics_storage | ||
| metrics: some_metrics_storage |
There was a problem hiding this comment.
This jaeger_query snippet configures traces/metrics directly under jaeger_query, but the Configuration docs for this version use jaeger_query.storage.traces / jaeger_query.storage.metrics. Consider adding the missing storage: level so the example matches the documented configuration structure.
| jaeger_query: | ||
| traces: some_trace_storage | ||
| metrics_storage: some_metrics_storage | ||
| metrics: some_metrics_storage |
There was a problem hiding this comment.
This jaeger_query snippet configures traces/metrics directly under jaeger_query, but the Configuration docs for this version use jaeger_query.storage for these fields. Consider adding the missing storage: level here to keep the example accurate for copy/paste.
| jaeger_query: | ||
| traces: some_trace_storage | ||
| metrics_storage: some_metrics_storage | ||
| metrics: some_metrics_storage |
There was a problem hiding this comment.
This jaeger_query snippet puts traces/metrics directly under jaeger_query, but the Configuration docs for this version show them under jaeger_query.storage. Consider adding storage: and indenting the keys beneath it so the snippet matches the documented config structure.
| jaeger_query: | ||
| traces: some_trace_storage | ||
| metrics_storage: some_metrics_storage | ||
| metrics: some_metrics_storage |
There was a problem hiding this comment.
This jaeger_query snippet configures traces/metrics directly under jaeger_query, but the Configuration docs for this version show these under jaeger_query.storage. Consider adding the storage: level here (and indenting traces/metrics) so readers can copy/paste a working config.
| extensions: | ||
| jaeger_query: | ||
| traces: some_trace_storage | ||
| metrics_storage: some_metrics_storage | ||
| metrics: some_metrics_storage | ||
| ``` |
There was a problem hiding this comment.
This jaeger_query snippet configures traces/metrics directly under jaeger_query, but the Configuration docs for this version show these fields under jaeger_query.storage. Consider adding the missing storage: level here (and indenting traces/metrics under it) so the snippet matches the documented schema.
| jaeger_query: | ||
| traces: some_trace_storage | ||
| metrics_storage: some_metrics_storage | ||
| metrics: some_metrics_storage |
There was a problem hiding this comment.
This jaeger_query snippet configures traces/metrics directly under jaeger_query, but the Configuration docs for this version place these under jaeger_query.storage. Consider adding storage: and indenting traces/metrics below it so this snippet matches the documented schema.
Which problem is this PR solving?
The SPM jaeger_query metrics YAML is incorrect.
Reference: https://github.com/jaegertracing/jaeger/blob/main/cmd/jaeger/internal/extension/jaegerquery/config.go#L28
Checklist
make lint testAI Usage in this PR (choose one)
See AI Usage Policy.