Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

NMS-16106: ValuePropertyMappingExtender doc update #6593

Merged
merged 1 commit into from
Aug 29, 2023
Merged

NMS-16106: ValuePropertyMappingExtender doc update #6593

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions ...eep-dive/performance-data-collection/snmp-property-extenders/value-mapping.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,27 @@ There are currently three parameters with fixed names:
|===

The remaining parameters are named for the input values, and their values represent the output values.


The following example shows how to convert a collected string to a numerical value, and store it as a separate metric.
This example assumes that the OID returns one of `OK`, `MISSING`,`ERROR`, OR `UNKNOWN`.
These values will be stored as an integer from 0 to 3, based on the mapping.
By defining these values in order, thresholding could be applied to the `wordGauge` metric to alert when the value falls out of the acceptable range.
If any other value is returned, the metric will store a default value of `-1`.


[source, xml]
----
<group name="snmp-value-mapping" ifType="all">
<mibObj oid=".1.3.6.1.4.1.2.3.4.5.6.7.8" instance="the-instance" alias="word" type="string"/>
<property instance="the-instance" alias="wordGauge" class-name="org.opennms.netmgt.collectd.ValueMappingPropertyExtender">
<parameter key="source-attribute" value="word"/>
<parameter key="target-type" value="gauge"/>
<parameter key="OK" value="0"/>
<parameter key="MISSING" value="1"/>
<parameter key="ERROR" value="2"/>
<parameter key="UNKNOWN" value="3"/>
<parameter key="default-value" value="-1"/>
</property>
</group>
----
Loading