Skip to content

Commit 41d528c

Browse files
authored
Split parser/serializer docs (influxdata#4690)
1 parent 96f3d7d commit 41d528c

File tree

25 files changed

+1412
-1331
lines changed

25 files changed

+1412
-1331
lines changed

README.md

+19-20
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,19 @@
11
# 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/)
22

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.
54

65
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.
98

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:
1110

1211
1. [Input Plugins](#input-plugins) collect metrics from the system, services, or 3rd party APIs
1312
2. [Processor Plugins](#processor-plugins) transform, decorate, and/or filter metrics
1413
3. [Aggregator Plugins](#aggregator-plugins) create aggregate metrics (e.g. mean, min, max, quantiles, etc.)
1514
4. [Output Plugins](#output-plugins) write metrics to various destinations
1615

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
2117
requests and will manage the set of plugins that Telegraf supports.
2218

2319
## Contributing
@@ -26,7 +22,7 @@ There are many ways to contribute:
2622
- Fix and [report bugs](https://github.com/influxdata/telegraf/issues/new)
2723
- [Improve documentation](https://github.com/influxdata/telegraf/issues?q=is%3Aopen+label%3Adocumentation)
2824
- [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/)
3026
- [Contribute plugins](CONTRIBUTING.md)
3127

3228
## Installation:
@@ -42,7 +38,7 @@ Ansible role: https://github.com/rossmcdonald/telegraf
4238

4339
Telegraf requires golang version 1.9 or newer, the Makefile requires GNU make.
4440

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)
4642
2. [Install dep](https://golang.github.io/dep/docs/installation.html) ==v0.5.0
4743
3. Download Telegraf source:
4844
```
@@ -86,44 +82,47 @@ These builds are generated from the master branch:
8682
See usage with:
8783

8884
```
89-
./telegraf --help
85+
telegraf --help
9086
```
9187

9288
#### Generate a telegraf config file:
9389

9490
```
95-
./telegraf config > telegraf.conf
91+
telegraf config > telegraf.conf
9692
```
9793

9894
#### Generate config with only cpu input & influxdb output plugins defined:
9995

10096
```
101-
./telegraf --input-filter cpu --output-filter influxdb config
97+
telegraf --input-filter cpu --output-filter influxdb config
10298
```
10399

104100
#### Run a single telegraf collection, outputing metrics to stdout:
105101

106102
```
107-
./telegraf --config telegraf.conf --test
103+
telegraf --config telegraf.conf --test
108104
```
109105

110106
#### Run telegraf with all plugins defined in config file:
111107

112108
```
113-
./telegraf --config telegraf.conf
109+
telegraf --config telegraf.conf
114110
```
115111

116112
#### Run telegraf, enabling the cpu & memory input, and influxdb output plugins:
117113

118114
```
119-
./telegraf --config telegraf.conf --input-filter cpu:mem --output-filter influxdb
115+
telegraf --config telegraf.conf --input-filter cpu:mem --output-filter influxdb
120116
```
121117

118+
## Documentation
119+
120+
[Latest Release Documentation][release docs].
122121

123-
## Configuration
122+
For documentation on the latest development code see the [documentation index][devel docs].
124123

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
127126

128127
## Input Plugins
129128

0 commit comments

Comments
 (0)