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

     1  mackerel-plugin-linux
     2  ============================
     3  
     4  ## Description
     5  
     6  Get linux process metrics for Mackerel and Sensu.
     7  
     8  For example ...
     9  
    10  - Page swapped (swap)
    11  - Connections each network service primitives (netstat)
    12  - Disk read time (diskstats)
    13  - Interrupts (proc_stat)
    14  - Context switches
    15  - Forks
    16  - Login users (users)
    17  
    18  ## Required
    19  
    20  - Linux Kernel 2.6.32 or above.
    21  
    22  ## Usage
    23  
    24  ### Build this program
    25  
    26  First, build this program.
    27  
    28  ```
    29  go get github.com/mackerelio/mackerel-agent-plugins
    30  cd $(go env GOPATH)/src/github.com/mackerelio/mackerel-agent-plugins/mackerel-plugin-linux
    31  go test
    32  go build
    33  ```
    34  
    35  ### Execute this plugin
    36  
    37  Next, you can execute this program :-)
    38  
    39  ```
    40  ./mackerel-plugin-linux
    41  ```
    42  
    43  ### Add mackerel-agent.conf
    44  
    45  Finally, if you want to get linux metrics via Mackerel, please edit mackerel-agent.conf. For example is below.
    46  
    47  ```
    48  [plugin.metrics.linux]
    49  command = "/path/to/mackerel-plugin-linux"
    50  ```
    51  
    52  ## Optional: Selecting get metrics
    53  
    54  ## For more information
    55  
    56  Please execute 'mackerel-plugin-linux -h' and you can get command line options.
    57  
    58  ## References
    59  
    60  This program to use as reference from [Percona Monitoring Plugins for Cacti](http://www.percona.com/doc/percona-monitoring-plugins/).
    61  
    62  ## Author
    63  
    64  [Yuichiro Saito](https://github.com/koemu)