klag / rules
Cursor rule88 starsChanged 47 days agoApache-2.0View on GitHub
Public API — names and tags are stable contracts. Member labels (memberhost, consumerid, clientid) on per-partition consumer metrics when CONSUMERMEMBERLABELSENABLED=true (default). Update all of: Never ship a new metric without a dashboard panel.
We split this metrics.mdc into the rules it gives an agent
1 rule. About 0 are common, 1 is distinctive, and 0 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈1
Distinctive · estimate
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 37
Never ship a new metric without a dashboard panel.
≈ “Common” is an estimate: at least 1 in 5 of the 6,350 Cursor rule files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
---
globs:
- "src/**/metrics/**"
- "dashboard/**"
- "charts/klag/**"
alwaysApply: false
---
# Metrics
Public API — names and tags are stable contracts.
## Core metrics
- `klag.consumer.lag[.sum/.max/.min]` — per partition; aggregates per `consumer_group`+`topic`
- `klag.consumer.lag.velocity` — msg/sec × 100
- `klag.consumer.lag.ms` — time lag; per-partition + topic rollup (`{partition=""}` / `{partition!=""}`)
- `klag.consumer.lag.time_to_close_seconds` — `consumer_group`+`topic` only
- `klag.consumer.lag.retention_percent` — DLP; same partition rollup pattern as `lag.ms`
- `klag.consumer.commit.staleness_seconds` — inferred commit freshness; only while lag > 0
- `klag.consumer.group.state` — state as tag; two-phase stale-gauge cleanup on transitions
- `klag.partition.under_replicated`, `klag.hot_partition[.lag]` — partition-level; conditional emission
- `klag.topic.size_skew` — topic-level max/mean retained-size ratio × 100; opt-in via `DATA_SKEW_ENABLED` (default false)
Member labels (`member_host`, `consumer_id`, `client_id`) on per-partition consumer metrics when `CONSUMER_MEMBER_LABELS_ENABLED=true` (default).
## When adding or changing a metric
Update **all** of:
- Collector/reporter code + tests
- `CLAUDE.md` and `README.md` metric sections
- `dashboard/demo-dashboard.json` (and Grafana.com export if applicable)
- Helm chart/README if scrape or ServiceMonitor behavior changes
- Website docs under `website/src/content/docs/metrics/` when user-facing
Never ship a new metric without a dashboard panel.
Where files are headingNew Cursor rule files have more rules about planning and tracking tasks, and fewer about code style.
Of the Cursor rule files we read, the 3,978 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository5 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- .cursor/rules/config-and-mcp.mdcCursor rule
- .cursor/rules/java.mdcCursor rule
- .cursor/rules/project.mdcCursor rule
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.