Skip to content

feat(docs): Add Karpenter Monitoring docs - #4080

Open
crazyuploader wants to merge 3 commits into
mainfrom
feat/add-karpenter-monitoring-docs
Open

feat(docs): Add Karpenter Monitoring docs#4080
crazyuploader wants to merge 3 commits into
mainfrom
feat/add-karpenter-monitoring-docs

Conversation

@crazyuploader

Copy link
Copy Markdown
Contributor

Pull Request


📄 Summary

This PR adds doc for Karpenter Monitoring doc and Dashboard Template page

Doc Links:

Screenshots / Screen Recordings (if applicable)

Include screenshots or screen recordings that clearly show the behavior before the change and the result after the change. This helps reviewers quickly understand the impact and verify the update.

Issues closed by this PR

Closes #2094


✅ Change Type

Select all that apply

  • ✨ Feature
  • 🐛 Bug fix
  • ♻️ Refactor
  • 🛠️ Infra / Tooling
  • 🧪 Test-only

🐛 Bug Context

Required if this PR fixes a bug

Root Cause

What caused the issue?
Regression, faulty assumption, edge case, refactor, etc.

Fix Strategy

How does this PR address the root cause?


🧪 Testing Strategy

How was this change validated?

  • Tests added/updated:
  • Manual verification:
  • Edge cases covered:

⚠️ Risk & Impact Assessment

What could break? How do we recover?

  • Blast radius:
  • Potential regressions:
  • Rollback plan:

📝 Changelog

Fill only if this affects users, APIs, UI, or documented behavior
Use N/A for internal or non-user-facing changes

Field Value
Deployment Type Cloud / OSS / Enterprise
Change Type Feature / Bug Fix / Maintenance
Description User-facing summary

📋 Checklist

  • Tests added or explicitly not required
  • Manually tested
  • Breaking changes documented
  • Backward compatibility considered

👀 Notes for Reviewers


@crazyuploader crazyuploader self-assigned this Aug 31, 2026
@crazyuploader crazyuploader added the documentation Improvements or additions to documentation label Aug 31, 2026
@vercel

vercel Bot commented Aug 31, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
signoz-web Ready Ready Preview Aug 31, 2026 12:59pm

Request Review

@github-actions

github-actions Bot commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

Claude finished @crazyuploader's task in 3m 26s —— View job


Docs review: Karpenter monitoring

Reviewed with the signoz-docs-pr-review skill against contributing/docs-review.md + docs-authoring.md. Two docs, plus sidebar/listicle/icon discovery updates. Overall this is careful, well-scoped work: happy path is clean, technical claims check out against the Karpenter metrics reference, endpoints use the <region> token, images are high-res WebP via Figure, no em dashes, code-fence collapse flags are correct.

Findings

P1

  • Dashboard JSON URL 404skarpenter-dashboard.mdx:23. dashboardJsonV2Url targets SigNoz/dashboards/.../karpenter/karpenter-dashboard.json, but that folder does not exist in the SigNoz/dashboards repo (gh api repos/SigNoz/dashboards/contents/karpenter → 404). Copy/Download will fail until the dashboard JSON is merged there. Publish the JSON first, then confirm the raw URL resolves.

P3

  • Description over lengthkarpenter-dashboard.mdx:4. ~164 chars vs. the 120–160 guideline; trim one clause.
  • Vague cross-linkkarpenter-dashboard.mdx:108. "cardinality guidance in the setup guide" links to the setup page root; an anchor to the relevant section would land readers on the exact content.

Technical accuracy (verified)

  • Default metrics port 8080 at /metrics, METRICS_PORT override, http-metrics container port name, and the listed karpenter_* metrics all match the Karpenter metrics reference. ✅
  • The otlphttpotlp_http deprecation note is correct — otlphttp is now a deprecated alias in recent Collector releases. ✅
  • Prometheus role: pod + keep on http-metrics port name is valid SD behavior; leader-election caveat is accurate. ✅

Personas & fit

Platform/SRE engineers running Karpenter on Kubernetes who want autoscaling telemetry in SigNoz. The setup doc (howto) serves the "get metrics flowing" job well; the dashboard doc (explanation) serves "interpret the fleet" well. Fit is strong; the two docs cross-link cleanly.

JTBD coverage

Title/description lengths in range (dashboard description slightly long, P3). Single clear default path, minimal mandatory steps, concrete ## Validate with exact SigNoz UI steps and a success signal, symptom-first ## Troubleshooting, useful ## Next Steps. Cardinality/advanced material correctly pushed into collapsed sections. No mandatory-path bloat.

Checklist coverage

Frontmatter complete (date, title, description, doc_type); tags omitted correctly (applies to Cloud + Self-Host). Sidebar, both listicles, and the new brand icon are all added and alphabetized. No URL changes → no redirects needed. Images are WebP and well above 1200px.

Open questions / assumptions

  • Blocking item is external to this repo: the dashboard JSON must land in SigNoz/dashboards. Assuming that's in flight — flagging so it isn't missed.

Onboarding label

Onboarding label: applied — matched data/docs/metrics-management/opentelemetry-karpenter-metrics.mdx (new added file whose primary job is sending metrics to SigNoz, with endpoint + signoz-ingestion-key + OTLP exporter setup). The dashboard-template page on its own does not qualify.


  • Read review playbooks
  • Read changed docs & discovery files
  • JTBD-first review pass
  • Verify OpenTelemetry technical accuracy
  • Post inline findings
  • Post summary + onboarding-label decision
    · branch feat/add-karpenter-monitoring-docs

Comment thread data/docs/dashboards/dashboard-templates/karpenter-dashboard.mdx
Comment thread data/docs/dashboards/dashboard-templates/karpenter-dashboard.mdx Outdated
@github-actions

Copy link
Copy Markdown
Contributor

📚 Onboarding issue created… see #4082

@github-actions

Copy link
Copy Markdown
Contributor

CMS Sync Successful

Content has been synced to Strapi CMS with deployment status: staging

📊 Summary

Operation Count
✅ Created 2
🔄 Updated 3
🗑️ Deleted 0
⏭️ Skipped 0

🔗 Relations

The following relations were automatically resolved:

  • authors
  • tags
  • keywords

📄 Processed Documents

View 5 document(s)
Operation Route
Created /dashboards/dashboard-templates/karpenter-dashboard
Created /metrics-management/opentelemetry-karpenter-metrics
Updated /aws-monitoring/eks/eks-ec2-nodes
Updated /infrastructure-monitoring/kubernetes/nodes
Updated /metrics-management/keda-metrics

📋 Listicle Sync

Operation Count
✅ Created 0
🔄 Updated 2
🗑️ Deleted 0
View 2 listicle(s)
Operation Listicle
Updated dashboard-templates
Updated metrics-quick-start

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

add-to-onboarding documentation Improvements or additions to documentation staging

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Karpenter monitoring docs

1 participant