-
Notifications
You must be signed in to change notification settings - Fork 7
Add explore-cardinality and reduce-metrics-cardinality path packages #484
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Eve832
wants to merge
1
commit into
main
Choose a base branch
from
eve/cardinality-paths
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| { | ||
| "id": "explore-cardinality-lj", | ||
| "title": "Explore your cardinality", | ||
| "blocks": [ | ||
| { | ||
| "type": "markdown", | ||
| "content": "Welcome to the Grafana Cloud learning path that shows you how to explore your own cardinality.\n\nBefore you can fix high cardinality, you need to see it. In this path, you'll use the Cost Management and Billing app to identify which metrics and labels contribute the most to your active series count, and to spot cardinality that's new or unused." | ||
| }, | ||
| { | ||
| "type": "markdown", | ||
| "content": "## Here's what to expect\n\nWhen you complete this path, you'll be able to:\n\n- Open the Cardinality tab in the Cost Management and Billing app\n- Identify which metrics and labels contribute the most to your active series count\n- Spot recently introduced and unused cardinality with the **New** and **Unused** badges" | ||
| }, | ||
| { | ||
| "type": "markdown", | ||
| "content": "## Before you begin\n\nBefore you explore your cardinality, ensure that you have:\n\n- A Grafana Cloud account. To create an account, refer to [Grafana Cloud](https://grafana.com/signup/cloud/connect-account). A stack that's already receiving metrics shows richer data in the interactive milestones.\n- The permissions granted by the **Billing and usage reader** role, including cardinality read access. Refer to [Manage access to the Cost Management and Billing app](https://grafana.com/docs/grafana-cloud/cost-management-and-billing/set-up/cost-management-billing-rbac/).\n- Basic familiarity with metrics concepts." | ||
| }, | ||
| { | ||
| "type": "markdown", | ||
| "content": "## Troubleshooting\n\nIf you get stuck, we've got your back! Where appropriate, troubleshooting information is just a click away." | ||
| }, | ||
| { | ||
| "type": "markdown", | ||
| "content": "## More to explore\n\nWe understand you might want to explore other capabilities not strictly on this path. We'll provide you opportunities where it makes sense." | ||
| } | ||
| ] | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| { | ||
| "id": "explore-cardinality-end-journey", | ||
| "title": "Destination reached!", | ||
| "blocks": [ | ||
| { | ||
| "type": "markdown", | ||
| "content": "You've completed the explore your cardinality learning path." | ||
| }, | ||
| { | ||
| "type": "markdown", | ||
| "content": "In this path, you:\n\n- Opened the Cardinality tab in the Cost Management and Billing app\n- Identified which metrics produce the most active series and which labels have the most unique values\n- Checked for **New** and **Unused** badges to spot recently introduced cardinality and cost with no value" | ||
| }, | ||
| { | ||
| "type": "markdown", | ||
| "content": "---\n\n### More to explore (optional)\n\nContinue with these related paths:\n\n- [Understand billing and usage in Grafana Cloud](https://grafana.com/docs/learning-paths/billing-usage/)\n- [Reduce your metrics cardinality](https://grafana.com/docs/learning-paths/reduce-metrics-cardinality/)\n- [Optimize metrics with Adaptive Metrics](https://grafana.com/docs/learning-paths/adaptive-metrics/)" | ||
| } | ||
| ] | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| { | ||
| "id": "explore-cardinality-end-journey", | ||
| "type": "guide", | ||
| "description": "Wrap up the explore your cardinality learning path with a recap of what you accomplished and related paths to explore.", | ||
| "category": "take-action", | ||
| "author": { | ||
| "name": "Eve832", | ||
| "team": "Grafana Documentation" | ||
| }, | ||
| "testEnvironment": { | ||
| "tier": "cloud" | ||
| }, | ||
| "depends": [ | ||
| "explore-cardinality-read-cardinality-tab" | ||
| ], | ||
| "recommends": [], | ||
| "suggests": [ | ||
| "billing-usage-lj" | ||
| ], | ||
| "provides": [] | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| menuTitle: Destination reached! | ||
| weight: 200 | ||
| step: 3 | ||
| layout: single-journey | ||
| cta: | ||
| type: conclusion | ||
| keywords: | ||
| - cardinality | ||
| - path-completion | ||
| side_journeys: | ||
| title: More to explore (optional) | ||
| heading: 'Continue with these related paths:' | ||
| items: | ||
| - title: Understand billing and usage in Grafana Cloud | ||
| link: /docs/learning-paths/billing-usage/ | ||
| - title: Reduce your metrics cardinality | ||
| link: /docs/learning-paths/reduce-metrics-cardinality/ | ||
| - title: Optimize metrics with Adaptive Metrics | ||
| link: /docs/learning-paths/adaptive-metrics/ | ||
| description: Wrap up the explore your cardinality learning path: Review what you found and find resources to keep optimizing. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| { | ||
| "id": "explore-cardinality-lj", | ||
| "type": "path", | ||
| "description": "A learning path that teaches you how to read the Cardinality tab in the Cost Management and Billing app to find the metrics and labels that drive your active series count.", | ||
| "category": "take-action", | ||
| "author": { | ||
| "name": "Eve832", | ||
| "team": "Grafana Documentation" | ||
| }, | ||
| "startingLocation": "/a/grafana-cmab-app", | ||
| "targeting": { | ||
| "match": { | ||
| "and": [ | ||
| { | ||
| "urlPrefixIn": [ | ||
| "/a/grafana-cmab-app", | ||
| "/a/grafana-cmab-app/usage" | ||
| ] | ||
| }, | ||
| { | ||
| "targetPlatform": "cloud" | ||
| } | ||
| ] | ||
| } | ||
| }, | ||
| "testEnvironment": { | ||
| "tier": "cloud" | ||
| }, | ||
| "milestones": [ | ||
| "explore-cardinality-read-cardinality-tab", | ||
| "explore-cardinality-end-journey" | ||
| ], | ||
| "depends": [], | ||
| "recommends": [], | ||
| "suggests": [ | ||
| "billing-usage-lj", | ||
| "reduce-metrics-cardinality-lj" | ||
| ], | ||
| "provides": [] | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| { | ||
| "id": "explore-cardinality-read-cardinality-tab", | ||
| "title": "Read the Cardinality tab", | ||
| "blocks": [ | ||
| { | ||
| "type": "markdown", | ||
| "content": "The Cardinality tab in the Cost Management and Billing app shows up to 30 days of historical cardinality for your stack, highlights metrics that are new or unused, and links to remediation actions. In this milestone, you'll open the tab and learn to read its tables." | ||
| }, | ||
| { | ||
| "type": "markdown", | ||
| "content": "Access to the Cardinality tab requires the `grafana-cmab-app.cardinality:read` permission. Refer to [Manage access to the Cost Management and Billing app](https://grafana.com/docs/grafana-cloud/cost-management-and-billing/set-up/cost-management-billing-rbac/). If your stack is new or isn't receiving metrics yet, the tables will be empty or sparse." | ||
| }, | ||
| { | ||
| "type": "markdown", | ||
| "content": "In this section, you'll open the Cardinality tab and identify your highest-cardinality metrics and labels." | ||
| }, | ||
| { | ||
| "type": "section", | ||
| "id": "read-cardinality-tab", | ||
| "title": "Read the Cardinality tab", | ||
| "autoCollapse": false, | ||
| "blocks": [ | ||
| { | ||
| "type": "interactive", | ||
| "action": "navigate", | ||
| "reftarget": "/a/grafana-cmab-app/usage", | ||
| "content": "Open the **Usage** tab of the Cost Management and Billing app.", | ||
| "verify": "on-page:/a/grafana-cmab-app/usage" | ||
| }, | ||
| { | ||
| "type": "interactive", | ||
| "action": "highlight", | ||
| "reftarget": "button[data-testid='data-testid Tab Cardinality']", | ||
| "content": "Select the **Cardinality** tab.", | ||
| "requirements": [ | ||
| "exists-reftarget", | ||
| "on-page:/a/grafana-cmab-app/usage" | ||
| ] | ||
| }, | ||
| { | ||
| "type": "interactive", | ||
| "action": "noop", | ||
| "content": "Review the summary stats at the top: **Unique metrics**, **Total active series**, **Unique labels**, and **Total label value pairs**. **Total active series** is the number your metrics bill is based on." | ||
| }, | ||
| { | ||
| "type": "interactive", | ||
| "action": "noop", | ||
| "content": "Scroll to the **Highest cardinality metrics** table. The **Series** column shows how many active series each metric produces, and **% Total** shows its share of your stack's series count. Start your investigations here: these metrics contribute the most to cost." | ||
| }, | ||
| { | ||
| "type": "interactive", | ||
| "action": "noop", | ||
| "content": "Review the **Highest cardinality labels** table. Labels with many distinct values, such as IDs or addresses, are the multiplication factors that inflate your series count." | ||
| }, | ||
| { | ||
| "type": "interactive", | ||
| "action": "noop", | ||
| "content": "Check the **Status** column for **New** and **Unused** badges. A **New** badge marks a metric or label first ingested in the last 30 days, which helps you spot recently introduced cardinality. An **Unused** badge marks a metric that isn't used in queries, dashboards, recording rules, or alerting rules, so it may be costing you without providing value.", | ||
| "skippable": true | ||
| }, | ||
| { | ||
| "type": "interactive", | ||
| "action": "noop", | ||
| "content": "Click a metric row to open the details drawer. It shows the metric's cardinality history, a label breakdown, its query count, and the dashboards and rules that reference it. The **Actions** menu links to deeper analysis and remediation, including Adaptive Metrics.", | ||
| "skippable": true | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "type": "markdown", | ||
| "content": "Now that you've used the Cardinality tab to identify which metrics and labels are contributing to your active series count, ask three questions:\n\n- **Which metrics produce the most series?** They're your biggest cost levers.\n- **Which labels have the most unique values?** They're the multiplication factors to challenge.\n- **Is anything both high-cardinality and unused?** That's cost with no value, and the easiest win." | ||
| }, | ||
| { | ||
| "type": "markdown", | ||
| "content": "For a complete tour of the Cost Management and Billing app, including usage breakdowns and billing alerts, take the [Understand billing and usage path](https://grafana.com/docs/learning-paths/billing-usage/)." | ||
| }, | ||
| { | ||
| "type": "markdown", | ||
| "content": "---\n\n### More to explore (optional)\n\nAt this point, you can explore the following topics:\n\n- [Analyze historical metrics cardinality](https://grafana.com/docs/grafana-cloud/cost-management-and-billing/analyze-costs/metrics-costs/prometheus-metrics-costs/historical-cardinality/)\n- [Live cardinality management dashboards](https://grafana.com/docs/grafana-cloud/cost-management-and-billing/analyze-costs/metrics-costs/prometheus-metrics-costs/cardinality-management/)" | ||
| } | ||
| ] | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| { | ||
| "id": "explore-cardinality-read-cardinality-tab", | ||
| "type": "guide", | ||
| "description": "Learn how to read the Cardinality tab in the Cost Management and Billing app to find the metrics and labels that drive your active series count.", | ||
| "category": "take-action", | ||
| "author": { | ||
| "name": "Eve832", | ||
| "team": "Grafana Documentation" | ||
| }, | ||
| "testEnvironment": { | ||
| "tier": "cloud" | ||
| }, | ||
| "depends": [], | ||
| "recommends": [ | ||
| "explore-cardinality-end-journey" | ||
| ], | ||
| "suggests": [], | ||
| "provides": [] | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| menuTitle: Read the Cardinality tab | ||
| weight: 100 | ||
| step: 2 | ||
| layout: single-journey | ||
| cta: | ||
| type: continue | ||
| keywords: | ||
| - cardinality | ||
| - cost-management | ||
| - metrics | ||
| - active series | ||
| side_journeys: | ||
| title: More to explore (optional) | ||
| heading: 'At this point, you can explore the following paths:' | ||
| items: | ||
| - title: Analyze historical metrics cardinality | ||
| link: /docs/grafana-cloud/cost-management-and-billing/analyze-costs/metrics-costs/prometheus-metrics-costs/historical-cardinality/ | ||
| - title: Live cardinality management dashboards | ||
| link: /docs/grafana-cloud/cost-management-and-billing/analyze-costs/metrics-costs/prometheus-metrics-costs/cardinality-management/ | ||
| description: Learn how to read the Cardinality tab in the Cost Management and Billing app to find the metrics and labels that drive your active series count. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| menuTitle: Explore your cardinality | ||
| weight: 1250 | ||
| journey: | ||
| group: take-action | ||
| skill: Beginner | ||
| source: Docs & blog posts | ||
| logo: | ||
| src: /static/img/menu/grafana2.svg | ||
| background: '#FFFFFF' | ||
| width: 46 | ||
| height: 55 | ||
| step: 1 | ||
| layout: single-journey | ||
| cascade: | ||
| layout: single-journey | ||
| cta: | ||
| type: start | ||
| title: Are you ready? | ||
| cta_text: Let's go! | ||
| keywords: | ||
| - cardinality | ||
| - active series | ||
| - cost-management | ||
| - metrics | ||
| description: Learn how to read the Cardinality tab in the Cost Management and Billing app to find the metrics and labels that drive your active series count. | ||
| related_journeys: | ||
| title: Related paths | ||
| heading: 'Consider taking the following paths after you complete this path.' | ||
| items: | ||
| - title: Reduce your metrics cardinality | ||
| link: /docs/learning-paths/reduce-metrics-cardinality/ | ||
| - title: Understand billing and usage in Grafana Cloud | ||
| link: /docs/learning-paths/billing-usage/ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| { | ||
| "id": "reduce-metrics-cardinality-lj", | ||
| "title": "Reduce your metrics cardinality", | ||
| "blocks": [ | ||
| { | ||
| "type": "markdown", | ||
| "content": "Welcome to the Grafana Cloud learning path that shows you how to reduce metrics cardinality you already have.\n\nHigh cardinality doesn't have to mean reinstrumenting your services. In this path, you'll review the aggregation recommendations Adaptive Metrics has prepared for your stack and learn which ones to act on first." | ||
| }, | ||
| { | ||
| "type": "markdown", | ||
| "content": "## Here's what to expect\n\nWhen you complete this path, you'll be able to:\n\n- Review Adaptive Metrics aggregation recommendations for your stack\n- Explain what applying a recommendation does, and how to reverse it\n- Prioritize remediation: unused metrics first, then high-cardinality labels, then exemptions" | ||
| }, | ||
| { | ||
| "type": "markdown", | ||
| "content": "## Before you begin\n\nBefore you reduce your metrics cardinality, ensure that you have:\n\n- A Grafana Cloud account. To create an account, refer to [Grafana Cloud](https://grafana.com/signup/cloud/connect-account). A stack that's already receiving metrics shows richer data in the interactive milestones.\n- The permissions granted by the **Rules Reader** role in Adaptive Metrics, including read access to recommendations and rules. Refer to [Manage access to Grafana Adaptive Metrics](https://grafana.com/docs/grafana-cloud/adaptive-telemetry/adaptive-metrics/additional-configuration/adaptive-metrics-rbac/).\n- Basic familiarity with metrics concepts." | ||
| }, | ||
| { | ||
| "type": "markdown", | ||
| "content": "## Troubleshooting\n\nIf you get stuck, we've got your back! Where appropriate, troubleshooting information is just a click away." | ||
| }, | ||
| { | ||
| "type": "markdown", | ||
| "content": "## More to explore\n\nWe understand you might want to explore other capabilities not strictly on this path. We'll provide you opportunities where it makes sense." | ||
| } | ||
| ] | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| { | ||
| "id": "reduce-metrics-cardinality-end-journey", | ||
| "title": "Destination reached!", | ||
| "blocks": [ | ||
| { | ||
| "type": "markdown", | ||
| "content": "You've completed the reduce your metrics cardinality learning path." | ||
| }, | ||
| { | ||
| "type": "markdown", | ||
| "content": "In this path, you:\n\n- Reviewed Adaptive Metrics recommendations and what each proposes to aggregate away\n- Learned that applying a recommendation keeps the metric and your dashboards working, and can be reversed if usage changes\n- Learned the remediation order: unused metrics first, then high-cardinality labels on used metrics, then exemptions for metrics that must never be aggregated" | ||
| }, | ||
| { | ||
| "type": "markdown", | ||
| "content": "---\n\n### More to explore (optional)\n\nContinue with these related paths:\n\n- [Optimize metrics with Adaptive Metrics](https://grafana.com/docs/learning-paths/adaptive-metrics/)\n- [Optimize logs with Adaptive Logs](https://grafana.com/docs/learning-paths/adaptive-logs/)\n- [Understand billing and usage in Grafana Cloud](https://grafana.com/docs/learning-paths/billing-usage/)" | ||
| } | ||
| ] | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| { | ||
| "id": "reduce-metrics-cardinality-end-journey", | ||
| "type": "guide", | ||
| "description": "Wrap up the reduce your metrics cardinality learning path with a recap of what you accomplished and related paths to explore.", | ||
| "category": "take-action", | ||
| "author": { | ||
| "name": "Eve832", | ||
| "team": "Grafana Documentation" | ||
| }, | ||
| "testEnvironment": { | ||
| "tier": "cloud" | ||
| }, | ||
| "depends": [ | ||
| "reduce-metrics-cardinality-review-recommendations" | ||
| ], | ||
| "recommends": [], | ||
| "suggests": [ | ||
| "adaptive-metrics-lj", | ||
| "adaptive-logs-lj" | ||
| ], | ||
| "provides": [] | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| menuTitle: Destination reached! | ||
| weight: 200 | ||
| step: 3 | ||
| layout: single-journey | ||
| cta: | ||
| type: conclusion | ||
| keywords: | ||
| - adaptive metrics | ||
| - cardinality | ||
| - path-completion | ||
| side_journeys: | ||
| title: More to explore (optional) | ||
| heading: 'Continue with these related paths:' | ||
| items: | ||
| - title: Optimize metrics with Adaptive Metrics | ||
| link: /docs/learning-paths/adaptive-metrics/ | ||
| - title: Optimize logs with Adaptive Logs | ||
| link: /docs/learning-paths/adaptive-logs/ | ||
| - title: Understand billing and usage in Grafana Cloud | ||
| link: /docs/learning-paths/billing-usage/ | ||
| description: Wrap up the reduce your metrics cardinality learning path: Review what you learned and find resources to keep optimizing. |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I smoke-tested this milestone on learn.grafana.net and the flow worked, but a couple of steps tell the learner to scroll to the Highest cardinality metrics table and click a metric row while using
noopwith no selector. Pathfinder still numbers those as interactive steps even though Show me / Do it cannot help. Prefer markdown for those (or a real highlight if you have a stable row selector).