Skip to content

feat(docs): Add Modal Monitoring doc - #4127

Open
crazyuploader wants to merge 1 commit into
mainfrom
feat/add-modal-monitoring-doc
Open

feat(docs): Add Modal Monitoring doc#4127
crazyuploader wants to merge 1 commit into
mainfrom
feat/add-modal-monitoring-doc

Conversation

@crazyuploader

Copy link
Copy Markdown
Contributor

Pull Request


📄 Summary

This PR adds Modal monitoring 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/1285


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

vercel Bot commented Sep 6, 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 6, 2026 10:00am UTC

Request Review

@github-actions

github-actions Bot commented Sep 6, 2026

Copy link
Copy Markdown
Contributor

Claude finished @crazyuploader's task in 4m 15s —— View job


Docs PR Review — Modal Monitoring

Reviewed with the signoz-docs-pr-review skill against contributing/docs-review.md and docs-authoring.md. This is a strong, well-structured pair of docs. One blocking issue found (broken dashboard download), plus a couple of things to confirm.

Findings by severity

P1

  • Dashboard download/copy URL 404sdata/docs/dashboards/dashboard-templates/modal-dashboard.mdx:23. dashboardJsonV2Url.../SigNoz/dashboards/refs/heads/main/modal/modal-dashboard.json returns 404 (verified; the file isn't in the SigNoz/dashboards repo). The Copy/Download buttons will fail for every reader. Merge the dashboard JSON to the dashboards repo at the matching path (compare the working baseten/baseten-dashboard.json) before this ships, or fix the path. Inline comment posted.

P2

  • None.

P3

  • Dashboard doc title Modal Dashboard for Function and Sandbox Metrics (48 chars) is just under the 50–60 target, but this matches the existing dashboard-template convention (e.g. Baseten Dashboard), so it's acceptable.

Personas & fit

  • Integration doc (howto): agent/platform engineers running Modal Functions & Sandboxes who need logs, metrics, and traces in SigNoz. Fit is strong — happy path ("No Code (Recommended)" tab, 3 steps) is clean, and advanced/edge material (SDK, in-sandbox tracing, flush semantics, attribute reference, troubleshooting) is correctly moved into tabs/collapsibles.
  • Dashboard doc (explanation): same personas importing the prebuilt view. Clear coverage and metric mapping.

JTBD coverage

  • Title/description length, keyword-first, action word: ✅
  • Single clear primary job + clean happy path + short time-to-first-success: ✅
  • Concrete steps, recommended defaults in main path, advanced moved out: ✅
  • ## Validate shows exact success signals in SigNoz (Logs/Metrics/Traces filters): ✅
  • Troubleshooting is symptom → cause → fix → verify: ✅
  • Links resolve to canonical absolute prod paths (verified internal targets + #cloud-to-self-hosted anchor): ✅
  • External links use the required target="_blank" rel="noopener noreferrer nofollow" anchor form: ✅
  • Region-aware endpoints use the literal <region> token everywhere; no hardcoded region: ✅
  • OTLP path prefers HTTP (opentelemetry-exporter-otlp-proto-http, :443, base-URL push); no gRPC/4317 default: ✅
  • Code-fence collapse flags: the 44-line agent.py fence carries minimap defaultCollapsed; all other fences ≤20 lines: ✅
  • No em dashes; prose reads clean: ✅
  • Sidebar + listicles (integrations + dashboard-templates) + new si-modal.svg icon all updated: ✅

Technical accuracy (verified against Modal docs)

  • Sandbox.create returning before container start, and readiness probes (modal.Probe.with_tcp, wait_until_ready): confirmed correct.
  • The authorization-header rationale (Modal Secret key names disallow hyphens) is internally consistent and well documented.

Open questions / residual risk

  • Image widths not verified (identify/scripting was blocked in this environment). Please confirm all six new .webp files are ≥1200 px wide per docs-authoring.md.
  • The P1 dashboard JSON is a cross-repo dependency — this doc should not merge ahead of the SigNoz/dashboards JSON, or the download breaks on publish.

Onboarding label

Onboarding label: applieddata/docs/integrations/modal.mdx is a newly added send-data guide with concrete ingestion setup (SigNoz endpoint, ingestion key, OTLP exporter env vars). Label added to this PR.


  • Read review playbooks
  • Read changed docs & discoverability files
  • JTBD-first pass
  • Technical accuracy verification (OTel/Modal claims)
  • Post inline findings
  • Post summary + onboarding-label decision
    · branch feat/add-modal-monitoring-doc

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

github-actions Bot commented Sep 6, 2026

Copy link
Copy Markdown
Contributor

📚 Onboarding issue created… see #4129

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant