Skip to content

docs(collection-agent): update vm otel-binary collection agent#2633

Open
Nageshbansal wants to merge 5 commits intomainfrom
docs/collection-agents
Open

docs(collection-agent): update vm otel-binary collection agent#2633
Nageshbansal wants to merge 5 commits intomainfrom
docs/collection-agents

Conversation

@Nageshbansal
Copy link
Member

Refactors:

  • Consolidate two otel binary installation docs into one.
  • Remove the usage of shared components
  • Adds Docs for otel binary with structure we follow for collection-agents

Related: https://github.com/SigNoz/platform-pod/issues/1387

@vercel
Copy link

vercel bot commented Feb 4, 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 5, 2026 0:38am

Request Review

@claude
Copy link
Contributor

claude bot commented Feb 4, 2026

Claude finished @Nageshbansal's task in 3m 27s —— View job


Documentation Review Complete

Reviewed the OpenTelemetry binary collection agent documentation refactor against CONTRIBUTING.md guidelines and official OpenTelemetry sources.

Summary

This PR successfully consolidates two separate otel-binary installation docs into one unified structure following the standard collection-agents documentation pattern. The refactor removes 15 shared component files and 2 tutorial files (1,671 deletions) while adding 3 well-structured docs (617 additions).

What's Good

Structure & Organization

  • ✅ Follows the standard three-doc pattern: overview → install → configure
  • ✅ Proper frontmatter with required fields (date, id, title, description)
  • ✅ Navigation properly updated in docsSideNav.ts
  • ✅ Redirects added for both old tutorial paths
  • ✅ Self-hosted callouts included appropriately

Technical Accuracy

Issues Found

Critical

  1. Broken internal link in configure.mdx:12 - missing opentelemetry- prefix in path

Minor
2. Version consideration in install.mdx:8 - Using v0.139.0 while v0.143.0/v0.144.0 are available (may be intentional)

CONTRIBUTING.md Compliance

The docs meet all checklist requirements:

  • ✅ Frontmatter complete with doc_type (explanation, howto)
  • ✅ SEO keywords in title, description, and first paragraph
  • ✅ Commands explained with context
  • ✅ Code blocks annotated with language/filename
  • ✅ Placeholders properly documented
  • ✅ Cross-linking to related docs
  • ✅ Next Steps sections included
  • ✅ Redirects added for moved/deleted files

Labeling Decision

No "add-to-onboarding" label needed. While this PR creates new documentation files, they document an existing feature (otel-binary collection agent) that's being reorganized, not a new way to send data to SigNoz. The refactor consolidates existing content rather than introducing a new integration or data collection method.

Sources

Technical accuracy verified using:


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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant