Projet

Général

Profil

Révision c6f88968

IDc6f88968d1a44c463aaeb9af77aba70cad860e7c
Parent 743395a6
Enfant 0253df6f

Ajouté par Lars Kruse il y a environ 5 ans

Improve perlpod formatting for multiple plugins

Escpecially the final marker ("=cut") was missing in these plugins.

Voir les différences:

plugins/change.org/changeorg_signature_count
7 7

  
8 8
=head2 CONFIGURATION
9 9

  
10
# Sample:
11
[changeorg_signature_count]
12
	env.APIkey xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
13
	env.petitions 1727001 1727053
10
Example:
11

  
12
 [changeorg_signature_count]
13
 env.APIkey xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
14
 env.petitions 1727001 1727053
14 15

  
15 16
=head1 AUTHOR
16 17

  
17 18
(c) 2017 Raphaël Droz <raphael.droz+floss@gmail.com>
18
General Public Licence v3 or later
19 19

  
20 20
=head1 LICENSE
21 21

  
22
GPLv3
22
General Public Licence v3 or later
23

  
24
SPDX-License-Identifier: GPL-3.0-or-later
23 25

  
24 26
=head1 MAGIC MARKERS
25 27

  
26
#%# family=auto
27
#%# capabilities=autoconf
28
 #%# family=auto
29
 #%# capabilities=autoconf
