docs: Validate the prometheus.* component topics - part 01 - #7107
clayton-cornell wants to merge 10 commits into
Conversation
|
💻 Deploy preview available (Validate the prometheus.* component topics - part 01): |
|
💻 Deploy preview available (docs: Validate the prometheus.* component topics - part 01): |
There was a problem hiding this comment.
🔵 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.enrichhealth 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
intervalcan equaltimespan:Config.Validaterejects only whentimespan < intervaland reports thattimespanmust be greater than or equal tointerval. This description therefore excludes a valid configuration; document the constraint asintervalbeing no greater thantimespan.
| `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.
There was a problem hiding this comment.
🟢 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
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.azuretheazure_cloud_environmentalso accepts an "Azure Secret Cloud" value (azurepsecretcloud) in the underlying cloudconfig library, which isn't documented on this page. Both it and the already-documentedazurepprivatecloudvalue require extra configuration viaAZURE_CLOUD_CONFIG/AZURE_CLOUD_CONFIG_FILEenv vars to actually work. Left undocumented intentionally for this PR. This needs confirmation/validation before it is added to the docs.