Skip to content

Conversation

@Essekar
Copy link

@Essekar Essekar commented Aug 28, 2025

Summary

Add observability rule to detect metric name changes that could break
production dashboards and alerts.

Rule Details

  • ID: observability.metrics.metric-name-change
  • Severity: WARNING
  • Languages: JavaScript, TypeScript, Python, Go
  • Purpose: Flags when developers change metric names, requiring
    dashboard/alert updates

Test Cases

  • 6 true positives (detects various metric patterns)
  • 9 true negatives (ignores non-metric code)

Use Case

Prevents production monitoring breakage when developers refactor metric
names without updating:

  • Grafana dashboards
  • Alert rules
  • SLA monitoring

Example Detection

// This would be flagged for review:
metrics.counter("user_login_count", 1);
prometheus.Counter({name: "http_requests_total", help: "..."});
statsd.increment("page_views", 1);

Impact

Helps teams catch observability breaking changes in CI before they reach
production, preventing monitoring blind spots.

@CLAassistant
Copy link

CLAassistant commented Aug 28, 2025

CLA assistant check
All committers have signed the CLA.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

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