EV-6493: Update Prometheus metrics docs for operator metrics#2629
EV-6493: Update Prometheus metrics docs for operator metrics#2629ctauchen merged 2 commits intotigera:mainfrom
Conversation
- Remove standalone license-agent page; merge content into license-options - Add operator metrics tab to BYO Prometheus page - Rename tigera-prometheus-* PrometheusRule references to calico-prometheus-* - Update ServiceMonitor apiVersion from v1alpha1 to v1 across all versions Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
❌ Deploy Preview for calico-docs-preview-next failed. Why did it fail? →
|
✅ Deploy Preview succeeded!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
- Remove license-agent from releases.json (enterprise + cloud) - Update calico-cloud _license.mdx FAQ header and remove Prometheus link - Redirect old license-agent URL to license-options page Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Updates Calico Enterprise/Cloud Prometheus documentation to reflect operator-exposed metrics (including license metrics), modernize Prometheus Operator CRD apiVersions, and clean up legacy references to the standalone license-agent.
Changes:
- Removes the standalone Calico Enterprise license-agent metrics page and moves license metrics/alert guidance into
operations/license-options. - Adds an “operator” tab to BYO Prometheus component scraping instructions.
- Renames
tigera-prometheus-*PrometheusRule example names tocalico-prometheus-*and updates ServiceMonitorapiVersiontomonitoring.coreos.com/v1across multiple doc versions.
Reviewed changes
Copilot reviewed 17 out of 17 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| static/_redirects | Updates redirect target for the deprecated license-agent page. |
| sidebars-calico-enterprise.js | Removes license-agent doc entry from the Calico Enterprise sidebar. |
| calico-enterprise/releases.json | Removes license-agent image metadata from Enterprise release component list. |
| calico-enterprise/operations/monitor/prometheus/configure-prometheus.mdx | Renames PrometheusRule example/file references; updates ServiceMonitor apiVersion to v1. |
| calico-enterprise/operations/monitor/prometheus/byo-prometheus.mdx | Adds operator scraping instructions/tab. |
| calico-enterprise/operations/monitor/metrics/license-agent.mdx | Deletes the standalone license-agent metrics page. |
| calico-enterprise/operations/license-options.mdx | Adds operator-based license metrics + alerting guidance. |
| calico-enterprise/operations/index.mdx | Removes the operations landing-page card linking to the deleted license-agent doc. |
| calico-enterprise/_includes/content/_license.mdx | Updates FAQ question and link to the new license metrics location. |
| calico-enterprise_versioned_docs/version-3.23-1/operations/monitor/prometheus/configure-prometheus.mdx | Updates ServiceMonitor apiVersion to v1. |
| calico-enterprise_versioned_docs/version-3.22-2/operations/monitor/prometheus/configure-prometheus.mdx | Updates ServiceMonitor apiVersion to v1. |
| calico-enterprise_versioned_docs/version-3.21-2/operations/monitor/prometheus/configure-prometheus.mdx | Updates ServiceMonitor apiVersion to v1. |
| calico-enterprise_versioned_docs/version-3.20-2/operations/monitor/prometheus/configure-prometheus.mdx | Updates ServiceMonitor apiVersion to v1. |
| calico-cloud/releases.json | Removes license-agent image metadata from Cloud release component list. |
| calico-cloud/operations/monitor/prometheus/configure-prometheus.mdx | Updates ServiceMonitor apiVersion to v1. |
| calico-cloud/_includes/content/_license.mdx | Updates license monitoring FAQ wording (removes Prometheus reference). |
| calico-cloud_versioned_docs/version-22-2/operations/monitor/prometheus/configure-prometheus.mdx | Updates ServiceMonitor apiVersion to v1. |
| /maintenance/monitor/support https://docs.tigera.io/calico-enterprise/latest/monitor/prometheus/support 301 | ||
| /maintenance/monitor/elasticsearch-and-fluentd-metrics /calico-enterprise/latest/operations/monitor/metrics/elasticsearch-and-fluentd-metrics 301 | ||
| /maintenance/monitor/license-agent /calico-enterprise/latest/operations/monitor/metrics/license-agent 301 | ||
| /maintenance/monitor/license-agent /calico-enterprise/latest/operations/license-options 301 |
There was a problem hiding this comment.
The license-agent doc page was removed, but there’s no redirect here for the old in-site URL (/calico-enterprise/latest/operations/monitor/metrics/license-agent and/or the next equivalent). Without an explicit redirect, existing bookmarks and external links to that page will 404; consider adding redirects from the old doc route(s) to /calico-enterprise/latest/operations/license-options.
| $[prodname] installs PrometheusRule resources with alerting rules for license expiration. You can view them with: | ||
|
|
||
| ```bash | ||
| kubectl -n tigera-prometheus get prometheusrule calico-prometheus-dp-rate -o yaml | ||
| ``` |
There was a problem hiding this comment.
This command references calico-prometheus-dp-rate, which is the denied-packets PrometheusRule example used in the Prometheus configuration docs, not a license-expiration rule. It will mislead readers trying to inspect license alert rules; update the example to reference the actual license PrometheusRule name (or show how to discover it, e.g., by listing PrometheusRules and filtering for license-related ones).
|
|
||
| ## Additional resources | ||
|
|
||
| - [LicenseKey resource](../../reference/resources/licensekey.mdx) |
There was a problem hiding this comment.
The relative link to the LicenseKey resource looks incorrect for a doc located at calico-enterprise/operations/license-options.mdx. ../../reference/... would resolve outside the calico-enterprise/ docs tree; this should likely be ../reference/resources/licensekey.mdx (consistent with other top-level operations/*.mdx pages like operations/decommissioning-a-node.mdx).
| - [LicenseKey resource](../../reference/resources/licensekey.mdx) | |
| - [LicenseKey resource](../reference/resources/licensekey.mdx) |

Summary
operations/license-optionstigera-prometheus-*PrometheusRule references tocalico-prometheus-*monitoring.coreos.com/v1alpha1tomonitoring.coreos.com/v1across all doc versionsRelated PRs
METRICS_ENABLEDandMETRICS_SCHEMEenv vars to the operator deploymentTest plan
🤖 Generated with Claude Code