Skip to content

Commit 1377c90

Browse files
authored
Updated collectd input plugin docs with missing information. Fix #2196. (#2197)
* Updated to include new input plugin doc for Windows System Statistics. Applies to #2139. Signed-off-by: Eric D. Schabell <[email protected]> * Updated to include new input plugin doc for Windows System Statistics. Applies to #2139. Signed-off-by: Eric D. Schabell <[email protected]> * Lint fix for winstat input plugin doc fix. Signed-off-by: Eric D. Schabell <[email protected]> * Updated collectd input plugin docs with missing information. Fix #2196. Signed-off-by: Eric D. Schabell <[email protected]> --------- Signed-off-by: Eric D. Schabell <[email protected]>
1 parent b3757b8 commit 1377c90

File tree

1 file changed

+41
-9
lines changed

1 file changed

+41
-9
lines changed

pipeline/inputs/collectd.md

Lines changed: 41 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,41 @@
11
# Collectd
22

3-
The _Collectd_ input plugin lets you receive datagrams from the `collectd` service.
3+
The _Collectd_ input plugin lets you receive datagrams from the `collectd` service over `UDP`. The plugin listens for collectd network protocol packets and converts them into Fluent Bit records.
44

55
## Configuration parameters
66

77
The plugin supports the following configuration parameters:
88

99
| Key | Description | Default |
1010
|:-----------|:--------------------------------------------------------------------------------------------------------|:-------------------------------|
11-
| `Listen` | Set the address to listen to. | `0.0.0.0` |
12-
| `Port` | Set the port to listen to. | `25826` |
13-
| `TypesDB` | Set the data specification file. | `/usr/share/collectd/types.db` |
14-
| `Threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
11+
| `listen` | Set the address to listen to. | `0.0.0.0` |
12+
| `port` | Set the port to listen to. | `25826` |
13+
| `typesdb` | Set the data specification file. You can specify multiple files separated by commas. Later entries take precedence over earlier ones. | `/usr/share/collectd/types.db` |
14+
| `threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
1515

16-
## Configuration examples
16+
## Get started
1717

18-
Here is a basic configuration example:
18+
To receive collectd datagrams, you can run the plugin from the command line or through the configuration file.
19+
20+
### Command line
21+
22+
From the command line you can let Fluent Bit listen for `collectd` datagrams with the following options:
23+
24+
```shell
25+
fluent-bit -i collectd -o stdout
26+
```
27+
28+
By default, the service listens on all interfaces (`0.0.0.0`) using `UDP` port `25826`. You can change this directly:
29+
30+
```shell
31+
fluent-bit -i collectd -p listen=192.168.3.2 -p port=9090 -o stdout
32+
```
33+
34+
In this example, collectd datagrams will only arrive through the network interface at `192.168.3.2` address and `UDP` port `9090`.
35+
36+
### Configuration file
37+
38+
In your main configuration file append the following:
1939

2040
{% tabs %}
2141
{% tab title="fluent-bit.yaml" %}
@@ -26,7 +46,7 @@ pipeline:
2646
- name: collectd
2747
listen: 0.0.0.0
2848
port: 25826
29-
typesdb: '/user/share/collectd/types.db,/etc/collectd/custom.db'
49+
typesdb: '/usr/share/collectd/types.db,/etc/collectd/custom.db'
3050

3151
outputs:
3252
- name: stdout
@@ -53,4 +73,16 @@ pipeline:
5373

5474
With this configuration, Fluent Bit listens to `0.0.0.0:25826`, and outputs incoming datagram packets to `stdout`.
5575

56-
You must set the same `types.db` files that your `collectd` server uses. Otherwise, Fluent Bit might not be able to interpret the payload properly.
76+
## TypesDB configuration
77+
78+
You must set the same `types.db` files that your `collectd` server uses. Otherwise, Fluent Bit might not be able to interpret the payload properly.
79+
80+
The `TypesDB` parameter supports multiple files separated by commas. When multiple files are specified, later entries take precedence over earlier ones if there are duplicate type definitions. This allows you to override default types with custom definitions.
81+
82+
For example:
83+
84+
```yaml
85+
typesdb: '/usr/share/collectd/types.db,/etc/collectd/custom.db'
86+
```
87+
88+
In this configuration, custom type definitions in `/etc/collectd/custom.db` will override any matching definitions from `/usr/share/collectd/types.db`.

0 commit comments

Comments
 (0)