CL-Softwares
/
telegraf
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: remove trailing whitespace (#12660)

This commit is contained in:
Joshua Powers 2023-02-09 12:35:18 -07:00 committed by GitHub
parent 200044a495
commit fa26b6498b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
37 changed files with 229 additions and 209 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
plugins/inputs/webhooks/github/README.md
View File

@ -1,12 +1,22 @@
# github webhooks
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://<my_ip>:1619/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.
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://<my_ip>:1619/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.
You can also add a secret that will be used by telegraf to verify the authenticity of the requests.
You can also add a secret that will be used by telegraf to verify the
authenticity of the requests.
## Events
## Metrics
The titles of the following sections are links to the full payloads and details for each event. The body contains what information from the event is persisted. The format is as follows:
The titles of the following sections are links to the full payloads and details
for each event. The body contains what information from the event is persisted.
The format is as follows:
```toml
# TAGS
@ -15,7 +25,8 @@ The titles of the following sections are links to the full payloads and details
* 'fieldKey' = `fieldValue` type
```
The tag values and field values show the place on the incoming JSON object where the data is sourced from.
The tag values and field values show the place on the incoming JSON object
where the data is sourced from.
### [`commit_comment` event](https://developer.github.com/v3/activity/events/types/#commitcommentevent)

17
plugins/inputs/webhooks/particle/README.md
View File

@ -1,6 +1,10 @@
# particle webhooks
You should configure your Particle.io's Webhooks to point at the `webhooks` service. To do this go to [https://console.particle.io](https://console.particle.io/) and click `Integrations > New Integration > Webhook`. In the resulting page set `URL` to `http://<my_ip>:1619/particle`, and under `Advanced Settings` click on `JSON` and add:
You should configure your Particle.io's Webhooks to point at the `webhooks`
service. To do this go to [https://console.particle.io][particle.io]
and click `Integrations > New Integration > Webhook`. In the resulting page set
`URL` to `http://<my_ip>:1619/particle`, and under `Advanced Settings` click
on `JSON` and add:
```json
{
@ -10,9 +14,12 @@ You should configure your Particle.io's Webhooks to point at the `webhooks` serv
If required, enter your username and password, etc. and then click `Save`
[particle.io]: https://console.particle.io/
## Events
Your Particle device should publish an event that contains a JSON in the form of:
Your Particle device should publish an event that contains a JSON in the form
of:
```json
String data = String::format("{ \"tags\" : {
@ -29,8 +36,10 @@ String data = String::format("{ \"tags\" : {
```
Escaping the "" is required in the source file.
The number of tag values and field values is not restricted so you can send as many values per webhook call as you'd like.
The number of tag values and field values is not restricted so you can send as
many values per webhook call as you'd like.
You will need to enable JSON messages in the Webhooks setup of Particle.io, and make sure to check the "include default data" box as well.
You will need to enable JSON messages in the Webhooks setup of Particle.io, and
make sure to check the "include default data" box as well.
See [webhook doc](https://docs.particle.io/reference/webhooks/)