feature: Added support for sensors to be discovered from yaml #6859

laf · 2017-06-17T16:29:44Z

DO NOT DELETE THIS TEXT

Please note

Please read this information carefully. You can run ./scripts/pre-commit.php to check your code before submitting.

Have you followed our code guidelines?

Testers

If you would like to test this pull request then please run: ./scripts/github-apply <pr_id>, i.e ./scripts/github-apply 5926

Just pushing, nothing more right now.

mention-bot · 2017-06-17T16:29:45Z

Thank you for submitting a PR @laf! We have found the following @Rosiak based on the history of these files to review this PR.

LibreNMS-CI · 2017-06-17T16:32:50Z

Auto-Deploy finished, Test PR at http://6859.ci.librenms.org or https://6859.ci.librenms.org

LibreNMS-CI · 2017-06-17T18:57:48Z

Auto-Deploy finished, Test PR at http://6859.ci.librenms.org or https://6859.ci.librenms.org

LibreNMS-CI · 2017-06-18T21:22:19Z

Auto-Deploy finished, Test PR at http://6859.ci.librenms.org or https://6859.ci.librenms.org

laf · 2017-06-18T21:28:04Z

Ok this is open for feedback now.

@murrant I've removed the oid_name section in the last commit that you don't like :P

LibreNMS-CI · 2017-06-18T21:30:50Z

Auto-Deploy finished, Test PR at http://6859.ci.librenms.org or https://6859.ci.librenms.org

murrant · 2017-06-19T02:18:58Z

Looks amazing laf :)

ghost · 2017-06-19T06:11:04Z

YAML type is working only for OIDs in table or can be used for all kinds?

laf · 2017-06-19T06:18:13Z

How do you mean @FTBZ?

laf · 2017-06-19T06:29:10Z

Do you mean can it be used for OIDs that aren't in a table? No not at the moment. If you have an example device that this doesn't work on then I can look at seeing what we can do.

ghost · 2017-06-19T06:34:58Z

Exactly, I have already had cases where the OIDs of sensors are not in tables but I do not remember which. Good to know for further integration.

LibreNMS-CI · 2017-06-19T07:00:29Z

Auto-Deploy finished, Test PR at http://6859.ci.librenms.org or https://6859.ci.librenms.org

murrant · 2017-06-19T12:33:52Z

If you snmpwalk a single item, doesn't basically return a single getnext?

murrant · 2017-06-19T12:35:22Z

includes/discovery/sensors.inc.php

