mirror/librenms-librenms
1
0
Fork 0
mirror of https://github.com/librenms/librenms.git synced 2024-10-07 16:52:45 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Powerdns app to json (#9680)

Browse Source 
* Update powerdns app for json

* test data

* qsize-q is value

* add legacy test data

* docs

* Update linux_powerdns-v1.json
This commit is contained in:
Tony Murray
2019-01-17 11:43:43 -06:00
committed by GitHub
parent 73fa616739
commit 74c57441e2
6 changed files with 443 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
doc/Extensions/Applications.md
View File

@@ -865,7 +865,21 @@ The application should be auto-discovered as described at the top of the page. I
### PowerDNS
An authoritative DNS server: https://www.powerdns.com/auth.html
#### SNMP Extend
1: Copy the shell script, powerdns.py, to the desired host. `wget https://github.com/librenms/librenms-agent/raw/master/snmp/powerdns.py -O /etc/snmp/powerdns.py`
2: Run `chmod +x /etc/snmp/powerdns.py`
3: Edit your snmpd.conf file and add:
```
extend powerdns /etc/snmp/powerdns.py
```
4: Restart snmpd on your host
The application should be auto-discovered as described at the top of the page. If it is not, please follow the steps set out under `SNMP Extend` heading top of page.
##### Agent
[Install the agent](Agent-Setup.md) on this device if it isn't already and copy the `powerdns` script to `/usr/lib/check_mk_agent/local/`

146
includes/polling/applications/powerdns.inc.php
View File

