Skip to content

docs: Validate the prometheus.* component topics - part 01 - #7107

Open
clayton-cornell wants to merge 10 commits into
mainfrom
docs/validate-prometheus-component-docs-part-01
Open

clayton-cornell wants to merge 10 commits into
mainfrom
docs/validate-prometheus-component-docs-part-01

Conversation

@clayton-cornell

@clayton-cornell clayton-cornell commented Sep 14, 2026

Copy link
Copy Markdown
Contributor

This PR is a general cleanup of the prometheus.* topics. It's split into multiple PRs to reduce the review load per PR.

This is preliminary work that needs to be done as part of an overall project to migrate Examples either to task topics or to scenarios. The foundation of the component doc needs to be in good shape before any other work is undertaken.

Validated against the component source code, looking at Blocks, Arguments, completeness, accuracy, etc. Most fixes are cosmetic (markdown formatting, removing extra spaces, aligning tables). Some fixes covered errors in the existing examples, errors in the debug section, and product name errors.

Added review_date metadata to all files that have been reviewed. This is something we should start using on all doc topics going forward once they are fully reviewed, and updated with subsequent reviews.

Note for reviewers

In prometheus.exporter.azure the azure_cloud_environment also accepts an "Azure Secret Cloud" value (azurepsecretcloud) in the underlying cloudconfig library, which isn't documented on this page. Both it and the already-documented azurepprivatecloud value require extra configuration via AZURE_CLOUD_CONFIG/AZURE_CLOUD_CONFIG_FILE env vars to actually work. Left undocumented intentionally for this PR. This needs confirmation/validation before it is added to the docs.

@clayton-cornell clayton-cornell added type/docs Docs Squad label across all Grafana Labs repos backport/v1.19 Backport to release/v1.19 labels Sep 14, 2026
Comment thread docs/sources/reference/components/prometheus/prometheus.echo.md Outdated
Comment thread docs/sources/reference/components/prometheus/prometheus.echo.md Outdated
Comment thread docs/sources/reference/components/prometheus/prometheus.echo.md Outdated
Comment thread docs/sources/reference/components/prometheus/prometheus.enrich.md
Comment thread docs/sources/reference/components/prometheus/prometheus.exporter.azure.md Outdated
Comment thread docs/sources/reference/components/prometheus/prometheus.exporter.azure.md Outdated
@github-actions

github-actions Bot commented Sep 14, 2026

Copy link
Copy Markdown
Contributor

💻 Deploy preview available (Validate the prometheus.* component topics - part 01):

@clayton-cornell clayton-cornell changed the title Validate the prometheus.* component topics - part 01 docs: Validate the prometheus.* component topics - part 01 Sep 15, 2026
@github-actions

github-actions Bot commented Sep 15, 2026

Copy link
Copy Markdown
Contributor

💻 Deploy preview available (docs: Validate the prometheus.* component topics - part 01):

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🔵 Needs a closer look

One or more issues must be addressed before approval.

Pull request overview

This PR validates and refreshes documentation for selected prometheus.* components, improving accuracy, formatting, and review metadata.

Changes:

  • Added review dates and updated Prometheus section overview metadata.
  • Corrected component descriptions, argument tables, examples, and links.
  • Documented prometheus.enrich health and debug metrics.
File summaries
File Description
docs/sources/reference/components/prometheus/prometheus.exporter.azure.md Updated as part of this pull request.
docs/sources/reference/components/prometheus/prometheus.exporter.apache.md Updated as part of this pull request.
docs/sources/reference/components/prometheus/prometheus.enrich.md Updated as part of this pull request.
docs/sources/reference/components/prometheus/prometheus.echo.md Updated as part of this pull request.
docs/sources/reference/components/prometheus/_index.md Updated as part of this pull request.
Review details

Suppressed comments (3)

docs/sources/reference/components/prometheus/prometheus.exporter.azure.md:43

  • The language name is the proper noun Go; please capitalize it here to avoid documenting the product as “go.”
The exporter uses the Azure SDK for go and supports [authentication][].

docs/sources/reference/components/prometheus/prometheus.exporter.azure.md:152

  • The example wraps the plural <SUBSCRIPTIONS> placeholder in one list element. If the replacement instruction is followed with multiple IDs, the result is one string (for example "id1, id2"), not multiple subscriptions; use a singular placeholder per element or show separate <SUB_ID_n> entries and align the replacement text.
    subscriptions    = ["<SUBSCRIPTIONS>"]

docs/sources/reference/components/prometheus/prometheus.exporter.azure.md:86

  • interval can equal timespan: Config.Validate rejects only when timespan < interval and reports that timespan must be greater than or equal to interval. This description therefore excludes a valid configuration; document the constraint as interval being no greater than timespan.
| `interval`                    | `string`       | [ISO8601 Duration][] used to generate individual data points in Azure Monitor. Must be smaller than `timespan`. | `"PT1M"`                                                                      | no       |
  • Files reviewed: 5/5 changed files
  • Comments generated: 0
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Approval recommended

Only a non-blocking documentation nit remains; no approval-blocking issues were identified.

Review details

Suppressed comments (1)

docs/sources/reference/components/prometheus/prometheus.exporter.azure.md:198

  • The rewrite drops the hyphen from the compound modifier remote_write-compatible, so this sentence now reads awkwardly. Please retain the hyphen after the code span.
- _`<PROMETHEUS_REMOTE_WRITE_URL>`_: The URL of the Prometheus `remote_write` compatible server to send metrics to.
  • Files reviewed: 5/5 changed files
  • Comments generated: 0 new
  • Review effort level: Lite

@clayton-cornell
clayton-cornell marked this pull request as ready for review September 15, 2026 20:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport/v1.19 Backport to release/v1.19 type/docs Docs Squad label across all Grafana Labs repos

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants