Collection of CheckMK checks (see https://checkmk.com/). All checks and plugins are provided as is. Absolutely no warranty. Send any comments to thl-cmk[at]outlook[dot]com

Skip to content
Snippets Groups Projects
Commit 8e09046a authored by thl-cmk's avatar thl-cmk :flag_na:
Browse files

Update CONTRIBUTING.md

parent 057600ea
No related branches found
No related tags found
No related merge requests found
......@@ -9,39 +9,142 @@ Please include:
- the version of the plugin
- the crash report (if any)
For active checks I might need the output of the check command. I.e.
```
~$ ./local/lib/nagios/plugins/check_ntp -H ares
Stratum: 3, Reference ID: 194.25.134.196, Time: Sun Apr 7 13:38:52 2024
....
| ntp_offset=-0.005115509033203125;0.2;0.5; ntp_delay=0.02794170379638672;0.2;0.5; ntp_root_dispersion=0.0051116943359375;200;500;
```
For agent based plugins I might need also the agent output of the plugin.
```
$ /omd/sites/build/local/share/check_mk/agents/special/agent_cisco_meraki Meraki_Cloud
<<<cisco_meraki_org_organisations:sep(0)>>>
...
...
...
```
$ sudo /usr/lib/check_mk_agent/plugins/unbound
<<<unbound:sep(61)>>>
thread0.num.queries=3246
thread0.num.queries_ip_ratelimited=0
thread0.num.cachehits=1896
thread0.num.cachemiss=1350
thread0.num.prefetch=1636
thread0.num.expired=0
thread0.num.recursivereplies=1350
thread0.requestlist.avg=0.637307
thread0.requestlist.max=8
thread0.requestlist.overwritten=0
thread0.requestlist.exceeded=0
thread0.requestlist.current.all=0
thread0.requestlist.current.user=0
thread0.recursion.time.avg=0.087345
thread0.recursion.time.median=0.0432183
thread0.tcpusage=0
total.num.queries=3246
total.num.queries_ip_ratelimited=0
total.num.cachehits=1896
total.num.cachemiss=1350
total.num.prefetch=1636
total.num.expired=0
total.num.recursivereplies=1350
total.requestlist.avg=0.637307
total.requestlist.max=8
total.requestlist.overwritten=0
total.requestlist.exceeded=0
total.requestlist.current.all=0
total.requestlist.current.user=0
total.recursion.time.avg=0.087345
total.recursion.time.median=0.0432183
total.tcpusage=0
time.now=1713708052.356086
time.up=15664.323415
time.elapsed=15659.837033
mem.cache.rrset=947344
mem.cache.message=292927
mem.mod.iterator=16588
mem.mod.validator=161391
mem.mod.respip=0
mem.mod.subnet=74504
mem.streamwait=0
mem.http.query_buffer=0
mem.http.response_buffer=0
histogram.000000.000000.to.000000.000001=12
histogram.000000.000001.to.000000.000002=0
histogram.000000.000002.to.000000.000004=0
histogram.000000.000004.to.000000.000008=0
histogram.000000.000008.to.000000.000016=0
histogram.000000.000016.to.000000.000032=0
histogram.000000.000032.to.000000.000064=0
histogram.000000.000064.to.000000.000128=0
histogram.000000.000128.to.000000.000256=0
histogram.000000.000256.to.000000.000512=0
histogram.000000.000512.to.000000.001024=0
histogram.000000.001024.to.000000.002048=0
histogram.000000.002048.to.000000.004096=0
histogram.000000.004096.to.000000.008192=0
histogram.000000.008192.to.000000.016384=26
histogram.000000.016384.to.000000.032768=519
histogram.000000.032768.to.000000.065536=370
histogram.000000.065536.to.000000.131072=182
histogram.000000.131072.to.000000.262144=161
histogram.000000.262144.to.000000.524288=56
histogram.000000.524288.to.000001.000000=21
histogram.000001.000000.to.000002.000000=3
histogram.000002.000000.to.000004.000000=0
histogram.000004.000000.to.000008.000000=0
histogram.000008.000000.to.000016.000000=0
histogram.000016.000000.to.000032.000000=0
histogram.000032.000000.to.000064.000000=0
histogram.000064.000000.to.000128.000000=0
histogram.000128.000000.to.000256.000000=0
histogram.000256.000000.to.000512.000000=0
histogram.000512.000000.to.001024.000000=0
histogram.001024.000000.to.002048.000000=0
histogram.002048.000000.to.004096.000000=0
histogram.004096.000000.to.008192.000000=0
histogram.008192.000000.to.016384.000000=0
histogram.016384.000000.to.032768.000000=0
histogram.032768.000000.to.065536.000000=0
histogram.065536.000000.to.131072.000000=0
histogram.131072.000000.to.262144.000000=0
histogram.262144.000000.to.524288.000000=0
num.query.type.A=2583
num.query.type.CNAME=4
num.query.type.SOA=4
num.query.type.AAAA=502
num.query.type.SRV=9
num.query.type.TYPE65=144
num.query.class.IN=3246
num.query.opcode.QUERY=3246
num.query.tcp=29
num.query.tcpout=1
num.query.tls=0
num.query.tls.resume=0
num.query.ipv6=0
num.query.https=0
num.query.flags.QR=0
num.query.flags.AA=0
num.query.flags.TC=0
num.query.flags.RD=3246
num.query.flags.RA=0
num.query.flags.Z=0
num.query.flags.AD=0
num.query.flags.CD=0
num.query.edns.present=1963
num.query.edns.DO=0
num.answer.rcode.NOERROR=3239
num.answer.rcode.FORMERR=0
num.answer.rcode.SERVFAIL=0
num.answer.rcode.NXDOMAIN=7
num.answer.rcode.NOTIMPL=0
num.answer.rcode.REFUSED=0
num.answer.rcode.nodata=585
num.query.ratelimited=0
num.answer.secure=25
num.answer.bogus=0
num.rrset.bogus=0
num.query.aggressive.NOERROR=0
num.query.aggressive.NXDOMAIN=0
unwanted.queries=0
unwanted.replies=0
msg.cache.count=735
rrset.cache.count=2768
infra.cache.count=689
key.cache.count=131
num.query.authzone.up=0
num.query.authzone.down=0
num.query.subnet=0
num.query.subnet_cache=0
<<<>>>
For SNMP based plugins I migth need a snmpwalk fom the device in question. This must contain
```
.1.3.6.1.2.1.1.1 sysDescr
.1.3.6.1.2.1.1.2 sysObjectID
```
and all the SNMP OIDs used in the plugin.
If you run the snmpwalk command, please uses these options -ObentU in addition to your snmp options like community, version etc.
For example:
```
snmpwalk -v2c -c public -ObentU 10.10.10.10 .1.3.6.1.2.1.1.1 > hostname.snmpwalk
snmpwalk -v2c -c public -ObentU 10.10.10.10 .1.3.6.1.2.1.1.2 >> hostname.snmpwalk
snmpwalk -v2c -c public -ObentU 10.10.10.10 .1.0.8802.1.1.2.1.4.1.1 >> hostname.snmpwalk
snmpwalk -v2c -c public -ObentU 10.10.10.10 .1.0.8802.1.1.2.1.3.7.1.3 >> hostname.snmpwalk
```
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment