mirrors
/
munin-contrib
mirror of https://github.com/munin-monitoring/contrib.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Improve perlpod formatting for multiple plugins 

Escpecially the final marker ("=cut") was missing in these plugins.
This commit is contained in:
Lars Kruse 2020-10-06 00:29:38 +02:00
parent 743395a605
commit c6f88968d1
20 changed files with 198 additions and 142 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
plugins/change.org/changeorg_signature_count
View File

@ -7,24 +7,28 @@ You need a valid API key for this petition
=head2 CONFIGURATION =head2 CONFIGURATION
# Sample: Example:
[changeorg_signature_count]
env.APIkey xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx [changeorg_signature_count]
env.petitions 1727001 1727053 env.APIkey xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
env.petitions 1727001 1727053
=head1 AUTHOR =head1 AUTHOR
(c) 2017 Raphaël Droz <raphael.droz+floss@gmail.com> (c) 2017 Raphaël Droz <raphael.droz+floss@gmail.com>
General Public Licence v3 or later
=head1 LICENSE =head1 LICENSE
GPLv3 General Public Licence v3 or later
SPDX-License-Identifier: GPL-3.0-or-later
=head1 MAGIC MARKERS =head1 MAGIC MARKERS
#%# family=auto #%# family=auto
#%# capabilities=autoconf #%# capabilities=autoconf
=cut
''' '''
from sys import argv, exit from sys import argv, exit

12
plugins/docker/docker_
View File

@ -44,7 +44,7 @@ which if matched will exclude the matching containers from the memory and cpu gr
For example For example
env.EXCLUDE_CONTAINER_NAME runner env.EXCLUDE_CONTAINER_NAME runner
Would exclude all containers with the word "runner" in the name. Would exclude all containers with the word "runner" in the name.
@ -63,15 +63,17 @@ Would exclude all containers with the word "runner" in the name.
This section has been reverse-engineered from git logs This section has been reverse-engineered from git logs
* Codimp <contact@lithio.fr>: original rewrite * Codimp <contact@lithio.fr>: original rewrite
* Rowan Wookey <admin@rwky.net>: performance improvement * Rowan Wookey <admin@rwky.net>: performance improvement
* Olivier Mehani <shtrom@ssji.net>: Network support, ClientWrapper, gerenal
cleanup * Olivier Mehani <shtrom@ssji.net>: Network support, ClientWrapper, gerenal cleanup
=head1 MAGIC MARKERS =head1 MAGIC MARKERS
#%# family=auto #%# family=auto
#%# capabilities=autoconf suggest #%# capabilities=autoconf suggest
=cut
""" """
import os import os

20
plugins/git/gitlab_statistics
View File

@ -8,7 +8,7 @@ Plugin to monitor Gitlab status
=head1 INSTALLATION =head1 INSTALLATION
Usage: Place in /etc/munin/plugins/ (or link it there using ln -s) Place in /etc/munin/plugins/ (or link it there using ln -s)
=head1 CONFIGURATION =head1 CONFIGURATION
@ -23,23 +23,17 @@ Add this to your /etc/munin/plugin-conf.d/munin-node:
=back =back
=head1 HISTORY =head1 AUTHORS
2019-10-02: v 1.0 pcy <pcy.ulyssis.org>: created Copyright (C) 2019 pcy <pcy.ulyssis.org>
=head1 USAGE
Parameters understood:
config (required)
autoconf (optional - used by munin-config)
=head1 MAGIC MARKERS =head1 MAGIC MARKERS
#%# family=auto #%# family=auto
#%# capabilities=autoconf #%# capabilities=autoconf
"""
=cut
"""
import os import os
import json import json

7
plugins/http/vhost_requests_
View File

@ -5,8 +5,7 @@
=head1 NAME =head1 NAME
vhost_requests_ - Wildcard-plugin to monitor http requests by response status code vhost_requests_ - Wildcard-plugin to monitor http requests by response status code to a particular virtual host.
to a particular virtual host.
=head1 CONFIGURATION =head1 CONFIGURATION
@ -34,13 +33,13 @@ on a particular virtual host, link vhost_requests_<desired_access_log_filename>
E.g. E.g.
# ln -s /usr/share/munin/plugins/vhost_requests_ \ ln -s /usr/share/munin/plugins/vhost_requests_ /etc/munin/plugins/vhost_requests_host.org-access_log
/etc/munin/plugins/vhost_requests_host.org-access_log
=head1 AUTHOR =head1 AUTHOR
Roberto Rodriguez Roberto Rodriguez
=cut
END END
# This is the format that date will use to generate access_log like entries # This is the format that date will use to generate access_log like entries

7
plugins/lighttpd/lighttpd_
View File

@ -39,12 +39,17 @@ Copyright Igor Borodikhin
=head1 LICENSE =head1 LICENSE
GPLv3 GNU General Public License v3.0 only
SPDX-License-Identifier: GPL-3.0-only
=head1 MAGIC MARKERS =head1 MAGIC MARKERS
#%# family=contrib #%# family=contrib
#%# capabilities=autoconf suggest #%# capabilities=autoconf suggest
=cut
""" """
import os import os

29
plugins/luftdaten/feinstaubsensor
View File

@ -28,28 +28,41 @@ A <host> may be an IPv4 address, an IPv6 address (enclosed in square brackets) o
resolved via DNS. resolved via DNS.
Examples for <token>: Examples for <token>:
* 192.168.1.4
* foo=192.168.1.4 =over 4
* [fe80::1a:2b:3c:cafe]
* bar=[fe80::1a:2b:3c:cafe] =item 192.168.1.4
* feinstaubsensor-12345.local
* baz=feinstaubsensor-12345.local =item foo=192.168.1.4
=item [fe80::1a:2b:3c:cafe]
=item bar=[fe80::1a:2b:3c:cafe]
=item feinstaubsensor-12345.local
=item baz=feinstaubsensor-12345.local
=back
=head1 AUTHOR =head1 AUTHOR
Lars Kruse <devel@sumpfralle.de> Lars Kruse <devel@sumpfralle.de>
=head1 LICENSE =head1 LICENSE
GPLv3 GNU General Public License v3.0 or later
SPDX-License-Identifier: GPL-3.0-or-later
=head1 MAGIC MARKERS =head1 MAGIC MARKERS
#%# family=manual #%# family=manual
=cut
""" """
import collections import collections

12
plugins/mongodb/mongo_btree
View File

@ -1,11 +1,12 @@
#!/usr/bin/env python #!/usr/bin/env python
""" """
=head1 NAME =head1 NAME
MongoDB btree Plugin
mongo_btree - MongoDB btree Plugin
=head1 APPLICABLE SYSTEMS =head1 APPLICABLE SYSTEMS
Works until MongoDB 2.7. The "indexCounters" field was removed in 2.8 version. Works until MongoDB 2.7. The "indexCounters" field was removed in 2.8 version.
=head1 CONFIGURATION =head1 CONFIGURATION
@ -14,8 +15,11 @@
=head1 AUTHOR =head1 AUTHOR
Original script there : https://github.com/comerford/mongo-munin Original script there : https://github.com/comerford/mongo-munin
Doc added by Alban Espie-Guillon <alban.espie@alterway.fr>
Doc added by Alban Espie-Guillon <alban.espie@alterway.fr>
=cut
""" """
import urllib2 import urllib2

12
plugins/mongodb/mongo_conn
View File

@ -1,11 +1,12 @@
#!/usr/bin/env python #!/usr/bin/env python
""" """
=head1 NAME =head1 NAME
MongoDB connections Plugin
mongo_conn - MongoDB connections Plugin
=head1 APPLICABLE SYSTEMS =head1 APPLICABLE SYSTEMS
Works until MongoDB 3.6. The httpinterface was later removed. Works until MongoDB 3.6. The httpinterface was later removed.
=head1 CONFIGURATION =head1 CONFIGURATION
@ -14,8 +15,11 @@
=head1 AUTHOR =head1 AUTHOR
Original script there : https://github.com/comerford/mongo-munin Original script there : https://github.com/comerford/mongo-munin
Doc added by Alban Espie-Guillon <alban.espie@alterway.fr>
Doc added by Alban Espie-Guillon <alban.espie@alterway.fr>
=cut
""" """
import urllib2 import urllib2

33
plugins/mongodb/mongo_lag
View File

@ -1,20 +1,18 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
""" """
=head1 NAME =head1 NAME
MongoDB Replication Lag
Connects to a single mongo instance and retrieve mongo_lag - MongoDB Replication Lag
replication lag for all connected members.
Connects to a single mongo instance and retrieve replication lag for all connected members.
=head1 APPLICABLE SYSTEMS =head1 APPLICABLE SYSTEMS
MongoDB 3.X and 4.X with pymongo installed. MongoDB 3.X and 4.X with pymongo installed.
=head1 CONFIGURATION =head1 CONFIGURATION
munin-node.conf Default for host is 127.0.0.1 and port 27017 and will work without being defined:
defaults for host is 127.0.0.1 and port 27017
and will work without being defined :
[mongo_lag] [mongo_lag]
env.host 127.0.0.1 env.host 127.0.0.1
@ -24,16 +22,23 @@
=head1 AUTHOR =head1 AUTHOR
Stefan Andersen <stefan@stefanandersen.dk> Stefan Andersen <stefan@stefanandersen.dk>
Updated by Alban Espie-Guillon <alban.espie@alterway.fr>
Updated by Alban Espie-Guillon <alban.espie@alterway.fr>
=head1 LICENSE =head1 LICENSE
The Beer Ware License (Revision 42)
<alban.espie@alterway.fr> wrote this file. As long The Beer Ware License (Revision 42)
as you retain this notice you can do whatever you want <alban.espie@alterway.fr> wrote this file. As long
with this stuff. If we meet some day, and you think as you retain this notice you can do whatever you want
this stuff is worth it, you can buy me a beer in return. with this stuff. If we meet some day, and you think
this stuff is worth it, you can buy me a beer in return.
SPDX-License-Identifier: Beerware
=cut
""" """
import os import os
import sys import sys
import pymongo import pymongo

12
plugins/mongodb/mongo_lock
View File

@ -1,11 +1,12 @@
#!/usr/bin/env python #!/usr/bin/env python
""" """
=head1 NAME =head1 NAME
MongoDB lock Plugin
mongo_lock - MongoDB lock Plugin
=head1 APPLICABLE SYSTEMS =head1 APPLICABLE SYSTEMS
MongoDB 2.X. The "lockTime" field was removed in later versions. MongoDB 2.X. The "lockTime" field was removed in later versions.
=head1 CONFIGURATION =head1 CONFIGURATION
@ -14,8 +15,11 @@
=head1 AUTHOR =head1 AUTHOR
Original script there : https://github.com/comerford/mongo-munin Original script there : https://github.com/comerford/mongo-munin
Doc added by Alban Espie-Guillon <alban.espie@alterway.fr>
Doc added by Alban Espie-Guillon <alban.espie@alterway.fr>
=cut
""" """
import urllib2 import urllib2

19
plugins/mongodb/mongo_mem
View File

@ -1,17 +1,16 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
""" """
=head1 NAME =head1 NAME
MongoDB mem Plugin
mongo_mem - MongoDB memory Plugin
=head1 APPLICABLE SYSTEMS =head1 APPLICABLE SYSTEMS
MongoDB 3.X and 4.X with pymongo installed. MongoDB 3.X and 4.X with pymongo installed.
=head1 CONFIGURATION =head1 CONFIGURATION
munin-node.conf Default for host is 127.0.0.1 and port 27017 and will work without being defined:
defaults for host is 127.0.0.1 and port 27017
and will work without being defined :
[mongo_mem] [mongo_mem]
env.host 127.0.0.1 env.host 127.0.0.1
@ -20,16 +19,20 @@
env.password P@55w0rd env.password P@55w0rd
env.db dbname env.db dbname
or or
[mongodb_mem] [mongodb_mem]
env.MONGO_DB_URI mongodb://user:password@host:port/dbname env.MONGO_DB_URI mongodb://user:password@host:port/dbname
=head1 AUTHOR =head1 AUTHOR
Original script there : https://github.com/comerford/mongo-munin Original script there : https://github.com/comerford/mongo-munin
Updated by Alban Espie-Guillon <alban.espie@alterway.fr>
Updated by Alban Espie-Guillon <alban.espie@alterway.fr>
=cut
""" """
import sys import sys
import os import os
import pymongo import pymongo

19
plugins/mongodb/mongo_ops
View File

@ -1,17 +1,16 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
""" """
=head1 NAME =head1 NAME
MongoDB ops Plugin
mongo_ops - MongoDB ops Plugin
=head1 APPLICABLE SYSTEMS =head1 APPLICABLE SYSTEMS
MongoDB 3.X and 4.X with pymongo installed. MongoDB 3.X and 4.X with pymongo installed.
=head1 CONFIGURATION =head1 CONFIGURATION
munin-node.conf Default for host is 127.0.0.1 and port 27017 and will work without being defined:
defaults for host is 127.0.0.1 and port 27017
and will work without being defined :
[mongodb_ops] [mongodb_ops]
env.host 127.0.0.1 env.host 127.0.0.1
@ -20,16 +19,20 @@
env.password P@55w0rd env.password P@55w0rd
env.db dbname env.db dbname
or or
[mongodb_ops] [mongodb_ops]
env.MONGO_DB_URI mongodb://user:password@host:port/dbname env.MONGO_DB_URI mongodb://user:password@host:port/dbname
=head1 AUTHOR =head1 AUTHOR
Original script there : https://github.com/comerford/mongo-munin Original script there : https://github.com/comerford/mongo-munin
Updated by Alban Espie-Guillon <alban.espie@alterway.fr>
Updated by Alban Espie-Guillon <alban.espie@alterway.fr>
=cut
""" """
import sys import sys
import os import os
import pymongo import pymongo

29
plugins/mongodb/mongodb_conn
View File

@ -1,17 +1,16 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
""" """
=head1 NAME =head1 NAME
MongoDB Connection Count Plugin
mongodb_conn - MongoDB Connection Count Plugin
=head1 APPLICABLE SYSTEMS =head1 APPLICABLE SYSTEMS
MongoDB 3.X and 4.X with pymongo installed. MongoDB 3.X and 4.X with pymongo installed.
=head1 CONFIGURATION =head1 CONFIGURATION
munin-node.conf Default for host is 127.0.0.1 and port 27017 and will work without being defined:
defaults for host is 127.0.0.1 and port 27017
and will work without being defined :
[mongodb_conn] [mongodb_conn]
env.host 127.0.0.1 env.host 127.0.0.1
@ -21,16 +20,22 @@
=head1 AUTHOR =head1 AUTHOR
Alban Espie-Guillon <alban.espie@alterway.fr> Alban Espie-Guillon <alban.espie@alterway.fr>
based on Stefan Andersen <stefan@stefanandersen.dk> work.
based on Stefan Andersen <stefan@stefanandersen.dk> work.
=head1 LICENSE =head1 LICENSE
The Beer Ware License (Revision 42) The Beer Ware License (Revision 42)
<alban.espie@alterway.fr> wrote this file. As long <alban.espie@alterway.fr> wrote this file. As long
as you retain this notice you can do whatever you want as you retain this notice you can do whatever you want
with this stuff. If we meet some day, and you think with this stuff. If we meet some day, and you think
this stuff is worth it, you can buy me a beer in return. this stuff is worth it, you can buy me a beer in return.
SPDX-License-Identifier: Beerware
=cut
""" """
import os import os
import sys import sys
import pymongo import pymongo

19
plugins/mongodb/mongodb_docs
View File

@ -1,17 +1,16 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
""" """
=head1 NAME =head1 NAME
MongoDB docs Plugin
mongodb_docs - MongoDB docs Plugin
=head1 APPLICABLE SYSTEMS =head1 APPLICABLE SYSTEMS
MongoDB 3.X and 4.X with pymongo installed. MongoDB 3.X and 4.X with pymongo installed.
=head1 CONFIGURATION =head1 CONFIGURATION
munin-node.conf Default for host is 127.0.0.1 and port 27017 and will work without being defined:
defaults for host is 127.0.0.1 and port 27017
and will work without being defined :
[mongodb_docs] [mongodb_docs]
env.host 127.0.0.1 env.host 127.0.0.1
@ -20,16 +19,20 @@
env.password P@55w0rd env.password P@55w0rd
env.db dbname env.db dbname
or or
[mongodb_docs] [mongodb_docs]
env.MONGO_DB_URI mongodb://user:password@host:port/dbname env.MONGO_DB_URI mongodb://user:password@host:port/dbname
=head1 AUTHOR =head1 AUTHOR
Original script there : https://github.com/comerford/mongo-munin Original script there : https://github.com/comerford/mongo-munin
Updated by Alban Espie-Guillon <alban.espie@alterway.fr>
Updated by Alban Espie-Guillon <alban.espie@alterway.fr>
=cut
""" """
import sys import sys
import os import os
import pymongo import pymongo

22
plugins/mysql/mysql_audit
View File

@ -2,9 +2,9 @@
# -*- python -*- # -*- python -*-
""" """
=head1 INTRODUCTION =head1 NAME
Plugin to monitor the MySQL audit log connection count mysql_audit - Plugin to monitor the MySQL audit log connection count
=head1 APPLICABLE SYSTEMS =head1 APPLICABLE SYSTEMS
@ -41,22 +41,18 @@ Add this to your /etc/munin/plugin-conf.d/munin-node:
=back =back
=head1 HISTORY =head1 AUTHORS
2017-11-03: v 1.0 Bert Van de Poel <bert@bhack.net>: created Copyright (C) 2017 Bert Van de Poel <bert@bhack.net>
2020-07-19: v 1.1 pcy <pcy@ulyssis.org>: added config options
=head1 USAGE Copyright (C) 2019 pcy <pcy@ulyssis.org>
Parameters understood:
config (required)
autoconf (optional - used by munin-config)
=head1 MAGIC MARKERS =head1 MAGIC MARKERS
#%# family=auto #%# family=auto
#%# capabilities=autoconf #%# capabilities=autoconf
=cut
""" """

