Skip to content

feat(docs): Add Deno instrumentation doc#2598

Open
crazyuploader wants to merge 7 commits intomainfrom
chore/add-deno-instrumentation-doc
Open

feat(docs): Add Deno instrumentation doc#2598
crazyuploader wants to merge 7 commits intomainfrom
chore/add-deno-instrumentation-doc

Conversation

@crazyuploader
Copy link
Contributor

@crazyuploader crazyuploader commented Jan 28, 2026

Closes: #1283

Doc: Link

@crazyuploader crazyuploader self-assigned this Jan 28, 2026
@crazyuploader crazyuploader added the documentation Improvements or additions to documentation label Jan 28, 2026
@vercel
Copy link

vercel bot commented Jan 28, 2026

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

Project Deployment Actions Updated (UTC)
signoz-web Ready Ready Preview, Comment Feb 8, 2026 9:41am

Request Review

@crazyuploader
Copy link
Contributor Author

@claude /review

@claude
Copy link
Contributor

claude bot commented Jan 28, 2026

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


Review Summary

This PR adds comprehensive Deno instrumentation documentation. The structure follows the Send Data docs template well, covering multiple deployment types (VM, Kubernetes, Docker, Windows) and both auto-instrumentation and code-level instrumentation approaches.

Issues Found

I've provided inline comments for the following issues that need to be addressed:

  1. Technical accuracy issue (line 321-322): The default value for OTEL_DENO_CONSOLE is incorrectly documented as replace when it should be capture according to official Deno documentation

  2. Missing required sections per CONTRIBUTING.md:

    • Validate section (should be added after line 280): Send Data docs require a section showing how to confirm the setup worked in the SigNoz UI
    • Next Steps section (should be added after line 329): Required to complete the end-to-end workflow with links to dashboards, alerts, or relevant user guides
  3. Incomplete Collector section (line 299): Missing required links to "Why use the OpenTelemetry Collector?" and "Collector configuration guide" per the template in CONTRIBUTING.md

What's Correct

  • ✅ Proper frontmatter with all required fields (date, id, title, description, doc_type)
  • ✅ Self-hosted callout included near the top
  • ✅ All four deployment types covered (VM, Kubernetes, Docker, Windows)
  • ✅ VM explanation callout properly included
  • ✅ Optional Collector setup section included in collapsible format
  • ✅ Troubleshooting section included with collapsible format
  • ✅ Commands properly explained with placeholder definitions
  • ✅ External links use proper format with target="_blank" and security attributes
  • ✅ Code examples are clear and well-structured
  • ✅ Added to sidebar navigation correctly
  • ✅ Component updates look good

Label Added

✅ Added add-to-onboarding label as this PR introduces a new documentation file for sending data to SigNoz Cloud.


@github-actions
Copy link
Contributor

📚 Onboarding issue created… see #2599

@crazyuploader crazyuploader marked this pull request as ready for review January 28, 2026 04:59
@claude
Copy link
Contributor

claude bot commented Jan 28, 2026

Claude finished @crazyuploader's task in 2m 11s —— View job


Review Complete

I've thoroughly reviewed this Deno instrumentation documentation PR against the CONTRIBUTING.md guidelines and verified technical accuracy against official Deno sources.

Summary

This PR adds comprehensive Deno instrumentation documentation following the Send Data docs template. The structure is solid, covering all deployment types and instrumentation approaches. However, there's one critical correction needed regarding a previous review comment, plus the documentation would benefit from the missing sections already identified.


Previous Review Comment Correction

The inline comment about OTEL_DENO_CONSOLE on line 330 is INCORRECT. The documentation currently states:

- `capture`: Logs are emitted to stdout/stderr AND exported (default).

This is technically accurate according to the official Deno documentation. The previous review incorrectly claimed the doc said replace was the default, but the doc correctly states capture is the default. This inline comment should be disregarded.


Issues Still Requiring Attention

The documentation is missing two required sections per CONTRIBUTING.md:

  1. Validate section (line 281): Currently present and looks good ✅

  2. Next Steps section (line 335): Currently present and looks good ✅

  3. Collector section links (line 307): The Collector section is missing the required links. Per CONTRIBUTING.md, it should include both:

    • Link to "Why use the OpenTelemetry Collector?"
    • Link to "Collector configuration guide"

    Currently only has the "Switch to Collector" link. This was already flagged in the previous review and still needs to be addressed.


What's Correct

Verified against CONTRIBUTING.md checklist:

  • Frontmatter: All required fields present (date, id, title, description, doc_type: howto)
  • SEO: "OpenTelemetry" and "Deno" in title, description, and URL
  • Self-hosted callout: Included at line 13-15
  • Deployment types: All four covered (VM, Kubernetes, Docker, Windows)
  • VM explanation callout: Properly included (line 38-45)
  • Commands explained: Clear explanations with placeholder definitions
  • Validate section: Present with clear UI navigation steps (line 281-288)
  • Troubleshooting: Included with collapsible format using <ToggleHeading> (line 312-333)
  • Next Steps: Present with relevant links to trace explorer, query builder, and alerts (line 335-339)
  • Optional Collector section: Included in collapsible format (line 290-310)
  • External links: Use proper format with target="_blank" and security attributes
  • Sidebar navigation: Added correctly in constants/docsSideNav.ts
  • Component integration: Deno entry added to APMInstrumentationListicle.tsx
  • Technical accuracy: Verified auto-instrumentation claims, environment variables, and console logging behavior against official Deno OpenTelemetry docs

Required Changes

1. Fix Collector section (line 307)

Add the missing required links as specified in CONTRIBUTING.md. Change:

See [Switch from direct export to Collector](https://signoz.io/docs/opentelemetry-collection-agents/opentelemetry-collector/switch-to-collector/) for step-by-step instructions.

To:

See [Switch from direct export to Collector](https://signoz.io/docs/opentelemetry-collection-agents/opentelemetry-collector/switch-to-collector/) for step-by-step instructions.

For more details, see [Why use the OpenTelemetry Collector?](https://signoz.io/docs/opentelemetry-collection-agents/opentelemetry-collector/why-to-use-collector/) and the [Collector configuration guide](https://signoz.io/docs/opentelemetry-collection-agents/opentelemetry-collector/configuration/).

Label Status

✅ Added add-to-onboarding label as this PR introduces a new instrumentation documentation file.


Sources

Technical accuracy verified against:

Copy link
Member

@makeavish makeavish left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deno supports logs, metrics, traces all with otel but I don't it being mentioned clearly

Copy link
Member

@makeavish makeavish left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

[DOCS] Instrument Deno Application

2 participants