Skip to content

NMS-12662: Performance data collection docs - #8989

Closed
joseanesONMS wants to merge 7 commits into
developfrom
jira/NMS-12662-collection-docs-smoke
Closed

joseanesONMS wants to merge 7 commits into
developfrom
jira/NMS-12662-collection-docs-smoke

Conversation

@joseanesONMS

@joseanesONMS joseanesONMS commented Oct 22, 2026 •

Copy link
Copy Markdown
Contributor

Documents the collectd and collector configuration, split out of #8984; content checked against the code on develop, one commit per ticket.

Ticket Topic Page(s) added/changed Source of truth
NMS-12662 storFlagOverride and the ifAlias storage options operation/…/collectd/collection-packages.adoc collectd-configuration.xsd, CollectionSpecification.java, IfInfo.java
NMS-14278 strictInterval operation/…/collectd/configuration.adoc, reference/…/system-properties.adoc opennms-services/…/collectd/CollectableService.java
NMS-13557 Common collector parameters reference/…/performance-data-collection/introduction.adoc CollectableService.java, CollectorRequestBuilderImpl.java, RpcTargetHelper.java
NMS-12579 XmlCollector URL and request placeholders reference/…/collectors/xml.adoc protocols/xml/…/AbstractXmlCollectionHandler.java, XmlCollector.java
NMS-3927 subIndex and other resource label expressions operation/…/resource-types.adoc opennms-dao/…/GenericIndexResourceType.java
NMS-12623 Data collection groups and system definitions reference/…/collectors/SnmpCollector.adoc datacollection-config.xsd, DataCollectionConfigParser.java

Corrections to existing docs (separate NMS-12662: Fix … commits, each can be dropped on its own)

Topic Change Source of truth
SnmpCollector rrdRepository attribute name datacollection-config.xsd

The docs build adds no warnings (develop's two existing ones remain).

External References

The collectd package elements storeByIfAlias, ifAliasDomain, storeByNodeID, storFlagOverride, and ifAliasComment were undocumented; storFlagOverride only has meaning together with the others.
Behavior is taken from collectd-configuration.xsd, CollectionSpecification, ServiceParameters, IfInfo, and AliasedResource.
org.opennms.netmgt.collectd.strictInterval has defaulted to true since NMS-14259, but neither the property nor its effect on collection scheduling was documented.
Behavior and default are taken from CollectableService.
Service monitors and detectors have a common parameter section, but collectors did not, so thresholding-enabled, ttl, and the Minion targeting parameters were only partly documented per collector.
The list is limited to parameters handled generically by CollectableService, CollectorRequestBuilderImpl, and RpcTargetHelper.
…ests

The XmlCollector page used placeholders such as {ipaddr} in examples but never listed which ones exist or where they apply, and linked to the unrelated filter parameters page.
The list comes from AbstractXmlCollectionHandler.parseString and XmlCollector.filterParameters.
The resourceLabel attribute of resource types supports subIndex, hex, and string expressions that shipped resource types such as cesServerFarmRserverEntry rely on, but none of them were documented.
Semantics are taken from GenericIndexResourceType, with a worked example for the Cisco SLB resource type.
The SnmpCollector page showed datacollection-config.xml and an include example, but did not explain the elements of a data collection group (group, mibObj, systemDef, ipList) or the include-collection options.
Element semantics are taken from datacollection-config.xsd, DataCollectionConfigParser, and DataCollectionConfigLookupUtils.
The root element attribute is rrdRepository (datacollection-config.xsd and @XmlAttribute in DatacollectionConfig.java), not rrd-repository.
@joseanesONMS

Copy link
Copy Markdown
Contributor Author

Reopened as #8999 from a branch without the -smoke suffix; this PR is docs-only, so it doesn't need a smoke run.

@joseanesONMS
joseanesONMS deleted the jira/NMS-12662-collection-docs-smoke branch October 22, 2026 12:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant