Merge ~valentinviennot/ubuntu-docker-images:update-telegraf-readme into ~ubuntu-docker-images/ubuntu-docker-images/+git/telegraf:edge

Proposed by Valentin Viennot
Status: Merged
Merged at revision: 5ec1cebb422b16474a5ae3d8852a7437a0be4748
Proposed branch: ~valentinviennot/ubuntu-docker-images:update-telegraf-readme
Merge into: ~ubuntu-docker-images/ubuntu-docker-images/+git/telegraf:edge
Diff against target: 49 lines (+8/-17)
1 file modified
README.md (+8/-17)
Reviewer Review Type Date Requested Status
Lucas Kanashiro Approve
Sergio Durigan Junior Pending
Review via email: mp+394055@code.launchpad.net
To post a comment you must log in.
Revision history for this message
Lucas Kanashiro (lucaskanashiro) wrote :

LGTM, +1.

review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1diff --git a/README.md b/README.md
2index 0a26910..7e0c2fa 100644
3--- a/README.md
4+++ b/README.md
5@@ -3,21 +3,9 @@
6 ## About Telegraf
7
8 Telegraf is an agent for collecting, processing, aggregating, and
9-writing metrics.
10-
11-Design goals are to have a minimal memory footprint with a plugin
12+writing metrics. Design goals are to have a minimal memory footprint with a plugin
13 system so that developers in the community can easily add support for
14-collecting metrics.
15-
16-Telegraf is plugin-driven and has the concept of 4 distinct plugin
17-types:
18-
19-1. Input Plugins collect metrics from the system, services, or 3rd party APIs
20-2. Processor Plugins transform, decorate, and/or filter metrics
21-3. Aggregator Plugins create aggregate metrics (e.g. mean, min, max, quantiles, etc.)
22-4. Output Plugins write metrics to various destinations
23-
24-Read more on the [telegraf website](https://www.influxdata.com/time-series-platform/telegraf/).
25+collecting metrics. Read more on the [Telegraf website](https://www.influxdata.com/time-series-platform/telegraf/).
26
27 ## Tags
28
29@@ -32,15 +20,18 @@ Read more on the [telegraf website](https://www.influxdata.com/time-series-platf
30 ### Docker CLI
31
32 ```sh
33-$ docker run -d --name telegraf -e TZ=UTC squeakywheel/telegraf:edge
34+$ docker run -d --name telegraf -p 30273:9273 -e TZ=Europe/London squeakywheel/telegraf:edge
35 ```
36
37+Access your Telegraf instance at `localhost:30273`.
38+
39 #### Parameters
40
41 | Parameter | Description |
42 |---|---|
43-| `-e TZ=UTC` | Timezone, e.g. `Europe/London` |
44-| `-v /my/local/telegraf.conf:/etc/telegraf/telegraf.conf` | Mount local configuration file `telegraf.conf` (download this [example file](https://git.launchpad.net/~canonical-server/ubuntu-server-oci/+git/telegraf/plain/examples/config/telegraf.conf)) |
45+| `-e TZ=UTC` | Timezone. |
46+| `-p 30273:9273` | Expose Telegraf on `localhost:30273`. |
47+| `-v /my/local/telegraf.conf:/etc/telegraf/telegraf.conf` | Mount local configuration file `telegraf.conf` (download this [example file](https://git.launchpad.net/~canonical-server/ubuntu-server-oci/+git/telegraf/plain/examples/config/telegraf.conf)). |
48
49 #### Testing/Debugging
50

Subscribers

People subscribed via source and target branches