From 6c14d93f46b2088312db4a87a29a72888ae85f3b Mon Sep 17 00:00:00 2001 From: Mark Mahacek Date: Tue, 29 Aug 2023 08:09:41 -0700 Subject: [PATCH] NMS-16106: ValuePropertyMappingExtender doc update --- .../value-mapping.adoc | 24 +++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/docs/modules/operation/pages/deep-dive/performance-data-collection/snmp-property-extenders/value-mapping.adoc b/docs/modules/operation/pages/deep-dive/performance-data-collection/snmp-property-extenders/value-mapping.adoc index 351e10225dd3..b26484a1b409 100644 --- a/docs/modules/operation/pages/deep-dive/performance-data-collection/snmp-property-extenders/value-mapping.adoc +++ b/docs/modules/operation/pages/deep-dive/performance-data-collection/snmp-property-extenders/value-mapping.adoc @@ -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] +---- + + + + + + + + + + + + +----