Skip to content

EV-6493: Update Prometheus metrics docs for operator metrics#2629

Merged
ctauchen merged 2 commits intotigera:mainfrom
rene-dekker:EV-6493
Apr 9, 2026
Merged

EV-6493: Update Prometheus metrics docs for operator metrics#2629
ctauchen merged 2 commits intotigera:mainfrom
rene-dekker:EV-6493

Conversation

@rene-dekker
Copy link
Copy Markdown
Member

@rene-dekker rene-dekker commented Apr 8, 2026

Summary

  • Remove standalone license-agent page; merge license metrics content into operations/license-options
  • Add operator metrics tab to BYO Prometheus "scrape specific components" section
  • Rename tigera-prometheus-* PrometheusRule references to calico-prometheus-*
  • Update ServiceMonitor apiVersion from monitoring.coreos.com/v1alpha1 to monitoring.coreos.com/v1 across all doc versions

Related PRs

  • tigera/calico-private#11436 — Adds METRICS_ENABLED and METRICS_SCHEME env vars to the operator deployment

Test plan

  • Verify license-options page renders correctly with new metrics section
  • Verify byo-prometheus operator tab renders correctly
  • Verify no broken links from deleted license-agent page
  • Verify sidebar navigation works without license-agent entry

🤖 Generated with Claude Code

- 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>
@netlify
Copy link
Copy Markdown

netlify bot commented Apr 8, 2026

Deploy Preview for calico-docs-preview-next failed. Why did it fail? →

Name Link
🔨 Latest commit d9286c7
🔍 Latest deploy log https://app.netlify.com/projects/calico-docs-preview-next/deploys/69d6e93efaacc5000887c44f

@netlify
Copy link
Copy Markdown

netlify bot commented Apr 8, 2026

Deploy Preview succeeded!

Built without sensitive environment variables

Name Link
🔨 Latest commit d9286c7
🔍 Latest deploy log https://app.netlify.com/projects/tigera/deploys/69d6e93e8cd5840008d69fdb
😎 Deploy Preview https://deploy-preview-2629--tigera.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 97 (no change from production)
Accessibility: 98 (no change from production)
Best Practices: 83 (no change from production)
SEO: 100 (no change from production)
PWA: -
View the detailed breakdown and full score reports

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>
@ctauchen ctauchen marked this pull request as ready for review April 9, 2026 17:25
@ctauchen ctauchen requested a review from a team as a code owner April 9, 2026 17:25
Copilot AI review requested due to automatic review settings April 9, 2026 17:25
@ctauchen ctauchen merged commit ef5e950 into tigera:main Apr 9, 2026
9 of 13 checks passed
Copy link
Copy Markdown
Contributor

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 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 to calico-prometheus-* and updates ServiceMonitor apiVersion to monitoring.coreos.com/v1 across 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
Copy link

Copilot AI Apr 9, 2026

Choose a reason for hiding this comment

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

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.

Copilot uses AI. Check for mistakes.
Comment on lines +30 to +34
$[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
```
Copy link

Copilot AI Apr 9, 2026

Choose a reason for hiding this comment

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

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).

Copilot uses AI. Check for mistakes.

## Additional resources

- [LicenseKey resource](../../reference/resources/licensekey.mdx)
Copy link

Copilot AI Apr 9, 2026

Choose a reason for hiding this comment

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

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).

Suggested change
- [LicenseKey resource](../../reference/resources/licensekey.mdx)
- [LicenseKey resource](../reference/resources/licensekey.mdx)

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.

3 participants