17
plugins/mysql/mysql_disk_by_prefix
View File

@ -32,21 +32,16 @@ Add this to your /etc/munin/plugin-conf.d/munin-node:
=back =back
=head1 HISTORY =head1 AUTHORS
2019-07-25: v 1.0 pcy <pcy.ulyssis.org>: created Copyright (C) 2019 pcy <pcy.ulyssis.org>
=head1 USAGE
Parameters understood:
config (required)
autoconf (optional - used by munin-config)
=head1 MAGIC MARKERS =head1 MAGIC MARKERS
#%# family=auto #%# family=auto
#%# capabilities=autoconf #%# capabilities=autoconf
=cut
""" """

1
plugins/puppet/puppetdb
View File

@ -65,6 +65,7 @@ Copyright (c) 2020, Gabriel Filion, gabster@lelutin.ca
This code is licensed under GPLv3+ This code is licensed under GPLv3+
=cut
""" """
import os import os

21
plugins/solr/solr4_
View File

@ -2,25 +2,27 @@
""" """
=head1 NAME =head1 NAME
Solr 4.* munin graph plugin solr4_ - Solr 4.* munin graph plugin
=head1 CONFIGURATION =head1 CONFIGURATION
Plugin configuration parameters: Plugin configuration parameters:
[solr_*] [solr_*]
env.host_port <host:port> env.host_port <host:port>
env.url <default /solr> env.url <default /solr>
env.qpshandler_<handlerlabel> <handlerpath> env.qpshandler_<handlerlabel> <handlerpath>
Example: Example:
[solr_*]
env.host_port solrhost:8080 [solr_*]
env.url /solr env.host_port solrhost:8080
env.qpshandler_select /select env.url /solr
env.qpshandler_select /select
Install plugins: Install plugins:
ln -s /usr/share/munin/plugins/solr_.py /etc/munin/plugins/solr_numdocs_core_1 ln -s /usr/share/munin/plugins/solr_.py /etc/munin/plugins/solr_numdocs_core_1
ln -s /usr/share/munin/plugins/solr_.py /etc/munin/plugins/solr_requesttimes_select ln -s /usr/share/munin/plugins/solr_.py /etc/munin/plugins/solr_requesttimes_select
ln -s /usr/share/munin/plugins/solr_.py /etc/munin/plugins/solr_qps ln -s /usr/share/munin/plugins/solr_.py /etc/munin/plugins/solr_qps
@ -56,6 +58,7 @@ DEALINGS IN THE SOFTWARE.
Project repo: https://github.com/averni/munin-solr Project repo: https://github.com/averni/munin-solr
=cut
""" """

6
plugins/systemd/timesync_status
View File

@ -44,7 +44,11 @@ Bert Peters <bert@bertptrs.nl>
=head1 LICENSE =head1 LICENSE
GPLv2 GNU General Public License v2.0 only
SPDX-License-Identifier: LGPL-2.0-only
=cut
''' '''

23
plugins/znc/znc_logs.py
View File

@ -2,24 +2,33 @@
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
''' '''
=head1 NAME =head1 NAME
znc_logs znc_logs
=head1 DESCRIPTION =head1 DESCRIPTION
Shows lines/minute in today's znc-logs Shows lines/minute in today's znc-logs
=head2 CONFIGURATION =head2 CONFIGURATION
[znc_logs]
user znc # or any other user/group that can read the znclog-folder [znc_logs]
group znc user znc # or any other user/group that can read the znclog-folder
env.logdir /var/lib/znc/moddata/log/ # path to the GLOBAL log-folder with a "/" at the end group znc
env.expire 0 # Keep channel names forever - OR - env.logdir /var/lib/znc/moddata/log/ # path to the GLOBAL log-folder with a "/" at the end
env.expire 1 # Forget channel names from last run env.expire 0 # Keep channel names forever - OR -
env.expire 1 # Forget channel names from last run
=head1 COPYRIGHT =head1 COPYRIGHT
GPL VERSION 3
GNU General Public License v3.0 only
SPDX-License-Identifier: GPL-3.0-only
=head1 AUTHOR =head1 AUTHOR
Thor77 <thor77[at]thor77.org> Thor77 <thor77[at]thor77.org>
=cut
''' '''
import json import json
import os, sys, time import os, sys, time