1
1
# Telegraf [ ![ Circle CI] ( https://circleci.com/gh/influxdata/telegraf.svg?style=svg )] ( https://circleci.com/gh/influxdata/telegraf ) [ ![ Docker pulls] ( https://img.shields.io/docker/pulls/library/telegraf.svg )] ( https://hub.docker.com/_/telegraf/ )
2
2
3
- Telegraf is an agent written in Go for collecting, processing, aggregating,
4
- and writing metrics.
3
+ Telegraf is an agent for collecting, processing, aggregating, and writing metrics.
5
4
6
5
Design goals are to have a minimal memory footprint with a plugin system so
7
- that developers in the community can easily add support for collecting metrics
8
- . For an example configuration referencet from local or remote services .
6
+ that developers in the community can easily add support for collecting
7
+ metrics .
9
8
10
- Telegraf is plugin-driven and has the concept of 4 distinct plugins :
9
+ Telegraf is plugin-driven and has the concept of 4 distinct plugin types :
11
10
12
11
1 . [ Input Plugins] ( #input-plugins ) collect metrics from the system, services, or 3rd party APIs
13
12
2 . [ Processor Plugins] ( #processor-plugins ) transform, decorate, and/or filter metrics
14
13
3 . [ Aggregator Plugins] ( #aggregator-plugins ) create aggregate metrics (e.g. mean, min, max, quantiles, etc.)
15
14
4 . [ Output Plugins] ( #output-plugins ) write metrics to various destinations
16
15
17
- For more information on Processor and Aggregator plugins please [ read this] ( ./docs/AGGREGATORS_AND_PROCESSORS.md ) .
18
-
19
- New plugins are designed to be easy to contribute,
20
- we'll eagerly accept pull
16
+ New plugins are designed to be easy to contribute, we'll eagerly accept pull
21
17
requests and will manage the set of plugins that Telegraf supports.
22
18
23
19
## Contributing
@@ -26,7 +22,7 @@ There are many ways to contribute:
26
22
- Fix and [ report bugs] ( https://github.com/influxdata/telegraf/issues/new )
27
23
- [ Improve documentation] ( https://github.com/influxdata/telegraf/issues?q=is%3Aopen+label%3Adocumentation )
28
24
- [ Review code and feature proposals] ( https://github.com/influxdata/telegraf/pulls )
29
- - Answer questions on github and on the [ Community Site] ( https://community.influxdata.com/ )
25
+ - Answer questions and discuss here on github and on the [ Community Site] ( https://community.influxdata.com/ )
30
26
- [ Contribute plugins] ( CONTRIBUTING.md )
31
27
32
28
## Installation:
@@ -42,7 +38,7 @@ Ansible role: https://github.com/rossmcdonald/telegraf
42
38
43
39
Telegraf requires golang version 1.9 or newer, the Makefile requires GNU make.
44
40
45
- 1 . [ Install Go] ( https://golang.org/doc/install ) >=1.9
41
+ 1 . [ Install Go] ( https://golang.org/doc/install ) >=1.9 (1.10 recommended)
46
42
2 . [ Install dep] ( https://golang.github.io/dep/docs/installation.html ) ==v0.5.0
47
43
3 . Download Telegraf source:
48
44
```
@@ -86,44 +82,47 @@ These builds are generated from the master branch:
86
82
See usage with:
87
83
88
84
```
89
- ./ telegraf --help
85
+ telegraf --help
90
86
```
91
87
92
88
#### Generate a telegraf config file:
93
89
94
90
```
95
- ./ telegraf config > telegraf.conf
91
+ telegraf config > telegraf.conf
96
92
```
97
93
98
94
#### Generate config with only cpu input & influxdb output plugins defined:
99
95
100
96
```
101
- ./ telegraf --input-filter cpu --output-filter influxdb config
97
+ telegraf --input-filter cpu --output-filter influxdb config
102
98
```
103
99
104
100
#### Run a single telegraf collection, outputing metrics to stdout:
105
101
106
102
```
107
- ./ telegraf --config telegraf.conf --test
103
+ telegraf --config telegraf.conf --test
108
104
```
109
105
110
106
#### Run telegraf with all plugins defined in config file:
111
107
112
108
```
113
- ./ telegraf --config telegraf.conf
109
+ telegraf --config telegraf.conf
114
110
```
115
111
116
112
#### Run telegraf, enabling the cpu & memory input, and influxdb output plugins:
117
113
118
114
```
119
- ./ telegraf --config telegraf.conf --input-filter cpu:mem --output-filter influxdb
115
+ telegraf --config telegraf.conf --input-filter cpu:mem --output-filter influxdb
120
116
```
121
117
118
+ ## Documentation
119
+
120
+ [ Latest Release Documentation] [ release docs ] .
122
121
123
- ## Configuration
122
+ For documentation on the latest development code see the [ documentation index ] [ devel docs ] .
124
123
125
- See the [ configuration guide ] ( docs/CONFIGURATION.md ) for a rundown of the more advanced
126
- configuration options.
124
+ [ release docs] : https://docs.influxdata.com/telegraf
125
+ [ devel docs ] : docs
127
126
128
127
## Input Plugins
129
128
0 commit comments