@@ -2,78 +2,98 @@
// Polls powerdns statistics from script via SNMP
use LibreNMS\Exceptions\JsonAppException;
use LibreNMS\Exceptions\JsonAppParsingFailedException;
use LibreNMS\RRD\RrdDefinition;
$options = '-Oqv';
$oid = '.1.3.6.1.4.1.8072.1.3.2.3.1.2.8.112.111.119.101.114.100.110.115';
$name = 'powerdns';
$app_id = $app['app_id'];
if ($agent_data['app'][$name]) {
$powerdns = $agent_data['app'][$name];
$powerdns = [];
echo " $name";
// unused metrics:
// deferred-packetcache-inserts, deferred-packetcache-lookup, dnsupdate-answers, dnsupdate-changes, dnsupdate-queries, dnsupdate-refused, incoming-notifications
// query-cache-size, overload-drops, rd-queries, recursion-unanswered, security-status, signatures, tcp-answers-bytes, tcp4-answers, tcp4-answers-bytes, tcp4-queries
// tcp6-answers, tcp6-answers-bytes, tcp6-queries, udp-answers-bytes, udp-do-queries, udp4-answers-bytes, udp6-answers-bytes, fd-usage, key-cache-size
// meta-cache-size, real-memory-usage, signature-cache-size, sys-msec, udp-in-errors, udp-noport-errors, udp-recvbuf-errors, udp-sndbuf-errors, uptime, user-msec
$powerdns_metrics = [
'corruptPackets' => 'corrupt-packets',
'def_cacheInserts' => 'deferred-cache-inserts',
'def_cacheLookup' => 'deferred-cache-lookup',
'latency' => 'latency',
'pc_hit' => 'packetcache-hit',
'pc_miss' => 'packetcache-miss',
'pc_size' => 'packetcache-size',
'qsize' => 'qsize-q',
'qc_hit' => 'query-cache-hit',
'qc_miss' => 'query-cache-miss',
'rec_answers' => 'recursing-answers',
'rec_questions' => 'recursing-questions',
'servfailPackets' => 'servfail-packets',
'q_tcpAnswers' => 'tcp-answers',
'q_tcpQueries' => 'tcp-queries',
'q_timedout' => 'timedout-packets',
'q_udpAnswers' => 'udp-answers',
'q_udpQueries' => 'udp-queries',
'q_udp4Answers' => 'udp4-answers',
'q_udp4Queries' => 'udp4-queries',
'q_udp6Answers' => 'udp6-answers',
'q_udp6Queries' => 'udp6-queries',
];
if (isset($agent_data) && isset($agent_data['app'][$name])) {
$legacy = $agent_data['app'][$name];
} else {
$powerdns = snmp_get($device, $oid, $options);
$powerdns = trim($powerdns, '"');
try {
$powerdns = json_app_get($device, $name)['data'];
} catch (JsonAppParsingFailedException $e) {
$legacy = $e->getOutput();
} catch (JsonAppException $e) {
echo PHP_EOL . $name . ':' .$e->getCode().':'. $e->getMessage() . PHP_EOL;
update_application($app, $e->getCode().':'.$e->getMessage(), []); // Set empty metrics and error message
return;
}
}
echo ' powerdns';
if (isset($legacy)) {
// Legacy script, build compatible array
list(
$powerdns['corrupt-packets'],
$powerdns['deferred-cache-inserts'],
$powerdns['deferred-cache-lookup'],
$powerdns['latency'],
$powerdns['packetcache-hit'],
$powerdns['packetcache-miss'],
$powerdns['packetcache-size'],
$powerdns['qsize-q'],
$powerdns['query-cache-hit'],
$powerdns['query-cache-miss'],
$powerdns['recursing-answers'],
$powerdns['recursing-questions'],
$powerdns['servfail-packets'],
$powerdns['tcp-answers'],
$powerdns['tcp-queries'],
$powerdns['timedout-packets'],
$powerdns['udp-answers'],
$powerdns['udp-queries'],
$powerdns['udp4-answers'],
$powerdns['udp4-queries'],
$powerdns['udp6-answers'],
$powerdns['udp6-queries'],
) = explode("\n", $legacy);
}
list ($corrupt, $def_cacheInserts, $def_cacheLookup, $latency, $pc_hit,
$pc_miss, $pc_size, $qsize, $qc_hit, $qc_miss, $rec_answers,
$rec_questions, $servfail, $tcp_answers, $tcp_queries, $timedout,
$udp_answers, $udp_queries, $udp4_answers, $udp4_queries, $udp6_answers,
$udp6_queries) = explode("\n", $powerdns);
d_echo($powerdns);
$rrd_name = array('app', $name, $app_id);
$rrd_def = RrdDefinition::make()
->addDataset('corruptPackets', 'DERIVE', 0, 125000000000)
->addDataset('def_cacheInserts', 'DERIVE', 0, 125000000000)
->addDataset('def_cacheLookup', 'DERIVE', 0, 125000000000)
->addDataset('latency', 'DERIVE', 0, 125000000000)
->addDataset('pc_hit', 'DERIVE', 0, 125000000000)
->addDataset('pc_miss', 'DERIVE', 0, 125000000000)
->addDataset('pc_size', 'DERIVE', 0, 125000000000)
->addDataset('qsize', 'DERIVE', 0, 125000000000)
->addDataset('qc_hit', 'DERIVE', 0, 125000000000)
->addDataset('qc_miss', 'DERIVE', 0, 125000000000)
->addDataset('rec_answers', 'DERIVE', 0, 125000000000)
->addDataset('rec_questions', 'DERIVE', 0, 125000000000)
->addDataset('servfailPackets', 'DERIVE', 0, 125000000000)
->addDataset('q_tcpAnswers', 'DERIVE', 0, 125000000000)
->addDataset('q_tcpQueries', 'DERIVE', 0, 125000000000)
->addDataset('q_timedout', 'DERIVE', 0, 125000000000)
->addDataset('q_udpAnswers', 'DERIVE', 0, 125000000000)
->addDataset('q_udpQueries', 'DERIVE', 0, 125000000000)
->addDataset('q_udp4Answers', 'DERIVE', 0, 125000000000)
->addDataset('q_udp4Queries', 'DERIVE', 0, 125000000000)
->addDataset('q_udp6Answers', 'DERIVE', 0, 125000000000)
->addDataset('q_udp6Queries', 'DERIVE', 0, 125000000000);
$fields = array(
'corruptPackets' => $corrupt,
'def_cacheInserts' => $def_cacheInserts,
'def_cacheLookup' => $def_cacheLookup,
'latency' => $latency,
'pc_hit' => $pc_hit,
'pc_miss' => $pc_miss,
'pc_size' => $pc_size,
'qsize' => $qsize,
'qc_hit' => $qc_hit,
'qc_miss' => $qc_miss,
'rec_answers' => $rec_answers,
'rec_questions' => $rec_questions,
'servfailPackets' => $servfail,
'q_tcpAnswers' => $tcp_answers,
'q_tcpQueries' => $tcp_queries,
'q_timedout' => $timedout,
'q_udpAnswers' => $udp_answers,
'q_udpQueries' => $udp_queries,
'q_udp4Answers' => $udp4_answers,
'q_udp4Queries' => $udp4_queries,
'q_udp6Answers' => $udp6_answers,
'q_udp6Queries' => $udp6_queries,
);
$rrd_name = ['app', $name, $app_id];
$rrd_def = RrdDefinition::make();
$fields = [];
foreach ($powerdns_metrics as $ds => $metric) {
$rrd_def->addDataset($ds, 'DERIVE', 0, 125000000000);
$fields[$ds] = isset($powerdns[$metric]) ? $powerdns[$metric] : 'U';
}
$tags = compact('name', 'app_id', 'rrd_name', 'rrd_def');
data_update($device, 'app', $tags, $fields);
update_application($app, $powerdns, $fields);
update_application($app, json_encode($powerdns), $fields);

163
tests/data/linux_powerdns-legacy.json Normal file
View File

@@ -0,0 +1,163 @@
{
"applications": {
"discovery": {
"applications": [
{
"app_type": "powerdns",
"app_state": "UNKNOWN",
"discovered": 1,
"app_state_prev": null,
"app_status": "",
"app_instance": ""
}
],
"application_metrics": []
},
"poller": {
"applications": [
{
"app_type": "powerdns",
"app_state": "OK",
"discovered": 1,
"app_state_prev": "UNKNOWN",
"app_status": "",
"app_instance": ""
}
],
"application_metrics": [
{
"metric": "corruptPackets",
"value": 263994,
"value_prev": null,
"app_type": "powerdns"
},
{
"metric": "def_cacheInserts",
"value": 103620,
"value_prev": null,
"app_type": "powerdns"
},
{
"metric": "def_cacheLookup",
"value": 46904,
"value_prev": null,
"app_type": "powerdns"
},
{
"metric": "latency",
"value": 66,
"value_prev": null,
"app_type": "powerdns"
},
{
"metric": "pc_hit",
"value": 26752965,
"value_prev": null,
"app_type": "powerdns"
},
{
"metric": "pc_miss",
"value": 56238592,
"value_prev": null,
"app_type": "powerdns"
},
{
"metric": "pc_size",
"value": 10010,
"value_prev": null,
"app_type": "powerdns"
},
{
"metric": "q_tcpAnswers",
"value": 342298,
"value_prev": null,
"app_type": "powerdns"
},
{
"metric": "q_tcpQueries",
"value": 342338,
"value_prev": null,
"app_type": "powerdns"
},
{
"metric": "q_timedout",
"value": 101,
"value_prev": null,
"app_type": "powerdns"
},
{
"metric": "q_udp4Answers",
"value": 69164219,
"value_prev": null,
"app_type": "powerdns"
},
{
"metric": "q_udp4Queries",
"value": 69141375,
"value_prev": null,
"app_type": "powerdns"
},
{
"metric": "q_udp6Answers",
"value": 13642502,
"value_prev": null,
"app_type": "powerdns"
},
{
"metric": "q_udp6Queries",
"value": 13619383,
"value_prev": null,
"app_type": "powerdns"
},
{
"metric": "q_udpAnswers",
"value": 82806721,
"value_prev": null,
"app_type": "powerdns"
},
{
"metric": "q_udpQueries",
"value": 82760758,
"value_prev": null,
"app_type": "powerdns"
},
{
"metric": "qc_hit",
"value": 116321508,
"value_prev": null,
"app_type": "powerdns"
},
{
"metric": "qc_miss",
"value": 132908205,
"value_prev": null,
"app_type": "powerdns"
},
{
"metric": "qsize",
"value": 0,
"value_prev": null,
"app_type": "powerdns"
},
{
"metric": "rec_answers",
"value": 0,
"value_prev": null,
"app_type": "powerdns"
},
{
"metric": "rec_questions",
"value": 0,
"value_prev": null,
"app_type": "powerdns"
},
{
"metric": "servfailPackets",
"value": 263461,
"value_prev": null,
"app_type": "powerdns"
}
]
}
}
}

163
tests/data/linux_powerdns-v1.json Normal file
View File

@@ -0,0 +1,163 @@
{
"applications": {
"discovery": {
"applications": [
{
"app_type": "powerdns",
"app_state": "UNKNOWN",
"discovered": 1,
"app_state_prev": null,
"app_status": "",
"app_instance": ""
}
],
"application_metrics": []
},
"poller": {
"applications": [
{
"app_type": "powerdns",
"app_state": "OK",
"discovered": 1,
"app_state_prev": "UNKNOWN",
"app_status": "",
"app_instance": ""
}
],
"application_metrics": [
{
"metric": "corruptPackets",
"value": 263986,
"value_prev": null,
"app_type": "powerdns"
},
{
"metric": "def_cacheInserts",
"value": 103618,
"value_prev": null,
"app_type": "powerdns"
},
{
"metric": "def_cacheLookup",
"value": 46903,
"value_prev": null,
"app_type": "powerdns"
},
{
"metric": "latency",
"value": 77,
"value_prev": null,
"app_type": "powerdns"
},
{
"metric": "pc_hit",
"value": 26752411,
"value_prev": null,
"app_type": "powerdns"
},
{
"metric": "pc_miss",
"value": 56237088,
"value_prev": null,
"app_type": "powerdns"
},
{
"metric": "pc_size",
"value": 10144,
"value_prev": null,
"app_type": "powerdns"
},
{
"metric": "q_tcpAnswers",
"value": 342297,
"value_prev": null,
"app_type": "powerdns"
},
{
"metric": "q_tcpQueries",
"value": 342337,
"value_prev": null,
"app_type": "powerdns"
},
{
"metric": "q_timedout",
"value": 101,
"value_prev": null,
"app_type": "powerdns"
},
{
"metric": "q_udp4Answers",
"value": 69162533,
"value_prev": null,
"app_type": "powerdns"
},
{
"metric": "q_udp4Queries",
"value": 69139691,
"value_prev": null,
"app_type": "powerdns"
},
{
"metric": "q_udp6Answers",
"value": 13642112,
"value_prev": null,
"app_type": "powerdns"
},
{
"metric": "q_udp6Queries",
"value": 13618995,
"value_prev": null,
"app_type": "powerdns"
},
{
"metric": "q_udpAnswers",
"value": 82804645,
"value_prev": null,
"app_type": "powerdns"
},
{
"metric": "q_udpQueries",
"value": 82758686,
"value_prev": null,
"app_type": "powerdns"
},
{
"metric": "qc_hit",
"value": 116318482,
"value_prev": null,
"app_type": "powerdns"
},
{
"metric": "qc_miss",
"value": 132904846,
"value_prev": null,
"app_type": "powerdns"
},
{
"metric": "qsize",
"value": 0,
"value_prev": null,
"app_type": "powerdns"
},
{
"metric": "rec_answers",
"value": 0,
"value_prev": null,
"app_type": "powerdns"
},
{
"metric": "rec_questions",
"value": 0,
"value_prev": null,
"app_type": "powerdns"
},
{
"metric": "servfailPackets",
"value": 263453,
"value_prev": null,
"app_type": "powerdns"
}
]
}
}
}

10
tests/snmpsim/linux_powerdns-legacy.snmprec Normal file
View File

@@ -0,0 +1,10 @@
1.3.6.1.2.1.1.1.0|4|Linux server 3.10.0-693.5.2.el7.x86_64 #1 SMP Fri Oct 20 20:32:50 UTC 2017 x86_64
1.3.6.1.2.1.1.2.0|6|1.3.6.1.4.1.8072.3.2.10
1.3.6.1.2.1.1.3.0|67|77550514
1.3.6.1.2.1.1.4.0|4|<private>
1.3.6.1.2.1.1.5.0|4|<private>
1.3.6.1.2.1.1.6.0|4|<private>
1.3.6.1.2.1.25.1.1.0|67|77552962
1.3.6.1.4.1.8072.1.3.2.2.1.21.6.100.105.115.116.114.111|2|1
1.3.6.1.4.1.8072.1.3.2.2.1.21.8.112.111.119.101.114.100.110.115|2|1
1.3.6.1.4.1.8072.1.3.2.3.1.2.8.112.111.119.101.114.100.110.115|4x|3236333939340a3130333632300a34363930340a36360a32363735323936350a35363233383539320a31303031300a300a3131363332313530380a3133323930383230350a300a300a3236333436310a3334323239380a3334323333380a3130310a38323830363732310a38323736303735380a36393136343231390a36393134313337350a31333634323530320a31333631393338330a

10
tests/snmpsim/linux_powerdns-v1.snmprec Normal file
View File

@@ -0,0 +1,10 @@
1.3.6.1.2.1.1.1.0|4|Linux server 3.10.0-693.5.2.el7.x86_64 #1 SMP Fri Oct 20 20:32:50 UTC 2017 x86_64
1.3.6.1.2.1.1.2.0|6|1.3.6.1.4.1.8072.3.2.10
1.3.6.1.2.1.1.3.0|67|77550514
1.3.6.1.2.1.1.4.0|4|<private>
1.3.6.1.2.1.1.5.0|4|<private>
1.3.6.1.2.1.1.6.0|4|<private>
1.3.6.1.2.1.25.1.1.0|67|77552962
1.3.6.1.4.1.8072.1.3.2.2.1.21.6.100.105.115.116.114.111|2|1
1.3.6.1.4.1.8072.1.3.2.2.1.21.8.112.111.119.101.114.100.110.115|2|1
1.3.6.1.4.1.8072.1.3.2.3.1.2.8.112.111.119.101.114.100.110.115|4x|7b0a202020202276657273696f6e223a20312c0a20202020226572726f72223a20302c0a20202020226572726f72537472696e67223a2022222c0a202020202264617461223a207b0a202020202020202022636f72727570742d7061636b657473223a2022323633393836222c0a20202020202020202264656665727265642d63616368652d696e7365727473223a2022313033363138222c0a20202020202020202264656665727265642d63616368652d6c6f6f6b7570223a20223436393033222c0a20202020202020202264656665727265642d7061636b657463616368652d696e7365727473223a2022313338383239222c0a20202020202020202264656665727265642d7061636b657463616368652d6c6f6f6b7570223a202237333030222c0a202020202020202022646e737570646174652d616e7377657273223a202230222c0a202020202020202022646e737570646174652d6368616e676573223a202230222c0a202020202020202022646e737570646174652d71756572696573223a20223438383831222c0a202020202020202022646e737570646174652d72656675736564223a20223438383831222c0a202020202020202022696e636f6d696e672d6e6f74696669636174696f6e73223a20223532393135222c0a2020202020202020226f7665726c6f61642d64726f7073223a202230222c0a2020202020202020227061636b657463616368652d686974223a20223236373532343131222c0a2020202020202020227061636b657463616368652d6d697373223a20223536323337303838222c0a2020202020202020227061636b657463616368652d73697a65223a20223130313434222c0a20202020202020202271756572792d63616368652d686974223a2022313136333138343832222c0a20202020202020202271756572792d63616368652d6d697373223a2022313332393034383436222c0a20202020202020202271756572792d63616368652d73697a65223a2022353730222c0a20202020202020202272642d71756572696573223a2022313133303230222c0a202020202020202022726563757273696e672d616e7377657273223a202230222c0a202020202020202022726563757273696e672d7175657374696f6e73223a202230222c0a202020202020202022726563757273696f6e2d756e616e737765726564223a202230222c0a20202020202020202273656375726974792d737461747573223a202233222c0a202020202020202022736572766661696c2d7061636b657473223a2022323633343533222c0a2020202020202020227369676e617475726573223a202230222c0a2020202020202020227463702d616e7377657273223a2022333432323937222c0a2020202020202020227463702d616e73776572732d6279746573223a20223431373933343331222c0a2020202020202020227463702d71756572696573223a2022333432333337222c0a202020202020202022746370342d616e7377657273223a2022333139323631222c0a202020202020202022746370342d616e73776572732d6279746573223a20223337383939383436222c0a202020202020202022746370342d71756572696573223a2022333139333031222c0a202020202020202022746370362d616e7377657273223a20223233303336222c0a202020202020202022746370362d616e73776572732d6279746573223a202233383933353835222c0a202020202020202022746370362d71756572696573223a20223233303336222c0a20202020202020202274696d65646f75742d7061636b657473223a2022313031222c0a2020202020202020227564702d616e7377657273223a20223832383034363435222c0a2020202020202020227564702d616e73776572732d6279746573223a202236353038343633393231222c0a2020202020202020227564702d646f2d71756572696573223a20223632343234303039222c0a2020202020202020227564702d71756572696573223a20223832373538363836222c0a202020202020202022756470342d616e7377657273223a20223639313632353333222c0a202020202020202022756470342d616e73776572732d6279746573223a202235353038323133373832222c0a202020202020202022756470342d71756572696573223a20223639313339363931222c0a202020202020202022756470362d616e7377657273223a20223133363432313132222c0a202020202020202022756470362d616e73776572732d6279746573223a202231303030323530313339222c0a202020202020202022756470362d71756572696573223a20223133363138393935222c0a20202020202020202266642d7573616765223a20223235222c0a2020202020202020226b65792d63616368652d73697a65223a2022323334222c0a2020202020202020226c6174656e6379223a20223737222c0a2020202020202020226d6574612d63616368652d73697a65223a2022343633222c0a2020202020202020227173697a652d71223a202230222c0a2020202020202020227265616c2d6d656d6f72792d7573616765223a20223434353834393630222c0a2020202020202020227369676e61747572652d63616368652d73697a65223a202230222c0a2020202020202020227379732d6d736563223a20223230363535343537222c0a2020202020202020227564702d696e2d6572726f7273223a20223136393236222c0a2020202020202020227564702d6e6f706f72742d6572726f7273223a2022313435222c0a2020202020202020227564702d726563766275662d6572726f7273223a202230222c0a2020202020202020227564702d736e646275662d6572726f7273223a202230222c0a202020202020202022757074696d65223a20223138393332333738222c0a202020202020202022757365722d6d736563223a20223236323533313833220a202020207d0a7d0a