Skip to content

docs: fix SPM jaeger_query metrics YAML#1075

Open
chinaran wants to merge 1 commit intojaegertracing:mainfrom
chinaran:fix/jaeger-query-metrics
Open

docs: fix SPM jaeger_query metrics YAML#1075
chinaran wants to merge 1 commit intojaegertracing:mainfrom
chinaran:fix/jaeger-query-metrics

Conversation

@chinaran
Copy link
Copy Markdown

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

AI Usage in this PR (choose one)

See AI Usage Policy.

  • None: No AI tools were used in creating this PR
  • Light: AI provided minor assistance (formatting, simple suggestions)
  • Moderate: AI helped with code generation or debugging specific parts
  • Heavy: AI generated most or all of the code changes

Signed-off-by: 王然 <ranwang@alauda.io>
Copilot AI review requested due to automatic review settings March 27, 2026 09:00
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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: with metrics: in the SPM jaeger_query YAML snippets.
  • Applied the fix consistently across _dev and 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.

Comment on lines 105 to +107
jaeger_query:
traces: some_trace_storage
metrics_storage: some_metrics_storage
metrics: some_metrics_storage
Copy link

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
Comment on lines 107 to +109
jaeger_query:
traces: some_trace_storage
metrics_storage: some_metrics_storage
metrics: some_metrics_storage
Copy link

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
Comment on lines 105 to +107
jaeger_query:
traces: some_trace_storage
metrics_storage: some_metrics_storage
metrics: some_metrics_storage
Copy link

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
Comment on lines 107 to +109
jaeger_query:
traces: some_trace_storage
metrics_storage: some_metrics_storage
metrics: some_metrics_storage
Copy link

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
Comment on lines 105 to +107
jaeger_query:
traces: some_trace_storage
metrics_storage: some_metrics_storage
metrics: some_metrics_storage
Copy link

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
Comment on lines 107 to +109
jaeger_query:
traces: some_trace_storage
metrics_storage: some_metrics_storage
metrics: some_metrics_storage
Copy link

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
Comment on lines 107 to +109
jaeger_query:
traces: some_trace_storage
metrics_storage: some_metrics_storage
metrics: some_metrics_storage
Copy link

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
Comment on lines 107 to +109
jaeger_query:
traces: some_trace_storage
metrics_storage: some_metrics_storage
metrics: some_metrics_storage
Copy link

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
Comment on lines 104 to 108
extensions:
jaeger_query:
traces: some_trace_storage
metrics_storage: some_metrics_storage
metrics: some_metrics_storage
```
Copy link

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
Comment on lines 107 to +109
jaeger_query:
traces: some_trace_storage
metrics_storage: some_metrics_storage
metrics: some_metrics_storage
Copy link

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants