Skip to content

Conversation

@nityanandagohain
Copy link
Member

@vercel
Copy link

vercel bot commented Dec 26, 2025

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

Project Deployment Review Updated (UTC)
signoz-web Ready Ready Preview, Comment Dec 26, 2025 6:16pm

@claude
Copy link
Contributor

claude bot commented Dec 26, 2025

Claude finished @nityanandagohain's task in 1m 33s —— View job


Documentation Review

Tasks

  • Read CONTRIBUTING.md guidelines
  • Review span-details.mdx changes
  • Verify technical accuracy
  • Check image references
  • Post review feedback

Summary

This PR successfully adds documentation for the span percentile feature in the trace details page. The changes are well-structured and follow most documentation guidelines. I've identified a few minor issues for improvement.

Issues Found

Minor Issues:

  1. Line 80 - Phrasing: "over the last one hour" → "over the past hour" (more natural English)
  2. Line 98 - Missing period at the end of the sentence before the figure tag

PR Checklist Compliance

Reviewing against the PR Checklist:

  • Frontmatter: Complete with date (updated to 2025-12-26), id, title, and description added
  • Images: Three new PNG images properly placed in /public/img/docs/apm-and-distributed-tracing/ and referenced correctly
  • Content accuracy: The span percentile concept is technically sound and aligns with OpenTelemetry distributed tracing principles for performance analysis
  • Structure: Properly uses H4 headings (####) for subsections under "Detailed Span Inspection"
  • Figure components: Correctly uses <figure> with data-zoomable, proper alt attributes, and captions

Note on image format: The images are in PNG format. Per CONTRIBUTING.md guidelines (line 267), WebP format (.webp) is preferred for all images. Consider converting these images to WebP format for better performance. See the Creating WebP images guide.

Technical Accuracy

The span percentile documentation is technically accurate. The feature description aligns with standard OpenTelemetry span performance analysis practices, where percentiles (p50, p90, p95, p99) are commonly used to identify performance outliers and understand latency distributions across distributed traces.

Sources:

Recommendation

This documentation is ready to merge after addressing the two minor inline comments. The content effectively explains the new span percentile feature and provides clear visual examples for users.

nityanandagohain and others added 2 commits December 26, 2025 23:36
Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
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