Skip to content

feat(docs): Add Daytona Sandbox Monitoring doc - #4123

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

feat(docs): Add Daytona Sandbox Monitoring doc#4123
crazyuploader wants to merge 3 commits into
mainfrom
feat/add-daytona-monitoring-docs

Conversation

@crazyuploader

Copy link
Copy Markdown
Contributor

Pull Request


📄 Summary

This PR adds Daytona Sandbox 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 https://github.com/SigNoz/growth-pod/issues/1284


✅ 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 Sep 5, 2026
@crazyuploader crazyuploader added the documentation Improvements or additions to documentation label Sep 5, 2026
@vercel

vercel Bot commented Sep 5, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated
signoz-web Ready Ready Preview Sep 7, 2026 9:10am UTC

Request Review

@github-actions

github-actions Bot commented Sep 5, 2026

Copy link
Copy Markdown
Contributor

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


Docs PR Review — Daytona Sandbox Monitoring

Reviewed with the signoz-docs-pr-review skill against contributing/docs-review.md and contributing/docs-authoring.md. This is a strong, well-structured doc. Verified: frontmatter, JTBD flow, code-fence collapse flags, OTLP protocol/endpoint conventions, <region> token usage, internal links + anchors, discovery/sidebar wiring.

Findings by severity

P1 / P2: None.

P3

  • data/docs/daytona-monitoring.mdx:3title carries a brand suffix (& SigNoz), against the "no brand suffix" convention and diverging from sibling monitoring docs. Low impact because meta_title overrides the search title, but title still renders as the page H1. Left an inline suggestion.

Intended personas & fit

Platform/AI engineers running agent code in Daytona sandboxes who need traces/logs/metrics + SDK and quota visibility in SigNoz. Fit is strong: the doc leads with the highest-value path (telemetry from inside the sandbox), collapses the secondary paths (SDK tracing, built-in/quota telemetry, reference, troubleshooting, limitations), and closes with concrete next steps.

JTBD coverage

  • Happy path clear and end-to-end (allow firewall → instrument → upload/run → validate). ✅
  • Recommended default (OTLP/HTTP on :443, <region> token) is the default; advanced/secondary paths correctly collapsed. ✅
  • ## Validate shows exactly where each signal appears in SigNoz. ✅
  • Troubleshooting is symptom → cause → fix → verify. ✅
  • Code fences: collapse flags correct — Step 2 (54 lines) has minimap defaultCollapsed, Step 1 (21) and Step 3 (30) have defaultCollapsed, short fences unflagged. ✅
  • No em dashes / AI-writing tells detected. ✅

Checklist coverage (docs-authoring.md)

  • Frontmatter: published_date, title, description, doc_type present; published_date is the current-convention date field (date-only guideline is legacy). ✅
  • Title length 53 chars / description 154 chars — in range. ✅
  • <region> token used consistently in every endpoint; no hardcoded region. ✅
  • Placeholders use <...> form and are documented under Verify these values. ✅
  • Internal links use absolute https://signoz.io/...; external links use the MDX <a … rel="noopener noreferrer nofollow"> form. Verified targets + anchors resolve (#cloud-to-self-hosted, #endpoint). ✅
  • Discovery wiring complete: sidebar (main.json), LLM-monitoring + dashboard-templates listicles, dashboard uses DashboardActions (V2 only, V1 correctly omitted). ✅

Open questions / assumptions

  • Daytona-specific API claims (domain_allow_list, otelEndpointOverride no-op, 18 gauges, per-sandbox service.name) are outside OTel source verification and are trusted as author-verified.
  • The dashboard copy/download depends on daytona/daytona-dashboard.json being merged to SigNoz/dashboards@main; otherwise the raw URL 404s. Please confirm it's merged.
  • Image widths (≥1200px) couldn't be verified in this environment — please confirm the 5 WebP screenshots meet the minimum width.
  • Recommend running yarn check:docs-metadata, yarn test:docs-metadata, yarn check:doc-redirects, and node --test tests/component-items-sync.test.js locally, since the listicle JSONs changed (couldn't run them here).

Onboarding label: applied

Matched new added file data/docs/daytona-monitoring.mdx — primary job is getting traces/logs/metrics into SigNoz with concrete ingestion setup (endpoint, signoz-ingestion-key, OTLP env vars). Applied add-to-onboarding.

Comment thread data/docs/daytona-monitoring.mdx Outdated
@github-actions

github-actions Bot commented Sep 5, 2026

Copy link
Copy Markdown
Contributor

📚 Onboarding issue created… see #4125

@github-actions

github-actions Bot commented Sep 5, 2026

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 0
🗑️ Deleted 0
⏭️ Skipped 0

🔗 Relations

The following relations were automatically resolved:

  • authors
  • tags
  • keywords

📄 Processed Documents

View 2 document(s)
Operation Route
Created /dashboards/dashboard-templates/daytona-dashboard
Created /daytona-monitoring

📋 Listicle Sync

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

@github-actions

github-actions Bot commented Sep 7, 2026

Copy link
Copy Markdown
Contributor

CMS Sync Successful

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

📊 Summary

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

🔗 Relations

The following relations were automatically resolved:

  • authors
  • tags
  • keywords

📄 Processed Documents

View 2 document(s)
Operation Route
Updated /dashboards/dashboard-templates/daytona-dashboard
Updated /daytona-monitoring

📋 Listicle Sync

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

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.

1 participant