docs: Add Set Custom Attributes doc #2184
Conversation
Signed-off-by: Jugal Kishore <[email protected]>
crazyuploader
requested review from
makeavish,
pranay01 and
therealpandey
as code owners
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Claude finished @crazyuploader's task —— View job Documentation Review CompleteI've reviewed this PR against the repository's CONTRIBUTING.md guidelines. The document provides solid technical content about setting custom attributes in OpenTelemetry, but needs some structural improvements to meet the documentation standards. Summary of FindingsCritical Issues (Must Fix)
Important Improvements (Should Fix)
Technical Accuracy✅ All processor configurations verified against official OpenTelemetry sources:
PR Checklist ComplianceComparing against the PR Checklist:
Recommendations
The content is technically accurate and comprehensive - these changes will align it with the repository's documentation standards and improve usability. |
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
|
|
||
| ## Overview | ||
|
|
||
| Attributes/Resource attributes provide additional contextual information about the source and type of telemetry data, such as service name, environment, hostname, etc. Attributes help in better filtering, grouping, correlation of telemetry data in SigNoz. |
There was a problem hiding this comment.
Missing Prerequisites section. According to CONTRIBUTING.md, documentation should include a Prerequisites section listing versions, accounts, keys, cluster access, etc., with links.
For this guide, consider adding prerequisites such as:
- OpenTelemetry Collector version requirements
- SDK versions for each language
- SigNoz deployment (Cloud or Self-Hosted)
Source: CONTRIBUTING.md lines 109-110
|
|
||
| ## Overview | ||
|
|
||
| Attributes/Resource attributes provide additional contextual information about the source and type of telemetry data, such as service name, environment, hostname, etc. Attributes help in better filtering, grouping, correlation of telemetry data in SigNoz. |
There was a problem hiding this comment.
Missing Validate section. According to CONTRIBUTING.md, docs should include a "Validate" section showing how to confirm success (UI path, endpoint, example output).
Consider adding a section showing:
- How to view the custom attributes in SigNoz UI
- Where to find them in Traces/Logs/Metrics explorers
- Screenshots of the UI showing the custom attributes
Source: CONTRIBUTING.md lines 111-112
|
|
||
| ## Overview | ||
|
|
||
| Attributes/Resource attributes provide additional contextual information about the source and type of telemetry data, such as service name, environment, hostname, etc. Attributes help in better filtering, grouping, correlation of telemetry data in SigNoz. |
There was a problem hiding this comment.
Missing Troubleshooting section. According to CONTRIBUTING.md, docs should include a Troubleshooting section covering common issues and fixes.
Consider adding troubleshooting guidance for common issues like:
- Attributes not appearing in SigNoz
- Processor configuration errors
- SDK instrumentation issues
Source: CONTRIBUTING.md lines 112-113
|
|
||
| ## Overview | ||
|
|
||
| Attributes/Resource attributes provide additional contextual information about the source and type of telemetry data, such as service name, environment, hostname, etc. Attributes help in better filtering, grouping, correlation of telemetry data in SigNoz. |
There was a problem hiding this comment.
Missing Next Steps section. According to CONTRIBUTING.md, docs should include a short "Next steps" section linking to adjacent features or deeper guides.
Consider adding links to:
- Query Builder documentation for filtering by custom attributes
- Alert Management for creating alerts based on attributes
- Dashboard creation guides
Source: CONTRIBUTING.md lines 324-325
|
|
||
| ## Overview | ||
|
|
||
| Attributes/Resource attributes provide additional contextual information about the source and type of telemetry data, such as service name, environment, hostname, etc. Attributes help in better filtering, grouping, correlation of telemetry data in SigNoz. |
There was a problem hiding this comment.
Missing Cloud vs Self-Host guidance. According to CONTRIBUTING.md, when a guide could apply to both environments, include an Admonition noting the other environment and linking to the comparison page.
The processors shown work for both Cloud and Self-Hosted deployments. Consider adding a note about endpoint differences if applicable.
Source: CONTRIBUTING.md lines 180-201
| receivers: [otlp] | ||
| processors: [attributes, batch] | ||
| exporters: [otlp] | ||
| ``` |
There was a problem hiding this comment.
Missing explanation of configuration. According to CONTRIBUTING.md, after code/config blocks, you should explain each critical field.
Consider adding explanation after this block, such as:
- What each action type does (delete, hash)
- When to use attributes processor vs resource processor
- How this applies to traces, metrics, and logs pipelines
Source: CONTRIBUTING.md lines 113-117, 143
| receivers: [otlp] | ||
| processors: [resource, batch] | ||
| exporters: [otlp] | ||
| ``` |
There was a problem hiding this comment.
Missing explanation of resource processor actions. After the code block, explain what each action does:
upsert: Always sets the value (insert or update)insert: Only adds if key doesn't existdelete: Removes the attributehash: Hashes the value (for PII)
Source: https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/processor/resourceprocessor/README.md
Source: CONTRIBUTING.md line 143
| exporters: [otlp] | ||
| ``` | ||
|
|
||
| This example includes resource detection processor setup to automatically include resource attributes from the environment, host system, Docker containers, Kubernetes nodes. The complete list of supported detectors can be found [here](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/processor/resourcedetectionprocessor/README.md#supported-detectors). |
There was a problem hiding this comment.
Link to official documentation is good, but consider cross-linking to SigNoz's OTel Collector configuration guide as recommended in CONTRIBUTING.md.
Add: "For more details on collector configuration, see the OpenTelemetry Collector configuration guide."
Source: CONTRIBUTING.md lines 73, 228
| } | ||
| ``` | ||
|
|
||
| For more information on how to Instrument a .NET app, check this [guide](https://signoz.io/docs/instrumentation/opentelemetry-dotnet/). |
There was a problem hiding this comment.
Good cross-reference to related documentation. Consider using the full absolute URL format as recommended in CONTRIBUTING.md:
https://signoz.io/docs/instrumentation/opentelemetry-dotnet/
Source: CONTRIBUTING.md line 163
| <TabItem value="nodejs" label="Node.js" default> | ||
|
|
||
| ```javascript | ||
| import { Resource } from '@opentelemetry/resources' |
There was a problem hiding this comment.
Missing code block annotation with filename.
| import { Resource } from '@opentelemetry/resources' | |
| ```javascript:instrumentation.js |
Source: CONTRIBUTING.md lines 117-126
Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
|
Claude finished @crazyuploader's task —— View job Review SummaryI've reviewed the latest changes to this PR. The code block filename annotations have been successfully added ✓. However, several important issues from the previous review still need to be addressed to meet the repository's documentation standards. Remaining Issues1. Date Format Issue (Critical)Line 2: The date Source: CONTRIBUTING.md line 98 2. Missing Required SectionsAccording to CONTRIBUTING.md, documentation must include these standard sections: Missing Prerequisites Section
Source: CONTRIBUTING.md lines 109-110 Missing Validate Section
Source: CONTRIBUTING.md lines 111-112 Missing Troubleshooting Section
Source: CONTRIBUTING.md lines 112-113 Missing Next Steps Section
Source: CONTRIBUTING.md lines 324-325 3. Missing Cloud vs Self-Host GuidanceThe processors shown work for both Cloud and Self-Hosted deployments. According to CONTRIBUTING.md lines 180-201, include an Admonition noting applicability to both environments: <Admonition type="info">
This guide applies to both SigNoz Cloud and Self-Hosted deployments. If configuration differs between environments, see [Cloud vs Self-Hosted comparison](https://signoz.io/docs/ingestion/cloud-vs-self-hosted/).
</Admonition>4. Missing Configuration ExplanationsAfter code/config blocks, explain critical fields (CONTRIBUTING.md lines 113-117, 143): After attributes processor block (line 43):
After resource processor block (line 78):
5. Missing Cross-Link to SigNoz Collector GuideLine 108: The document links to the official OTel docs, but should also cross-link to SigNoz's collector configuration guide: "For more details on collector configuration in SigNoz, see the OpenTelemetry Collector configuration guide." Source: CONTRIBUTING.md lines 73, 228 Technical Accuracy ✓I verified the technical content against official OpenTelemetry sources:
All configurations and code examples are technically accurate. PR Checklist StatusComparing against the Docs PR Checklist:
SummaryGood progress! The code block annotations were successfully added. To complete this PR, please address:
The technical content is solid and accurate - these changes will align it with the repository's documentation standards and significantly improve usability for readers. |
Signed-off-by: Jugal Kishore <[email protected]>
|
Claude finished @crazyuploader's task —— View job Review SummaryI've reviewed the latest version of this PR. Good progress has been made, but several important issues from previous reviews still need to be addressed to meet the repository's documentation standards defined in CONTRIBUTING.md. Critical Issues1. Date Format Error (Line 2)The date Source: CONTRIBUTING.md line 98 Missing Required SectionsAccording to CONTRIBUTING.md lines 107-112, documentation must include these standard sections: Missing Prerequisites SectionThe guide should include a Prerequisites section after the Overview, listing:
Source: CONTRIBUTING.md lines 109-110 Missing Validate SectionShould show how to confirm the custom attributes appear in SigNoz:
Source: CONTRIBUTING.md lines 111-112 Missing Troubleshooting SectionShould cover common issues like:
Source: CONTRIBUTING.md lines 112-113, 271-273 Missing Next Steps SectionShould link to adjacent features:
Source: CONTRIBUTING.md lines 303, 324-325 Missing Content Guidelines3. Missing Cloud vs Self-Host GuidanceThe processors shown work for both Cloud and Self-Hosted deployments. According to CONTRIBUTING.md lines 180-201, include an Admonition noting applicability: <Admonition type="info">
This guide applies to both SigNoz Cloud and Self-Hosted deployments. For endpoint and authentication differences, see [Cloud vs Self-Hosted comparison](https://signoz.io/docs/ingestion/cloud-vs-self-hosted/).
</Admonition>Source: CONTRIBUTING.md lines 180-201 4. Missing Configuration ExplanationsAfter code/config blocks, explain critical fields (CONTRIBUTING.md lines 113-117, 143): After attributes processor block (line 43):
After resource processor block (line 78):
After resource detection processor block (line 106):
5. Missing Cross-Link to SigNoz Collector GuideLine 108: The document links to the official OTel docs, which is good. However, you should also cross-link to SigNoz's collector configuration guide as recommended in CONTRIBUTING.md: Add: "For more details on configuring the OpenTelemetry Collector in SigNoz, see the OpenTelemetry Collector configuration guide." Source: CONTRIBUTING.md lines 73, 228 Technical Accuracy ✅I verified the technical content against official OpenTelemetry sources: ✅ Attributes processor - Verified ✅ Resource processor - Verified ✅ Resource detection processor - Verified ✅ SDK APIs - Verified span attribute APIs across languages:
Source: https://opentelemetry.io/docs/ ✅ Metrics APIs - Verified metrics attribute APIs are correct across all languages ✅ Logs/Resource attributes - Verified resource attribute configuration for logs is correct All configurations and code examples are technically accurate. PR Checklist StatusComparing against the Docs PR Checklist:
SummaryThe document provides solid technical content with accurate OpenTelemetry configurations and code examples. To complete this PR and meet the repository's documentation standards: Must fix:
Should fix: These changes will align the document with the repository's standards and significantly improve usability for readers. |
Signed-off-by: Jugal Kishore <[email protected]>
Signed-off-by: Jugal Kishore <[email protected]>
Signed-off-by: Jugal Kishore <[email protected]>
|
Claude encountered an error —— View job Reviewing latest changes
|
|
Claude Code is working… I'll analyze this and get back to you. |
1 participant
Closes: #2778
Doc: Link