Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 39 additions & 30 deletions pipeline/inputs/thermal.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,45 @@
# Thermal

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

The following tables describes the information generated by the plugin.
The following table describes the information generated by the plugin:

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

## Configuration Parameters
## Configuration parameters

The plugin supports the following configuration parameters:

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

## Get started

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

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

### Command Line
Run Fluent Bit from the command line with the following command:

```shell
$ ./fluent-bit -i thermal -t my_thermal -o stdout -m '*'
```bash
bin/fluent-bit -i thermal -t my_thermal -o stdout -m '*'
```

You should see output similar to the following:

Fluent Bit v4.0.3
* Copyright (C) 2015-2025 The Fluent Bit Authors
```text
Fluent Bit v1.x.x
* Copyright (C) 2019-2020 The Fluent Bit Authors
* Copyright (C) 2015-2018 Treasure Data
* Fluent Bit is a CNCF sub-project under the umbrella of Fluentd
* https://fluentbit.io

Expand All @@ -59,15 +66,17 @@ ______ _ _ ______ _ _ ___ _____
[2] my_thermal: [1566099586.000083156, {"name"=>"thermal_zone0", "type"=>"x86_pkg_temp", "temp"=>59.000000}]
```

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

```shell
$ ./fluent-bit -i thermal -t my_thermal -p "interval_sec=60" -p "name_regex=thermal_zone0" -o stdout -m '*'
```bash
bin/fluent-bit -i thermal -t my_thermal -p "interval_sec=60" -p "name_regex=thermal_zone0" -o stdout -m '*'
```

Fluent Bit v4.0.3
* Copyright (C) 2015-2025 The Fluent Bit Authors
* Fluent Bit is a CNCF sub-project under the umbrella of Fluentd
* https://fluentbit.io
Which returns output similar to:

```text
Fluent Bit v1.3.0
Copyright (C) Treasure Data

______ _ _ ______ _ _ ___ _____
| ___| | | | | ___ (_) | / || _ |
Expand All @@ -91,7 +100,7 @@ ______ _ _ ______ _ _ ___ _____
[0] my_temp: [1565759602.001661061, {"name"=>"thermal_zone0", "type"=>"pch_skylake", "temp"=>48.500000}]
```

### Configuration File
### Configuration file

In your main configuration file append the following:

Expand Down