Skip to content

Commit 69f8ffa

Browse files
authored
Merge pull request #1838 from fluent/lynettemiles/sc-136208/update-fluent-bit-docs-pipeline-inputs-thermal
2 parents 168c2bf + c0a49a7 commit 69f8ffa

File tree

1 file changed

+39
-30
lines changed

1 file changed

+39
-30
lines changed

pipeline/inputs/thermal.md

Lines changed: 39 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,45 @@
11
# Thermal
22

3-
The **thermal** input plugin reports system temperatures periodically -- each second by default. Currently, this plugin is only available for Linux.
3+
The _Thermal_ input plugin reports system temperatures. This plugin is available only for Linux.
44

5-
The following tables describes the information generated by the plugin.
5+
The following table describes the information generated by the plugin:
66

7-
| key | description |
8-
| :--- | :--- |
9-
| name | The name of the thermal zone, such as _thermal\_zone0_ |
10-
| type | The type of the thermal zone, such as _x86\_pkg\_temp_ |
11-
| temp | Current temperature in celsius |
7+
| Key | Description |
8+
| :-- | :---------- |
9+
| `name` | The name of the thermal zone, such as `thermal_zone0`. |
10+
| `type` | The type of the thermal zone, such as `x86_pkg_temp`. |
11+
| `temp` | Current temperature in Celsius. |
1212

13-
## Configuration Parameters
13+
## Configuration parameters
1414

1515
The plugin supports the following configuration parameters:
1616

17-
| Key | Description |
18-
| :--- | :--- |
19-
| Interval\_Sec | Polling interval \(seconds\). default: 1 |
20-
| Interval\_NSec | Polling interval \(nanoseconds\). default: 0 |
21-
| name\_regex | Optional name filter regex. default: None |
22-
| type\_regex | Optional type filter regex. default: None |
23-
| Threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). Default: `false`. |
17+
| Key | Description | Default |
18+
| :--- | :--- | :--- |
19+
| `Interval_Sec` | Polling interval (seconds). | `1` |
20+
| `Interval_NSec` | Polling interval (nanoseconds). | `0` |
21+
| `name_regex` | Optional name filter regular expression. | _none_ |
22+
| `type_regex` | Optional type filter regular expression. | _none_ |
23+
| `Threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false`. |
24+
25+
## Get started
2426

25-
## Getting Started
27+
To get the temperature of your system, you can run the plugin from the command line or through the configuration file.
2628

27-
In order to get temperature\(s\) of your system, you can run the plugin from the command line or through the configuration file:
29+
### Command line
2830

29-
### Command Line
31+
Run Fluent Bit from the command line with the following command:
3032

31-
```shell
32-
$ ./fluent-bit -i thermal -t my_thermal -o stdout -m '*'
33+
```bash
34+
bin/fluent-bit -i thermal -t my_thermal -o stdout -m '*'
35+
```
36+
37+
You should see output similar to the following:
3338

34-
Fluent Bit v4.0.3
35-
* Copyright (C) 2015-2025 The Fluent Bit Authors
39+
```text
40+
Fluent Bit v1.x.x
41+
* Copyright (C) 2019-2020 The Fluent Bit Authors
42+
* Copyright (C) 2015-2018 Treasure Data
3643
* Fluent Bit is a CNCF sub-project under the umbrella of Fluentd
3744
* https://fluentbit.io
3845
@@ -59,15 +66,17 @@ ______ _ _ ______ _ _ ___ _____
5966
[2] my_thermal: [1566099586.000083156, {"name"=>"thermal_zone0", "type"=>"x86_pkg_temp", "temp"=>59.000000}]
6067
```
6168

62-
Some systems provide multiple thermal zones. In this example monitor only _thermal\_zone0_ by name, once per minute.
69+
Some systems provide multiple thermal zones. This example monitors only `thermal_zone0` by name, once per minute:
6370

64-
```shell
65-
$ ./fluent-bit -i thermal -t my_thermal -p "interval_sec=60" -p "name_regex=thermal_zone0" -o stdout -m '*'
71+
```bash
72+
bin/fluent-bit -i thermal -t my_thermal -p "interval_sec=60" -p "name_regex=thermal_zone0" -o stdout -m '*'
73+
```
6674

67-
Fluent Bit v4.0.3
68-
* Copyright (C) 2015-2025 The Fluent Bit Authors
69-
* Fluent Bit is a CNCF sub-project under the umbrella of Fluentd
70-
* https://fluentbit.io
75+
Which returns output similar to:
76+
77+
```text
78+
Fluent Bit v1.3.0
79+
Copyright (C) Treasure Data
7180
7281
______ _ _ ______ _ _ ___ _____
7382
| ___| | | | | ___ (_) | / || _ |
@@ -91,7 +100,7 @@ ______ _ _ ______ _ _ ___ _____
91100
[0] my_temp: [1565759602.001661061, {"name"=>"thermal_zone0", "type"=>"pch_skylake", "temp"=>48.500000}]
92101
```
93102

94-
### Configuration File
103+
### Configuration file
95104

96105
In your main configuration file append the following:
97106

0 commit comments

Comments
 (0)