Sha256: fd32fcb9f9f134692fb102425930bcddfbb7791f13b796dd8cf4698fb36e62d6

Contents?: true

Size: 1.39 KB

Versions: 1

Compression:

Stored size: 1.39 KB

Contents

# fluent-plugin-mackerel

## Overview

[Fluentd](http://fluentd.org) plugin to send metrics to [mackerel.io](http://mackerel.io/).

## Installation

Install with gem or fluent-gem command as:

```
# for fluentd
$ gem install fluent-plugin-typetalk

# for td-agent
$ sudo /usr/lib64/fluent/ruby/bin/fluent-gem install fluent-plugin-typetalk
```

## Configuration

### Usage

This plugin uses [APIv0](http://help-ja.mackerel.io/entry/spec/api/v0) of mackerel.io.
```
<match ...>
  type mackerel
  api_key 123456
  hostid xyz
  metrics_prefix http_status
  out_keys 2xx_count,3xx_count,4xx_count,5xx_count
</match>
```

Then the sent metric data will look like this:
```
{
  "hostId": "xyz",
  "name": "http_status.2xx_count",
  "time": 1399997498,
  "value": 100.0
}
```
As shown above, metric name will be a concatenation of `metrics_prefix` and `out_keys` values.

`flush_interval` is not allowed to set less than 60 secs not to send API requests more than once in a minute.

## TODO

Pull requests are very welcome!!

## For developers

You have to run the command below when starting development.
```
$ bundle install --path vendor/bundle
```

To run tests, do the following.
```
$ VERBOSE=1 bundle exec rake test
```

When releasing, call rake release as follows.
```
$ bundle exec rake release
```

## Copyright

* Copyright (c) 2014- Takashi Someda ([@tksmd](http://twitter.com/tksmd/))
* Apache License, Version 2.0

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
fluent-plugin-mackerel-0.0.2 README.md