dom/telegraf
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update docs and changelog for github input

Browse Source
This commit is contained in:
Daniel Nelson
2019-04-02 16:27:45 -07:00
parent 0a68c8468b
commit 1bcbc3eea7
5 changed files with 41 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
plugins/inputs/github/README.md
View File

@@ -1,47 +1,55 @@
# GitHub Input Plugin
The [GitHub](https://www.github.com) input plugin gathers statistics from GitHub repositories.
Gather repository information from [GitHub][] hosted repositories.
### Configuration:
**Note:** Telegraf also contains the [webhook][] input which can be used as an
alternative method for collecting repository information.
### Configuration
```toml
[[inputs.github]]
## List of repositories to monitor
## ex: repositories = ["influxdata/telegraf"]
# repositories = []
repositories = ["influxdata/telegraf"]
## Optional: Unauthenticated requests are limited to 60 per hour.
## Github API access token. Unauthenticated requests are limited to 60 per hour.
# access_token = ""
## Optional: Default 5s.
## Timeout for HTTP requests.
# http_timeout = "5s"
```
### Metrics:
### Metrics
- github_repository
- tags:
- `name` - The repository name
- `owner` - The owner of the repository
- `language` - The primary language of the repository
- `license` - The license set for the repository
- name - The repository name
- owner - The owner of the repository
- language - The primary language of the repository
- license - The license set for the repository
- fields:
- `stars` (int)
- `forks` (int)
- `open_issues` (int)
- `size` (int)
- stars (int)
- forks (int)
- open_issues (int)
- size (int)
* github_rate_limit
When the [internal][] input is enabled:
+ internal_github
- tags:
- `access_token` - An obfusticated reference to the configured access token or "Unauthenticated"
- access_token - An obfusticated reference to the configured access token or "Unauthenticated"
- fields:
- `limit` - How many requests you are limited to (per hour)
- `remaining` - How many requests you have remaining (per hour)
- `blocks` - How many requests have been blocked due to rate limit
- limit - How many requests you are limited to (per hour)
- remaining - How many requests you have remaining (per hour)
- blocks - How many requests have been blocked due to rate limit
### Example Output:
### Example Output
```
github,full_name=influxdata/telegraf,name=telegraf,owner=influxdata,language=Go,license=MIT\ License stars=6401i,forks=2421i,open_issues=722i,size=22611i 1552651811000000000
internal_github,access_token=Unauthenticated rate_limit_remaining=59i,rate_limit_limit=60i,rate_limit_blocks=0i 1552653551000000000
```
[GitHub]: https://www.github.com
[internal]: /plugins/inputs/internal
[webhook]: /plugins/inputs/webhooks/github

11
plugins/inputs/github/github.go
View File

@@ -31,14 +31,13 @@ type GitHub struct {
}
const sampleConfig = `
## List of repositories to monitor
## ex: repositories = ["influxdata/telegraf"]
# repositories = []
## List of repositories to monitor.
repositories = ["influxdata/telegraf"]
## Optional: Unauthenticated requests are limited to 60 per hour.
## Github API access token. Unauthenticated requests are limited to 60 per hour.
# access_token = ""
## Optional: Default 5s.
## Timeout for HTTP requests.
# http_timeout = "5s"
`
@@ -49,7 +48,7 @@ func (g *GitHub) SampleConfig() string {
// Description returns the plugin description.
func (g *GitHub) Description() string {
return "Read repository information from GitHub, including forks, stars, and more."
return "Gather repository information from GitHub hosted repositories."
}
// Create GitHub Client