+        foreach ($data_array as $data) {
+            foreach ((array)$data['oid'] as $oid) {
+                $tmp_name = $data['oid'];
+                $pre_cache[$tmp_name] = snmpwalk_cache_oid($device, $oid, $pre_cache[$tmp_name], $device['dynamic_discovery']['mib'], null, '-OeQUs');


You should check if the oid has already been fetched here.

And send an empty array to the walk function.

Done.

Walking a single entry is ok but I'm not sure how well the code will work against that yet. I've added support for passing a description as a string as well as saying which key in the array contains the description so it's possibly ok with single OIDs.

LibreNMS-CI · 2017-06-19T12:48:28Z

Auto-Deploy finished, Test PR at http://6859.ci.librenms.org or https://6859.ci.librenms.org

…ml-for-discovery

laf · 2017-06-19T14:00:05Z

Rebased. Should pass travis now.

LibreNMS-CI · 2017-06-19T14:02:58Z

Auto-Deploy finished, Test PR at http://6859.ci.librenms.org or https://6859.ci.librenms.org

maciejkaczkowski · 2017-06-20T14:45:05Z

Is possible to add {{ $index }} to descr? I have device without descr of ports:
.1.3.6.1.4.1.11195.2.1.10.2.1.12.1 = INTEGER: -68
.1.3.6.1.4.1.11195.2.1.10.2.1.12.2 = INTEGER: -57
.1.3.6.1.4.1.11195.2.1.11.2.1.27.1 = INTEGER: 100
.1.3.6.1.4.1.11195.2.1.11.2.1.27.2 = INTEGER: 90

Tuner Input Level 1 = -68
Tuner Input Level 2 = -57
Modulator Output Level 1 = 100
Modulator Output Level 2 = 90

Is possible to add option to skip if empty or skip if value = xxx?

laf · 2017-06-20T19:43:01Z

I've added support for using index in descr.

Can you give me an example on what you'd want to skip?

LibreNMS-CI · 2017-06-20T19:54:38Z

Auto-Deploy finished, Test PR at http://6859.ci.librenms.org or https://6859.ci.librenms.org

maciejkaczkowski · 2017-06-21T03:28:43Z

Thank you.
For example Arris C4, if card is not inserted to chassis then value is 999
https://github.com/librenms/librenms/blob/master/includes/discovery/sensors/temperature/cmts.inc.php

…ml-for-discovery

laf · 2017-06-22T21:43:09Z

@maciejkaczkowski I've added that support:

skip_values:

laf · 2017-06-26T13:20:23Z

This should be good for a merge now imho.

murrant · 2017-06-26T14:02:40Z

Looks good to me laf, I plan to try to convert one of the devices I have, but we don't have to wait on me to merge.

Rosiak · 2017-06-26T17:59:41Z

Almost there!
However it only adds one of the multiple sensors under otherStateSensorTable:
Working

This PR:

Output from SNMP from this table:

otherStateSensorId.513106929 = nbAlinkEnc_0_3_SPLK
otherStateSensorId.2637721517 = nbAlinkEnc_0_4_SMOK
otherStateSensorId.3502248167 = nbLinkStatus_eth0
otherStateSensorId.3823829717 = nbAlinkPowerStatus_can0
otherStateSensorValue.513106929 = 0
otherStateSensorValue.2637721517 = 0
otherStateSensorValue.3502248167 = 1
otherStateSensorValue.3823829717 = 0
otherStateSensorErrorStatus.513106929 = 0
otherStateSensorErrorStatus.2637721517 = 0
otherStateSensorErrorStatus.3502248167 = 0
otherStateSensorErrorStatus.3823829717 = 0
otherStateSensorLabel.513106929 = Spot leak  (3)
otherStateSensorLabel.2637721517 = Smoke  (4)
otherStateSensorLabel.3502248167 = Ethernet Link Status
otherStateSensorLabel.3823829717 = A-Link Bus Power
otherStateSensorEncId.513106929 = nbAlinkEnc_0
otherStateSensorEncId.2637721517 = nbAlinkEnc_0
otherStateSensorEncId.3502248167 = nbBaseEnclosure
otherStateSensorEncId.3823829717 = nbBaseEnclosure
otherStateSensorPortId.513106929 =
otherStateSensorPortId.2637721517 =
otherStateSensorPortId.3502248167 =
otherStateSensorPortId.3823829717 =
otherStateSensorValueStr.513106929 = No Leak
otherStateSensorValueStr.2637721517 = No Smoke
otherStateSensorValueStr.3502248167 = Up
otherStateSensorValueStr.3823829717 = OK
otherStateSensorEntry.8.513106929 = 513106929
otherStateSensorEntry.8.2637721517 = 2637721517
otherStateSensorEntry.8.3502248167 = 3502248167
otherStateSensorEntry.8.3823829717 = 3823829717

Rosiak

Just a tiny comment, then I think we're good to go!

Rosiak · 2017-06-26T18:43:47Z

doc/Developing/Sensor-State-Support.md

+                    - { descr: motionDetected, graph: 0, value: 1, generic: 2 }
+            -
+                oid: otherStateSensorTable
+                value: otherStateSensorValue


I believe the correct name is:
otherStateSensorErrorStatus

Updated, don't think it matters though.

Rosiak · 2017-06-26T18:44:06Z

doc/Developing/Sensor-State-Support.md

+                num_oid: .1.3.6.1.4.1.5528.100.4.2.10.1.3.
+                descr: otherStateSensorLabel
+                index: '{{ $index }}'
+                state_name: otherStateSensorErrorStatus


How about otherStateSensor?

It's how it is in the old code so replicating that.

Rosiak · 2017-06-26T18:44:36Z

includes/definitions/discovery/netbotz.yaml

+                    - { descr: motionDetected, graph: 0, value: 1, generic: 2 }
+            -
+                oid: otherStateSensorTable
+                value: otherStateSensorValue


I believe the correct name is:
otherStateSensorErrorStatus

Rosiak · 2017-06-26T18:44:52Z

includes/definitions/discovery/netbotz.yaml

+                num_oid: .1.3.6.1.4.1.5528.100.4.2.10.1.3.
+                descr: otherStateSensorLabel
+                index: '{{ $index }}'
+                state_name: otherStateSensorErrorStatus


How about otherStateSensor?

scrutinizer-notifier · 2017-06-26T20:35:29Z

The inspection completed: No new issues

lock · 2018-05-17T22:03:45Z

This thread has been automatically locked since there has not been any recent activity after it was closed.

feature: Added support for sensors to be discovered from yaml

cece4d8

added discovery definitions

202b3fa

laf added 2 commits June 18, 2017 22:14

Updated docs, more code updates + tests

5c24c7a

removed the oid_name use

0434377

pre-set variable from scrut output

438c724

murrant reviewed Jun 19, 2017

View reviewed changes

small updates as per comments in pr

67dfde3

Merge branch 'master' of github.com:librenms/librenms into feature/ya…

aac6e8e

…ml-for-discovery

Allow index in descr

74f5928

Merge branch 'master' of github.com:librenms/librenms into feature/ya…

3553015

…ml-for-discovery

Added ability to skip values

08f2c8e

Check for numeric values

2b8ff70

Rosiak reviewed Jun 26, 2017

View reviewed changes

small update of oid name

5401bfd

laf merged commit 5e32474 into librenms:master Jun 26, 2017

laf deleted the feature/yaml-for-discovery branch June 26, 2017 22:28

lock bot locked as resolved and limited conversation to collaborators May 17, 2018

feature: Added support for sensors to be discovered from yaml #6859

feature: Added support for sensors to be discovered from yaml #6859

Conversation

laf commented Jun 17, 2017

Please note

Testers

mention-bot commented Jun 17, 2017

LibreNMS-CI commented Jun 17, 2017

LibreNMS-CI commented Jun 17, 2017

LibreNMS-CI commented Jun 18, 2017

laf commented Jun 18, 2017

LibreNMS-CI commented Jun 18, 2017

murrant commented Jun 19, 2017

ghost commented Jun 19, 2017

laf commented Jun 19, 2017

laf commented Jun 19, 2017

ghost commented Jun 19, 2017

LibreNMS-CI commented Jun 19, 2017

murrant commented Jun 19, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

LibreNMS-CI commented Jun 19, 2017

laf commented Jun 19, 2017

LibreNMS-CI commented Jun 19, 2017

maciejkaczkowski commented Jun 20, 2017

laf commented Jun 20, 2017

LibreNMS-CI commented Jun 20, 2017

maciejkaczkowski commented Jun 21, 2017

laf commented Jun 22, 2017

laf commented Jun 26, 2017

murrant commented Jun 26, 2017

Rosiak commented Jun 26, 2017

Rosiak left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

scrutinizer-notifier commented Jun 26, 2017

lock bot commented May 17, 2018