github.com/mackerelio/mackerel-agent-plugins@v0.89.3/README.md (about)

     1  mackerel-agent-plugins  [![Build Status](https://github.com/mackerelio/mackerel-agent-plugins/workflows/test/badge.svg)](https://github.com/mackerelio/mackerel-agent-plugins/actions?workflow=test)
     2  ======================
     3  
     4  This is the official plugin pack for [mackerel-agent](https://github.com/mackerelio/mackerel-agent), a piece of software which is installed on your hosts to collect metrics and events and send them to [Mackerel](https://mackerel.io).
     5  
     6  Detailed specs of plugins can be viewed here: ENG [mackerel-agent specifications](https://mackerel.io/docs/entry/spec/agent), JPN [mackerel-agent 仕様](https://mackerel.io/ja/docs/entry/spec/agent).
     7  
     8  Documentation for each plugin is located in its respective sub directory.
     9  
    10  * [mackerel-plugin-accesslog](./mackerel-plugin-accesslog/README.md)
    11  * [mackerel-plugin-apache2](./mackerel-plugin-apache2/README.md)
    12  * [mackerel-plugin-aws-ec2-ebs](./mackerel-plugin-aws-ec2-ebs/README.md)
    13  * [mackerel-plugin-conntrack](./mackerel-plugin-conntrack/README.md)
    14  * [mackerel-plugin-docker](./mackerel-plugin-docker/README.md)
    15  * [mackerel-plugin-elasticsearch](./mackerel-plugin-elasticsearch/README.md)
    16  * [mackerel-plugin-fluentd](./mackerel-plugin-fluentd/README.md)
    17  * [mackerel-plugin-gostats](./mackerel-plugin-gostats/README.md)
    18  * [mackerel-plugin-h2o](./mackerel-plugin-h2o/README.md)
    19  * [mackerel-plugin-haproxy](./mackerel-plugin-haproxy/README.md)
    20  * [mackerel-plugin-inode](./mackerel-plugin-inode/README.md)
    21  * [mackerel-plugin-jmx-jolokia](./mackerel-plugin-jmx-jolokia/README.md)
    22  * [mackerel-plugin-jvm](./mackerel-plugin-jvm/README.md)
    23  * [mackerel-plugin-linux](./mackerel-plugin-linux/README.md)
    24  * [mackerel-plugin-mailq](./mackerel-plugin-mailq/README.md)
    25  * [mackerel-plugin-memcached](./mackerel-plugin-memcached/README.md)
    26  * [mackerel-plugin-mongodb](https://github.com/mackerelio/mackerel-plugin-mongodb/blob/main/README.md)
    27  * [mackerel-plugin-mssql](./mackerel-plugin-mssql/README.md)
    28  * [mackerel-plugin-multicore](./mackerel-plugin-multicore/README.md)
    29  * [mackerel-plugin-munin](./mackerel-plugin-munin/README.md)
    30  * [mackerel-plugin-mysql](https://github.com/mackerelio/mackerel-plugin-mysql/blob/main/README.md)
    31  * [mackerel-plugin-nginx](./mackerel-plugin-nginx/README.md)
    32  * [mackerel-plugin-openldap](./mackerel-plugin-openldap/README.md)
    33  * [mackerel-plugin-php-apc](./mackerel-plugin-php-apc/README.md)
    34  * [mackerel-plugin-php-fpm](./mackerel-plugin-php-fpm/README.md)
    35  * [mackerel-plugin-php-opcache](./mackerel-plugin-php-opcache/README.md)
    36  * [mackerel-plugin-plack](./mackerel-plugin-plack/README.md)
    37  * [mackerel-plugin-postgres](./mackerel-plugin-postgres/README.md)
    38  * [mackerel-plugin-proc-fd](./mackerel-plugin-proc-fd/README.md)
    39  * [mackerel-plugin-rabbitmq](./mackerel-plugin-rabbitmq/README.md)
    40  * [mackerel-plugin-redis](./mackerel-plugin-redis/README.md)
    41  * [mackerel-plugin-sidekiq](./mackerel-plugin-sidekiq/README.md)
    42  * [mackerel-plugin-snmp](./mackerel-plugin-snmp/README.md)
    43  * [mackerel-plugin-solr](./mackerel-plugin-solr/README.md)
    44  * [mackerel-plugin-squid](./mackerel-plugin-squid/README.md)
    45  * [mackerel-plugin-td-table-count](./mackerel-plugin-td-table-count/README.md)
    46  * [mackerel-plugin-trafficserver](./mackerel-plugin-trafficserver/README.md)
    47  * [mackerel-plugin-twemproxy](./mackerel-plugin-twemproxy/README.md)
    48  * [mackerel-plugin-unicorn](./mackerel-plugin-unicorn/README.md)
    49  * [mackerel-plugin-uptime](./mackerel-plugin-uptime/README.md)
    50  * [mackerel-plugin-uwsgi-vassal](./mackerel-plugin-uwsgi-vassal/README.md)
    51  * [mackerel-plugin-varnish](./mackerel-plugin-varnish/README.md)
    52  * [mackerel-plugin-windows-process-stats](./mackerel-plugin-windows-process-stats/README.md)
    53  * [mackerel-plugin-windows-server-sessions](./mackerel-plugin-windows-server-sessions/README.md)
    54  
    55  Installation
    56  ============
    57  
    58  ## Install mackerel-agent
    59  
    60  ENG https://mackerel.io/docs/entry/howto/install-agent
    61  JPN https://mackerel.io/ja/docs/entry/howto/install-agent
    62  
    63  If the mackerel-agent has already be installed this step can be ignored.
    64  
    65  ## Install mackerel-agent-plugins
    66  
    67  Install the plugin pack from either the yum or the apt repository.
    68  To setup these package repositories, see the documentation regarding the installation of mackerel-agent ([rpm](https://mackerel.io/docs/entry/howto/install-agent/rpm) / [deb](https://mackerel.io/docs/entry/howto/install-agent/deb)).
    69  
    70  mackerel-agent-plugins will be installed to ```/usr/bin/mackerel-plugin-*``` (and some plugins are symlinked as ```/usr/local/bin/mackerel-plugin-*```, for backward compatibility.).
    71  
    72  ### yum
    73  
    74  ```shell
    75  yum install mackerel-agent-plugins
    76  ```
    77  
    78  ### apt
    79  
    80  ```shell
    81  apt-get install mackerel-agent-plugins
    82  ```
    83  
    84  ### Go
    85  
    86  **mackerel-agent-plugins** supports two newer versions of Go.
    87  
    88  ```shell
    89  go install github.com/mackerelio/mackerel-agent-plugins/...@latest
    90  ```
    91  
    92  Caution
    93  =======
    94  
    95  Some plugins may not work on CentOS/RedHat 5 because the golang compiler (gc) doesn't support the old kernel.
    96  (https://golang.org/doc/install)
    97  
    98  Some plugins are not contained in rpm and deb packages. If you want to use them, build them.
    99  
   100  Contribution
   101  ============
   102  
   103  * see [The official plugin registry](https://mackerel.io/blog/entry/feature/20171116#The-official-plugin-registry) and [Pull requests to the existing central repository](https://mackerel.io/blog/entry/feature/20171116#Pull-Requests-to-the-existing-central-repository)
   104  * fork it
   105  * develop the plugin you want
   106  * create a pullrequest!
   107  
   108  License
   109  =======
   110  ```
   111  Copyright 2014 Hatena Co., Ltd.
   112  
   113  Licensed under the Apache License, Version 2.0 (the "License");
   114  you may not use this file except in compliance with the License.
   115  You may obtain a copy of the License at
   116  
   117      http://www.apache.org/licenses/LICENSE-2.0
   118  
   119  Unless required by applicable law or agreed to in writing, software
   120  distributed under the License is distributed on an "AS IS" BASIS,
   121  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   122  See the License for the specific language governing permissions and
   123  limitations under the License.
   124  ```