diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3997a448e..4f0334342 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -114,7 +114,7 @@ creating the `Parser` object. You should also add the following to your SampleConfig() return: ```toml - ## Data format to consume. + ## Data format to consume. ## Each data format has it's own unique set of configuration options, read ## more about them here: ## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md @@ -160,6 +160,17 @@ and `Stop()` methods. * Same as the `Plugin` guidelines, except that they must conform to the `inputs.ServiceInput` interface. +## Webhook Input Plugins + +A webhook plugins `Register()` itself to the internal webserver under a specific path. +It will then be called in background upon according http requests. The `github_webhooks` plugins +illustrate this behaviour. + +### Webhook Plugin Guidelines + +* Same as the `Plugin` guidelines, except that they must conform to the +`inputs.WebhookInput` interface. + ## Output Plugins This section is for developers who want to create a new output sink. Outputs @@ -244,7 +255,7 @@ instantiating and creating the `Serializer` object. You should also add the following to your SampleConfig() return: ```toml - ## Data format to output. + ## Data format to output. ## Each data format has it's own unique set of configuration options, read ## more about them here: ## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_OUTPUT.md diff --git a/README.md b/README.md index 1a6a04382..4b464a64d 100644 --- a/README.md +++ b/README.md @@ -215,6 +215,9 @@ Telegraf can also collect metrics via the following service plugins: * [mqtt_consumer](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/mqtt_consumer) * [kafka_consumer](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/kafka_consumer) * [nats_consumer](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/nats_consumer) + +and via webhook plugins: + * [github_webhooks](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/github_webhooks) * [rollbar_webhooks](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/rollbar_webhooks)