From 4a421febdbdb58633f03540a566c06b554a9681e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fran=C3=A7ois=20de=20Metz?= Date: Fri, 27 May 2016 17:55:21 +0200 Subject: [PATCH] Update READMEs and CHANGELOG. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: François de Metz Signed-off-by: Cyril Duez --- CHANGELOG.md | 6 +++++- plugins/inputs/webhooks/README.md | 23 ++++++++++++++++++++++- plugins/inputs/webhooks/github/README.md | 13 ++----------- plugins/inputs/webhooks/rollbar/README.md | 13 ++----------- 4 files changed, 31 insertions(+), 24 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9f9caaa07..5d9808dce 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -21,11 +21,13 @@ attribute. This configures the TTL of the internal metric cache. This is useful in conjunction with wildcard dimension values as it will control the amount of time before a new metric is included by the plugin. +- The github webhooks have been integrated into the new webhooks plugin. You +have to configure the new `webhooks` plugins. + ### Features - [#1294](https://github.com/influxdata/telegraf/pull/1294): consul input plugin. Thanks @harnash - [#1164](https://github.com/influxdata/telegraf/pull/1164): conntrack input plugin. Thanks @robinpercy! - [#1165](https://github.com/influxdata/telegraf/pull/1165): vmstat input plugin. Thanks @jshim-xm! -- [#1247](https://github.com/influxdata/telegraf/pull/1247): rollbar input plugin. Thanks @francois2metz and @cduez! - [#1208](https://github.com/influxdata/telegraf/pull/1208): Standardized AWS credentials evaluation & wildcard CloudWatch dimensions. Thanks @johnrengelman! - [#1264](https://github.com/influxdata/telegraf/pull/1264): Add SSL config options to http_response plugin. - [#1272](https://github.com/influxdata/telegraf/pull/1272): graphite parser: add ability to specify multiple tag keys, for consistency with influxdb parser. @@ -37,6 +39,8 @@ time before a new metric is included by the plugin. - [#1278](https://github.com/influxdata/telegraf/pull/1278) & [#1288](https://github.com/influxdata/telegraf/pull/1288) & [#1295](https://github.com/influxdata/telegraf/pull/1295): RabbitMQ/Apache/InfluxDB inputs: made url(s) parameter optional by using reasonable input defaults if not specified - [#1296](https://github.com/influxdata/telegraf/issues/1296): Refactor of flush_jitter argument. - [#1213](https://github.com/influxdata/telegraf/issues/1213): Add inactive & active memory to mem plugin. +- [#1289](https://github.com/influxdata/telegraf/pull/1289): webhooks input plugin. Thanks @francois2metz and @cduez! + - [#1247](https://github.com/influxdata/telegraf/pull/1247): rollbar webhook plugin. ### Bugfixes diff --git a/plugins/inputs/webhooks/README.md b/plugins/inputs/webhooks/README.md index 550338523..43985b357 100644 --- a/plugins/inputs/webhooks/README.md +++ b/plugins/inputs/webhooks/README.md @@ -1,2 +1,23 @@ -# Webhooks plugin +# Webhooks +This is a Telegraf service plugin that start an http server and start multiple webhook listeners. + +```sh +$ telegraf -sample-config -input-filter webhooks -output-filter influxdb > config.conf.new +``` + +Change the config file to point to the InfluxDB server you are using and adjust the settings to match your environment. Once that is complete: + +```sh +$ cp config.conf.new /etc/telegraf/telegraf.conf +$ sudo service telegraf start +``` + +## Available webhooks + +- [Github](github/) +- [Rollbar](rollbar/) + +## Adding new webhook services + +TODO diff --git a/plugins/inputs/webhooks/github/README.md b/plugins/inputs/webhooks/github/README.md index 230e5366b..a4788c653 100644 --- a/plugins/inputs/webhooks/github/README.md +++ b/plugins/inputs/webhooks/github/README.md @@ -1,15 +1,6 @@ -# github_webhooks +# github webhooks -This is a Telegraf service plugin that listens for events kicked off by Github's Webhooks service and persists data from them into configured outputs. To set up the listener first generate the proper configuration: -```sh -$ telegraf -sample-config -input-filter github_webhooks -output-filter influxdb > config.conf.new -``` -Change the config file to point to the InfluxDB server you are using and adjust the settings to match your environment. Once that is complete: -```sh -$ cp config.conf.new /etc/telegraf/telegraf.conf -$ sudo service telegraf start -``` -Once the server is running you should configure your Organization's Webhooks to point at the `github_webhooks` service. To do this go to `github.com/{my_organization}` and click `Settings > Webhooks > Add webhook`. In the resulting menu set `Payload URL` to `http://:1618`, `Content type` to `application/json` and under the section `Which events would you like to trigger this webhook?` select 'Send me everything'. By default all of the events will write to the `github_webhooks` measurement, this is configurable by setting the `measurement_name` in the config file. +You should configure your Organization's Webhooks to point at the `webhooks` service. To do this go to `github.com/{my_organization}` and click `Settings > Webhooks > Add webhook`. In the resulting menu set `Payload URL` to `http://:1925/github`, `Content type` to `application/json` and under the section `Which events would you like to trigger this webhook?` select 'Send me everything'. By default all of the events will write to the `github_webhooks` measurement, this is configurable by setting the `measurement_name` in the config file. ## Events diff --git a/plugins/inputs/webhooks/rollbar/README.md b/plugins/inputs/webhooks/rollbar/README.md index d6938df28..a105afb24 100644 --- a/plugins/inputs/webhooks/rollbar/README.md +++ b/plugins/inputs/webhooks/rollbar/README.md @@ -1,15 +1,6 @@ -# rollbar_webhooks +# rollbar webhooks -This is a Telegraf service plugin that listens for events kicked off by Rollbar Webhooks service and persists data from them into configured outputs. To set up the listener first generate the proper configuration: -```sh -$ telegraf -sample-config -input-filter rollbar_webhooks -output-filter influxdb > config.conf.new -``` -Change the config file to point to the InfluxDB server you are using and adjust the settings to match your environment. Once that is complete: -```sh -$ cp config.conf.new /etc/telegraf/telegraf.conf -$ sudo service telegraf start -``` -Once the server is running you should configure your Rollbar's Webhooks to point at the `rollbar_webhooks` service. To do this go to `rollbar.com/` and click `Settings > Notifications > Webhook`. In the resulting page set `URL` to `http://:1619`, and click on `Enable Webhook Integration`. +You should configure your Rollbar's Webhooks to point at the `webhooks` service. To do this go to `rollbar.com/` and click `Settings > Notifications > Webhook`. In the resulting page set `URL` to `http://:1925/rollbar`, and click on `Enable Webhook Integration`. ## Events