From b829febe0d9e34fc9422232b7007ecd38a151cd8 Mon Sep 17 00:00:00 2001 From: Paul Dix Date: Fri, 19 Jun 2015 17:34:27 +0100 Subject: [PATCH] Update README.md --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 867c6a1ca..202fac536 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,20 @@ # Telegraf - A native agent for InfluxDB +Telegraf is an agent written in Go for collecting metrics from the system it's running on or from other services and writing them into InfluxDB. + +Design goals are to have a minimal memory footprint with a plugin system so that developers in the community can easily add support for collecting metrics from well known services and third party APIs. + +We'll happily accept pull requests for new plugins and will manage the set of plugins that Telegraf supports. See the bottom of this doc for instructions on writing new plugins. + ## Quickstart -* Build from source or download telegraf (binaries forthcoming) +* Build from source or download telegraf. Packages here: + +``` +http://get.influxdb.org/telegraf/telegraf_0.1.1_amd64.deb +http://get.influxdb.org/telegraf/telegraf-0.1.1-1.x86_64.rpm +``` + * Run `telegraf -sample-config > telegraf.toml` to create an initial configuration * Edit the configuration to match your needs * Run `telegraf -config telegraf.toml -test` to output one full measurement sample to STDOUT