Skip to content

Commit 757d4d5

Browse files
committed
collectd: Refinements. Wording.
1 parent 93f55a2 commit 757d4d5

File tree

4 files changed

+16
-33
lines changed

4 files changed

+16
-33
lines changed

docs/integrate/collectd/collectd-telegraf.conf

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# collectd configuration for sending metrics to Telegraf.
22
# https://collectd.org/documentation/manpages/collectd.conf.html#plugin-network
33

4+
LoadPlugin network
5+
46
<Plugin "network">
57
Server "telegraf"
68
# Optional: ServerPort 25826

docs/integrate/collectd/telegraf.conf

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -38,17 +38,3 @@
3838

3939
## The character(s) to replace any '.' in an object key with
4040
# key_separator = "_"
41-
42-
# Read metrics about cpu usage
43-
[[inputs.cpu]]
44-
## Whether to report per-cpu stats or not
45-
percpu = true
46-
## Whether to report total system cpu stats or not
47-
totalcpu = true
48-
## If true, collect raw CPU time metrics
49-
collect_cpu_time = false
50-
## If true, compute and report the sum of all non-idle CPU states
51-
## NOTE: The resulting 'time_active' field INCLUDES 'iowait'!
52-
report_active = false
53-
## If true and the info is available then add core_id and physical_id tags
54-
core_tags = false

docs/integrate/collectd/tutorial-collectd.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ CrateDB.
1010
Docker is used for running all components. This approach works consistently
1111
across Linux, macOS, and Windows. Alternatively, you can use Podman.
1212

13-
### CLI
13+
### Commands
1414

1515
Prepare shortcut for the psql command.
1616

@@ -76,7 +76,7 @@ CREATE TABLE doc.collectd_data (
7676
SQL
7777
```
7878

79-
### Build collectd OCI
79+
### Build collectd
8080

8181
collectd is not available per OCI image, so either install standalone,
8282
or use these instructions for building an OCI to invoke on Docker or Podman.
@@ -98,11 +98,8 @@ the name `collectd-cratedb.conf`.
9898
:::{literalinclude} collectd-cratedb.conf
9999
:::
100100

101-
## Start services
101+
## Start collectd
102102

103-
### collectd
104-
105-
Start collectd.
106103
::::{tab-set}
107104
:sync-group: os
108105

@@ -134,8 +131,8 @@ docker run --name=collectd --rm -it --network=cratedb-demo ^
134131

135132
## Explore data
136133

137-
After starting the daemon, the first metrics will appear in the designated table in
138-
CrateDB, ready to be inspected.
134+
After the first scraping interval, metrics will show up in the
135+
designated table in CrateDB, ready to be inspected.
139136
```shell
140137
psql "postgresql://crate:crate@cratedb:5432/" -c "SELECT * FROM doc.collectd_data LIMIT 5;"
141138
```

docs/integrate/collectd/tutorial-telegraf.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ system metrics into CrateDB.
1010
Docker is used for running all components. This approach works consistently
1111
across Linux, macOS, and Windows. Alternatively, you can use Podman.
1212

13-
### CLI
13+
### Commands
1414

1515
Prepare shortcut for the psql command.
1616

@@ -40,7 +40,7 @@ doskey psql=docker run --rm -i --network=cratedb-demo docker.io/postgres psql $*
4040

4141
::::
4242

43-
### CrateDB
43+
### Start CrateDB
4444

4545
Create a shared network.
4646
```shell
@@ -54,7 +54,7 @@ docker run --name=cratedb --rm -it --network=cratedb-demo \
5454
--env=CRATE_HEAP_SIZE=2g docker.io/crate -Cdiscovery.type=single-node
5555
```
5656

57-
### collectd
57+
### Build collectd
5858

5959
collectd is not available per OCI image, so either install standalone,
6060
or use these instructions for building an OCI to invoke on Docker or Podman.
@@ -69,7 +69,7 @@ docker build -t local/collectd -f Dockerfile .
6969

7070
## Configure
7171

72-
### Telegraf
72+
### Configure Telegraf
7373

7474
Configure Telegraf to receive metrics from collectd agents and to store them
7575
in CrateDB, by using the configuration blueprint outlined below, possibly
@@ -79,7 +79,7 @@ adjusting it to match your environment. Store this file under the name
7979
:::{literalinclude} telegraf.conf
8080
:::
8181

82-
### collectd
82+
### Configure collectd
8383

8484
To send the collected data to Telegraf, configure collectd by loading its
8585
[`network` plugin] and supplying settings. Store this file under
@@ -91,9 +91,8 @@ the name `collectd-telegraf.conf`.
9191

9292
## Start services
9393

94-
### Telegraf
94+
### Start Telegraf
9595

96-
Start Telegraf.
9796
::::{tab-set}
9897
:sync-group: os
9998

@@ -123,9 +122,8 @@ docker run --name=telegraf --rm -it --network=cratedb-demo ^
123122
:::
124123
::::
125124

126-
### collectd
125+
### Start collectd
127126

128-
Start collectd.
129127
::::{tab-set}
130128
:sync-group: os
131129

@@ -157,8 +155,8 @@ docker run --name=collectd --rm -it --network=cratedb-demo ^
157155

158156
## Explore data
159157

160-
After starting the daemon, the first metrics will appear in the designated table in
161-
CrateDB, ready to be inspected.
158+
After the first scraping interval, metrics will show up in the
159+
designated table in CrateDB, ready to be inspected.
162160
```shell
163161
psql "postgresql://crate:crate@cratedb:5432/" -c "SELECT * FROM doc.metrics LIMIT 5;"
164162
```

0 commit comments

Comments
 (0)