docs: Explain SNMP device node naming and label behavior - #23403
Draft
nedi-app[bot] wants to merge 1 commit into
Draft
docs: Explain SNMP device node naming and label behavior#23403nedi-app[bot] wants to merge 1 commit into
nedi-app[bot] wants to merge 1 commit into
Conversation
…node name and labels for a device by adding per-option detailed_description guidance to the vnode.hostname and vnode.labels options in the collector metadata.yaml. The node name is not derived from sysObjectID; it follows the precedence vnode.hostname -> SNMP sysName -> snmp-device, while sysObjectID is only the sys_object_id label. sys_object_id/name/description/contact/location/vendor/type/model are auto-detected labels, and vnode.labels overrides auto-detected labels with the same key. The published README (integrations/snmp_devices.md, symlinked from README.md) is fully generated from this metadata.yaml by integrations/gen_docs_integrations.py and regenerates automatically via CI, so the authoritative edit was made at the source rather than in the generated markdown.
|
Member
|
The description is excessively long and detailed. It's also in the wrong place, and the configuration example is misleading because it assumes users create jobs via configuration files. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Explain SNMP device node naming and label behavior. Files changed: src/go/plugin/go.d/collector/snmp/metadata.yaml.
User Request
changing the label doesn't seem like its changing anything. looking in the app.netdata.cloud interface it seem like its detirmined by the snmp sys_object_id,
Prompt (English)
How to change the displayed name/label of an SNMP-monitored device (vnode) in Netdata Cloud; clarification that sysObjectID does not set the name, sysName does, and labels are separate from hostname.
Reason for Change
This change applies the specific user request using repository-truth evidence from the audit execution workspace.
Summary by cubic
Clarifies how SNMP device node names and labels are determined in Netdata Cloud. Documents that the node name follows
vnode.hostname-> SNMPsysName->snmp-device(never fromsysObjectID), and lists the auto-populated labels with howvnode.labelscan override or add to them.Written for commit cb0eb89. Summary will update on new commits.