Plugin solr4_: format perldoc header

munin-monitoring · Aug 13, 2019 · 117c508 · 117c508
1 parent a3319a6
commit 117c508
Showing 1 changed file with 58 additions and 46 deletions.
diff --git a/plugins/solr/solr4_ b/plugins/solr/solr4_
@@ -1,50 +1,62 @@
 #!/usr/bin/env python
-#
-# Copyright (c) 2013, Antonio Verni, me.verni@gmail.com
-#
-# Permission is hereby granted, free of charge, to any person obtaining a
-# copy of this software and associated documentation files (the "Software"),
-# to deal in the Software without restriction, including without limitation
-# the rights to use, copy, modify, merge, publish, distribute, sublicense,
-# and/or sell copies of the Software, and to permit persons to whom the
-# Software is furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included
-# in all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
-# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
-# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
-# DEALINGS IN THE SOFTWARE.
-#
-# Solr 4.* munin graph plugin
-# Project repo: https://github.com/averni/munin-solr
-#
-# Plugin configuration parameters:
-#
-# [solr_*]
-#    env.host_port <host:port>
-#    env.url <default /solr>
-#    env.qpshandler_<handlerlabel> <handlerpath>
-#
-# Example:
-# [solr_*]
-#    env.host_port solrhost:8080
-#    env.url /solr
-#    env.qpshandler_select /select
-#
-# 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_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_core_1_select
-#    ln -s /usr/share/munin/plugins/solr_.py /etc/munin/plugins/solr_indexsize
-#    ln -s /usr/share/munin/plugins/solr_.py /etc/munin/plugins/solr_memory
-#
-#
+"""
+=head1 NAME
+
+Solr 4.* munin graph plugin
+
+
+=head1 CONFIGURATION
+
+Plugin configuration parameters:
+
+[solr_*]
+   env.host_port <host:port>
+   env.url <default /solr>
+   env.qpshandler_<handlerlabel> <handlerpath>
+
+Example:
+[solr_*]
+   env.host_port solrhost:8080
+   env.url /solr
+   env.qpshandler_select /select
+
+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_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_core_1_select
+   ln -s /usr/share/munin/plugins/solr_.py /etc/munin/plugins/solr_indexsize
+   ln -s /usr/share/munin/plugins/solr_.py /etc/munin/plugins/solr_memory
+
+
+=head1 AUTHOR
+
+Copyright (c) 2013, Antonio Verni, me.verni@gmail.com
+
+
+=head1 LICENSE
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
+
+Project repo: https://github.com/averni/munin-solr
+
+"""
 
 
 import sys