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

Fix pod doc in header of file

This commit is contained in:
s0 2021-07-16 19:03:47 +10:00
parent e70f572eeb
commit 181f3ed970
1 changed files with 106 additions and 78 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

184
plugins/openstack/openstack_swift_stats_
View File

@ -1,83 +1,111 @@
#!/bin/sh #!/bin/sh
#=begin : <<=cut
#
#=head1 NAME
# =head1 NAME
#openstack_swift_stats_ -- Plugin to monitor size of OpenStack Swift containers
# B<openstack_swift_stats_> -- Plugin to monitor size of OpenStack Swift containers
#=head1 ABOUT
# =head1 ABOUT
#Multigraph plugin. Graphs the following statistics about an OpenStack Swift container:
#- Size in bytes Multigraph plugin. Graphs the following statistics about an OpenStack Swift container:
#- Growth in size per graph period (hour by default)
# =over
#- Number of objects
#- Growth in objects per graph period (hour by default) =item * Size in bytes
#
#=head1 CONFIGURATION =item * Growth in size per graph period (hour by default)
#
#Configuration values are mandatory. Names are identical to the environment values used by the Swift commands and passed directly to it. =item * Number of objects
#They can be copied from the openrc.sh file provided by your OpenStack hosting provider, along with the password.
# =item * Growth in objects per graph period (hour by default)
#OS_AUTH_URL
#OS_IDENTITY_API_VERSION =back
#OS_REGION_NAME
#OS_USER_DOMAIN_NAME =head1 CONFIGURATION
#OS_PROJECT_DOMAIN_NAME
#OS_TENANT_ID Configuration values are mandatory. Names are identical to the environment values used by the Swift commands and passed directly to it.
#OS_TENANT_NAME They can be copied from the openrc.sh file provided by your OpenStack hosting provider, along with the password.
#OS_USERNAME
#OS_PASSWORD =begin html
#
#Configuration example for OVH: <pre><code>OS_AUTH_URL
# OS_IDENTITY_API_VERSION
#[openstack_swift_size_*] OS_REGION_NAME
# env.OS_AUTH_URL https://auth.cloud.ovh.net/v3/ OS_USER_DOMAIN_NAME
# env.OS_IDENTITY_API_VERSION 3 OS_PROJECT_DOMAIN_NAME
# env.OS_REGION_NAME SYD OS_TENANT_ID
# env.OS_USER_DOMAIN_NAME Default OS_TENANT_NAME
# env.OS_PROJECT_DOMAIN_NAME Default OS_USERNAME
# OS_PASSWORD
# env.OS_TENANT_ID {{Redacted}} </pre></code>
# env.OS_TENANT_NAME {{Redacted}}
# env.OS_USERNAME user-{{Redacted}} =end html
# env.OS_PASSWORD {{Redacted}}
# Configuration example for OVH:
#=head1 USAGE
# =begin html
#- Place the plugin in your plugins storage directory (/usr/share/munin/plugins)
#- Symlink it into the active plugins directory (/etc/munin/plugins) with the name of your container after the last underscore <pre><code>[openstack_swift_size_*]
# (e.g. ln -s /usr/share/munin/plugins/openstack_swift_stats_ /etc/munin/plugins/openstack_swift_stats_mycontainer) env.OS_AUTH_URL https://auth.cloud.ovh.net/v3/
#- Copy the OpenStack login environment variables from the openrc.sh file provided by your hosting provider to your plugin config file as shown in the configuration section. env.OS_IDENTITY_API_VERSION 3
#- Add the OS_PASSWORD value for the chosen user. env.OS_REGION_NAME SYD
# env.OS_USER_DOMAIN_NAME Default
#=head1 AUTHOR env.OS_PROJECT_DOMAIN_NAME Default
#
#Copyright (C) 2020 Sophie Parker (dev@cortices.me) env.OS_TENANT_ID {{Redacted}}
# env.OS_TENANT_NAME {{Redacted}}
#=head1 LICENSE env.OS_USERNAME user-{{Redacted}}
# env.OS_PASSWORD {{Redacted}}
#This program is free software; you can redistribute it and/or </pre></code>
#modify it under the terms of the GNU General Public License
#as published by the Free Software Foundation; version 2 dated June, =end html
#1991.
# =head1 USAGE
#This program is distributed in the hope that it will be useful,
#but WITHOUT ANY WARRANTY; without even the implied warranty of =over
#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
#GNU General Public License for more details. =item 1. Place the plugin in your plugins storage directory (/usr/share/munin/plugins)
#
#You should have received a copy of the GNU General Public License =item 2. Symlink it into the active plugins directory (/etc/munin/plugins) with the name of your container after the last underscore
#along with this program; if not, write to the Free Software (e.g. ln -s /usr/share/munin/plugins/openstack_swift_stats_ /etc/munin/plugins/openstack_swift_stats_mycontainer)
#Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
# =item 3. Copy the OpenStack login environment variables from the openrc.sh file provided by your hosting provider to your plugin config file as shown in the configuration section.
#=head1 MAGIC MARKERS
# =item 4. Add the C<OS_PASSWORD> value for the chosen user (OS as in OpenStack, not Operating System).
##%# family=manual
# =back
#=end
# =head1 AUTHOR
Copyright (C) 2020 Sophie Parker (cortices@github)
=head1 LICENSE
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; version 2 dated June,
1991.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
=head1 MAGIC MARKERS
#%# family=manual
=cut
# Get container to check by splitting off end of filename. # Get container to check by splitting off end of filename.