30

  
31
=cut
28 32
'''
29 33

  
30 34
from sys import argv, exit
plugins/docker/docker_
44 44

  
45 45
For example
46 46

  
47
env.EXCLUDE_CONTAINER_NAME runner
47
 env.EXCLUDE_CONTAINER_NAME runner
48 48

  
49 49
Would exclude all containers with the word "runner" in the name.
50 50

  
......
63 63
This section has been reverse-engineered from git logs
64 64

  
65 65
* Codimp <contact@lithio.fr>: original rewrite
66

  
66 67
* Rowan Wookey <admin@rwky.net>: performance improvement
67
* Olivier Mehani <shtrom@ssji.net>: Network support, ClientWrapper, gerenal
68
  cleanup
68

  
69
* Olivier Mehani <shtrom@ssji.net>: Network support, ClientWrapper, gerenal cleanup
69 70

  
70 71
=head1 MAGIC MARKERS
71 72

  
72
#%# family=auto
73
#%# capabilities=autoconf suggest
73
 #%# family=auto
74
 #%# capabilities=autoconf suggest
74 75

  
76
=cut
75 77
"""
76 78

  
77 79
import os
plugins/git/gitlab_statistics
8 8

  
9 9
=head1 INSTALLATION
10 10

  
11
Usage: Place in /etc/munin/plugins/ (or link it there using ln -s)
11
Place in /etc/munin/plugins/ (or link it there using ln -s)
12 12

  
13 13
=head1 CONFIGURATION
14 14

  
......
23 23

  
24 24
=back
25 25

  
26
=head1 HISTORY
26
=head1 AUTHORS
27 27

  
28
2019-10-02: v 1.0 pcy <pcy.ulyssis.org>: created
29

  
30
=head1 USAGE
31

  
32
Parameters understood:
33

  
34
  config   (required)
35
  autoconf (optional - used by munin-config)
28
Copyright (C) 2019 pcy <pcy.ulyssis.org>
36 29

  
37 30
=head1 MAGIC MARKERS
38 31

  
39
#%# family=auto
40
#%# capabilities=autoconf
41
"""
32
 #%# family=auto
33
 #%# capabilities=autoconf
42 34

  
35
=cut
36
"""
43 37

  
44 38
import os
45 39
import json
plugins/http/vhost_requests_
5 5

  
6 6
=head1 NAME
7 7

  
8
vhost_requests_ - Wildcard-plugin to monitor http requests by response status code
9
to a particular virtual host.
8
vhost_requests_ - Wildcard-plugin to monitor http requests by response status code to a particular virtual host.
10 9

  
11 10
=head1 CONFIGURATION
12 11

  
......
34 33

  
35 34
E.g.
36 35

  
37
#  ln -s /usr/share/munin/plugins/vhost_requests_ \
38
        /etc/munin/plugins/vhost_requests_host.org-access_log
36
 ln -s /usr/share/munin/plugins/vhost_requests_ /etc/munin/plugins/vhost_requests_host.org-access_log
39 37

  
40 38
=head1 AUTHOR
41 39

  
42 40
Roberto Rodriguez
43 41

  
42
=cut
44 43
END
45 44

  
46 45
# This is the format that date will use to generate access_log like entries
plugins/lighttpd/lighttpd_
39 39

  
40 40
=head1 LICENSE
41 41

  
42
GPLv3
42
GNU General Public License v3.0 only
43

  
44
SPDX-License-Identifier: GPL-3.0-only
43 45

  
44 46

  
45 47
=head1 MAGIC MARKERS
48

  
46 49
  #%# family=contrib
47 50
  #%# capabilities=autoconf suggest
51

  
52
=cut
48 53
"""
49 54

  
50 55
import os
plugins/luftdaten/feinstaubsensor
28 28
resolved via DNS.
29 29

  
30 30
Examples for <token>:
31
  * 192.168.1.4
32
  * foo=192.168.1.4
33
  * [fe80::1a:2b:3c:cafe]
34
  * bar=[fe80::1a:2b:3c:cafe]
35
  * feinstaubsensor-12345.local
36
  * baz=feinstaubsensor-12345.local
31

  
32
=over 4
33

  
34
=item 192.168.1.4
35

  
36
=item foo=192.168.1.4
37

  
38
=item [fe80::1a:2b:3c:cafe]
39

  
40
=item bar=[fe80::1a:2b:3c:cafe]
41

  
42
=item feinstaubsensor-12345.local
43

  
44
=item baz=feinstaubsensor-12345.local
45

  
46
=back
37 47

  
38 48

  
39 49
=head1 AUTHOR
40 50

  
41
  Lars Kruse <devel@sumpfralle.de>
51
Lars Kruse <devel@sumpfralle.de>
42 52

  
43 53

  
44 54
=head1 LICENSE
45 55

  
46
  GPLv3
56
GNU General Public License v3.0 or later
57

  
58
SPDX-License-Identifier: GPL-3.0-or-later
47 59

  
48 60

  
49 61
=head1 MAGIC MARKERS
50 62

  
51 63
  #%# family=manual
52 64

  
65
=cut
53 66
"""
54 67

  
55 68
import collections
plugins/mongodb/mongo_btree
1 1
#!/usr/bin/env python
2 2
"""
3 3
=head1 NAME
4
    MongoDB btree Plugin
4

  
5
mongo_btree - MongoDB btree Plugin
5 6

  
6 7
=head1 APPLICABLE SYSTEMS
7 8

  
8
    Works until MongoDB 2.7. The "indexCounters" field was removed in 2.8 version.
9
Works until MongoDB 2.7. The "indexCounters" field was removed in 2.8 version.
9 10

  
10 11
=head1 CONFIGURATION
11 12

  
......
14 15

  
15 16
=head1 AUTHOR
16 17

  
17
    Original script there : https://github.com/comerford/mongo-munin
18
    Doc added by Alban Espie-Guillon <alban.espie@alterway.fr>
18
Original script there : https://github.com/comerford/mongo-munin
19

  
20
Doc added by Alban Espie-Guillon <alban.espie@alterway.fr>
21

  
22
=cut
19 23
"""
20 24

  
21 25
import urllib2
plugins/mongodb/mongo_conn
1 1
#!/usr/bin/env python
2 2
"""
3 3
=head1 NAME
4
    MongoDB connections Plugin
4

  
5
mongo_conn - MongoDB connections Plugin
5 6

  
6 7
=head1 APPLICABLE SYSTEMS
7 8

  
8
    Works until MongoDB 3.6. The httpinterface was later removed.
9
Works until MongoDB 3.6. The httpinterface was later removed.
9 10

  
10 11
=head1 CONFIGURATION
11 12

  
......
14 15

  
15 16
=head1 AUTHOR
16 17

  
17
    Original script there : https://github.com/comerford/mongo-munin
18
    Doc added by Alban Espie-Guillon <alban.espie@alterway.fr>
18
Original script there : https://github.com/comerford/mongo-munin
19

  
20
Doc added by Alban Espie-Guillon <alban.espie@alterway.fr>
21

  
22
=cut
19 23
"""
20 24

  
21 25
import urllib2
plugins/mongodb/mongo_lag
1 1
#!/usr/bin/env python3
2 2
"""
3 3
=head1 NAME
4
    MongoDB Replication Lag
5 4

  
6
    Connects to a single mongo instance and retrieve
7
    replication lag for all connected members.
5
mongo_lag - MongoDB Replication Lag
6

  
7
Connects to a single mongo instance and retrieve replication lag for all connected members.
8 8

  
9 9
=head1 APPLICABLE SYSTEMS
10 10

  
11
    MongoDB 3.X and 4.X with pymongo installed.
11
MongoDB 3.X and 4.X with pymongo installed.
12 12

  
13 13
=head1 CONFIGURATION
14 14

  
15
    munin-node.conf
16
    defaults for host is 127.0.0.1 and port 27017
17
    and will work without being defined :
15
Default for host is 127.0.0.1 and port 27017 and will work without being defined:
18 16

  
19 17
    [mongo_lag]
20 18
    env.host 127.0.0.1
......
24 22

  
25 23
=head1 AUTHOR
26 24

  
27
    Stefan Andersen <stefan@stefanandersen.dk>
28
    Updated by Alban Espie-Guillon <alban.espie@alterway.fr>
25
Stefan Andersen <stefan@stefanandersen.dk>
26

  
27
Updated by Alban Espie-Guillon <alban.espie@alterway.fr>
29 28

  
30 29
=head1 LICENSE
31
    The Beer Ware License (Revision 42)
32
    <alban.espie@alterway.fr> wrote this file. As long
33
    as you retain this notice you can do whatever you want
34
    with this stuff. If we meet some day, and you think
35
    this stuff is worth it, you can buy me a beer in return.
30

  
31
The Beer Ware License (Revision 42)
32
<alban.espie@alterway.fr> wrote this file. As long
33
as you retain this notice you can do whatever you want
34
with this stuff. If we meet some day, and you think
35
this stuff is worth it, you can buy me a beer in return.
36

  
37
SPDX-License-Identifier: Beerware
38

  
39
=cut
36 40
"""
41

  
37 42
import os
38 43
import sys
39 44
import pymongo
plugins/mongodb/mongo_lock
1 1
#!/usr/bin/env python
2 2
"""
3 3
=head1 NAME
4
    MongoDB lock Plugin
4

  
5
mongo_lock - MongoDB lock Plugin
5 6

  
6 7
=head1 APPLICABLE SYSTEMS
7 8

  
8
    MongoDB 2.X. The "lockTime" field was removed in later versions.
9
MongoDB 2.X. The "lockTime" field was removed in later versions.
9 10

  
10 11
=head1 CONFIGURATION
11 12

  
......
14 15

  
15 16
=head1 AUTHOR
16 17

  
17
    Original script there : https://github.com/comerford/mongo-munin
18
    Doc added by Alban Espie-Guillon <alban.espie@alterway.fr>
18
Original script there : https://github.com/comerford/mongo-munin
19

  
20
Doc added by Alban Espie-Guillon <alban.espie@alterway.fr>
21

  
22
=cut
19 23
"""
20 24

  
21 25
import urllib2
plugins/mongodb/mongo_mem
1 1
#!/usr/bin/env python3
2 2
"""
3 3
=head1 NAME
4
    MongoDB mem Plugin
4

  
5
mongo_mem - MongoDB memory Plugin
5 6

  
6 7
=head1 APPLICABLE SYSTEMS
7 8

  
8
    MongoDB 3.X and 4.X with pymongo installed.
9
MongoDB 3.X and 4.X with pymongo installed.
9 10

  
10 11
=head1 CONFIGURATION
11 12

  
12
    munin-node.conf
13
    defaults for host is 127.0.0.1 and port 27017
14
    and will work without being defined :
13
Default for host is 127.0.0.1 and port 27017 and will work without being defined:
15 14

  
16 15
    [mongo_mem]
17 16
    env.host 127.0.0.1
......
20 19
    env.password P@55w0rd
21 20
    env.db dbname
22 21

  
23
    or
22
or
24 23

  
25 24
    [mongodb_mem]
26 25
    env.MONGO_DB_URI mongodb://user:password@host:port/dbname
27 26

  
28 27
=head1 AUTHOR
29 28

  
30
    Original script there : https://github.com/comerford/mongo-munin
31
    Updated by Alban Espie-Guillon <alban.espie@alterway.fr>
29
Original script there : https://github.com/comerford/mongo-munin
30

  
31
Updated by Alban Espie-Guillon <alban.espie@alterway.fr>
32

  
33
=cut
32 34
"""
35

  
33 36
import sys
34 37
import os
35 38
import pymongo
plugins/mongodb/mongo_ops
1 1
#!/usr/bin/env python3
2 2
"""
3 3
=head1 NAME
4
    MongoDB ops Plugin
4

  
5
mongo_ops - MongoDB ops Plugin
5 6

  
6 7
=head1 APPLICABLE SYSTEMS
7 8

  
8
    MongoDB 3.X and 4.X with pymongo installed.
9
MongoDB 3.X and 4.X with pymongo installed.
9 10

  
10 11
=head1 CONFIGURATION
11 12

  
12
    munin-node.conf
13
    defaults for host is 127.0.0.1 and port 27017
14
    and will work without being defined :
13
Default for host is 127.0.0.1 and port 27017 and will work without being defined:
15 14

  
16 15
    [mongodb_ops]
17 16
    env.host 127.0.0.1
......
20 19
    env.password P@55w0rd
21 20
    env.db dbname
22 21

  
23
    or
22
or
24 23

  
25 24
    [mongodb_ops]
26 25
    env.MONGO_DB_URI mongodb://user:password@host:port/dbname
27 26

  
28 27
=head1 AUTHOR
29 28

  
30
    Original script there : https://github.com/comerford/mongo-munin
31
    Updated by Alban Espie-Guillon <alban.espie@alterway.fr>
29
Original script there : https://github.com/comerford/mongo-munin
30

  
31
Updated by Alban Espie-Guillon <alban.espie@alterway.fr>
32

  
33
=cut
32 34
"""
35

  
33 36
import sys
34 37
import os
35 38
import pymongo
plugins/mongodb/mongodb_conn
1 1
#!/usr/bin/env python3
2 2
"""
3 3
=head1 NAME
4
    MongoDB Connection Count Plugin
4

  
5
mongodb_conn - MongoDB Connection Count Plugin
5 6

  
6 7
=head1 APPLICABLE SYSTEMS
7 8

  
8
    MongoDB 3.X and 4.X with pymongo installed.
9
MongoDB 3.X and 4.X with pymongo installed.
9 10

  
10 11
=head1 CONFIGURATION
11 12

  
12
    munin-node.conf
13
    defaults for host is 127.0.0.1 and port 27017
14
    and will work without being defined :
13
Default for host is 127.0.0.1 and port 27017 and will work without being defined:
15 14

  
16 15
    [mongodb_conn]
17 16
    env.host 127.0.0.1
......
21 20

  
22 21
=head1 AUTHOR
23 22

  
24
    Alban Espie-Guillon <alban.espie@alterway.fr>
25
    based on Stefan Andersen <stefan@stefanandersen.dk> work.
23
Alban Espie-Guillon <alban.espie@alterway.fr>
24

  
25
based on Stefan Andersen <stefan@stefanandersen.dk> work.
26 26

  
27 27
=head1 LICENSE
28
    The Beer Ware License (Revision 42)
29
    <alban.espie@alterway.fr> wrote this file. As long
30
    as you retain this notice you can do whatever you want
31
    with this stuff. If we meet some day, and you think
32
    this stuff is worth it, you can buy me a beer in return.
28
The Beer Ware License (Revision 42)
29
<alban.espie@alterway.fr> wrote this file. As long
30
as you retain this notice you can do whatever you want
31
with this stuff. If we meet some day, and you think
32
this stuff is worth it, you can buy me a beer in return.
33

  
34
SPDX-License-Identifier: Beerware
35

  
36
=cut
33 37
"""
38

  
34 39
import os
35 40
import sys
36 41
import pymongo
plugins/mongodb/mongodb_docs
1 1
#!/usr/bin/env python3
2 2
"""
3 3
=head1 NAME
4
    MongoDB docs Plugin
4

  
5
mongodb_docs - MongoDB docs Plugin
5 6

  
6 7
=head1 APPLICABLE SYSTEMS
7 8

  
8
    MongoDB 3.X and 4.X with pymongo installed.
9
MongoDB 3.X and 4.X with pymongo installed.
9 10

  
10 11
=head1 CONFIGURATION
11 12

  
12
    munin-node.conf
13
    defaults for host is 127.0.0.1 and port 27017
14
    and will work without being defined :
13
Default for host is 127.0.0.1 and port 27017 and will work without being defined:
15 14

  
16 15
    [mongodb_docs]
17 16
    env.host 127.0.0.1
......
20 19
    env.password P@55w0rd
21 20
    env.db dbname
22 21

  
23
    or
22
or
24 23

  
25 24
    [mongodb_docs]
26 25
    env.MONGO_DB_URI mongodb://user:password@host:port/dbname
27 26

  
28 27
=head1 AUTHOR
29 28

  
30
    Original script there : https://github.com/comerford/mongo-munin
31
    Updated by Alban Espie-Guillon <alban.espie@alterway.fr>
29
Original script there : https://github.com/comerford/mongo-munin
30

  
31
Updated by Alban Espie-Guillon <alban.espie@alterway.fr>
32

  
33
=cut
32 34
"""
35

  
33 36
import sys
34 37
import os
35 38
import pymongo
plugins/mysql/mysql_audit
2 2
# -*- python -*-
3 3

  
4 4
"""
5
=head1 INTRODUCTION
5
=head1 NAME
6 6

  
7
Plugin to monitor the MySQL audit log connection count
7
mysql_audit - Plugin to monitor the MySQL audit log connection count
8 8

  
9 9
=head1 APPLICABLE SYSTEMS
10 10

  
......
41 41

  
42 42
=back
43 43

  
44
=head1 HISTORY
44
=head1 AUTHORS
45 45

  
46
2017-11-03: v 1.0 Bert Van de Poel <bert@bhack.net>: created
47
2020-07-19: v 1.1 pcy <pcy@ulyssis.org>: added config options
46
Copyright (C) 2017 Bert Van de Poel <bert@bhack.net>
48 47

  
49
=head1 USAGE
50

  
51
Parameters understood:
52

  
53
  config   (required)
54
  autoconf (optional - used by munin-config)
48
Copyright (C) 2019 pcy <pcy@ulyssis.org>
55 49

  
56 50
=head1 MAGIC MARKERS
57 51

  
58
#%# family=auto
59
#%# capabilities=autoconf
52
 #%# family=auto
53
 #%# capabilities=autoconf
54

  
55
=cut
60 56
"""
61 57

  
62 58

  
plugins/mysql/mysql_disk_by_prefix
32 32

  
33 33
=back
34 34

  
35
=head1 HISTORY
35
=head1 AUTHORS
36 36

  
37
2019-07-25: v 1.0 pcy <pcy.ulyssis.org>: created
38

  
39
=head1 USAGE
40

  
41
Parameters understood:
42

  
43
  config   (required)
44
  autoconf (optional - used by munin-config)
37
Copyright (C) 2019 pcy <pcy.ulyssis.org>
45 38

  
46 39
=head1 MAGIC MARKERS
47 40

  
48
#%# family=auto
49
#%# capabilities=autoconf
41
 #%# family=auto
42
 #%# capabilities=autoconf
43

  
44
=cut
50 45
"""
51 46

  
52 47

  
plugins/puppet/puppetdb
65 65

  
66 66
This code is licensed under GPLv3+
67 67

  
68
=cut
68 69
"""
69 70

  
70 71
import os
plugins/solr/solr4_
2 2
"""
3 3
=head1 NAME
4 4

  
5
Solr 4.* munin graph plugin
5
solr4_ - Solr 4.* munin graph plugin
6 6

  
7 7

  
8 8
=head1 CONFIGURATION
9 9

  
10 10
Plugin configuration parameters:
11 11

  
12
[solr_*]
13
   env.host_port <host:port>
14
   env.url <default /solr>
15
   env.qpshandler_<handlerlabel> <handlerpath>
12
 [solr_*]
13
 env.host_port <host:port>
14
 env.url <default /solr>
15
 env.qpshandler_<handlerlabel> <handlerpath>
16 16

  
17 17
Example:
18
[solr_*]
19
   env.host_port solrhost:8080
20
   env.url /solr
21
   env.qpshandler_select /select
18

  
19
 [solr_*]
20
 env.host_port solrhost:8080
21
 env.url /solr
22
 env.qpshandler_select /select
22 23

  
23 24
Install plugins:
25

  
24 26
   ln -s /usr/share/munin/plugins/solr_.py /etc/munin/plugins/solr_numdocs_core_1
25 27
   ln -s /usr/share/munin/plugins/solr_.py /etc/munin/plugins/solr_requesttimes_select
26 28
   ln -s /usr/share/munin/plugins/solr_.py /etc/munin/plugins/solr_qps
......
56 58

  
57 59
Project repo: https://github.com/averni/munin-solr
58 60

  
61
=cut
59 62
"""
60 63

  
61 64

  
plugins/systemd/timesync_status
44 44

  
45 45
=head1 LICENSE
46 46

  
47
GPLv2
47
GNU General Public License v2.0 only
48

  
49
SPDX-License-Identifier: LGPL-2.0-only
50

  
51
=cut
48 52
'''
49 53

  
50 54

  
plugins/znc/znc_logs.py
2 2
# -*- coding: utf-8 -*-
3 3
'''
4 4
=head1 NAME
5

  
5 6
znc_logs
6 7

  
7 8
=head1 DESCRIPTION
9

  
8 10
Shows lines/minute in today's znc-logs
9 11

  
10 12
=head2 CONFIGURATION
11
[znc_logs]
12
user znc # or any other user/group that can read the znclog-folder
13
group znc
14
env.logdir /var/lib/znc/moddata/log/ # path to the GLOBAL log-folder with a "/" at the end
15
env.expire 0    # Keep channel names forever  - OR -
16
env.expire 1    # Forget channel names from last run
13

  
14
 [znc_logs]
15
 user znc                              # or any other user/group that can read the znclog-folder
16
 group znc
17
 env.logdir /var/lib/znc/moddata/log/  # path to the GLOBAL log-folder with a "/" at the end
18
 env.expire 0                          # Keep channel names forever  - OR -
19
 env.expire 1                          # Forget channel names from last run
17 20

  
18 21
=head1 COPYRIGHT
19
GPL VERSION 3
22

  
23
GNU General Public License v3.0 only
24

  
25
SPDX-License-Identifier: GPL-3.0-only
20 26

  
21 27
=head1 AUTHOR
28

  
22 29
Thor77 <thor77[at]thor77.org>
30

  
31
=cut
23 32
'''
24 33
import json
25 34
import os, sys, time

Formats disponibles : Unified diff