Skip to content

Commit 5ff4f11

Browse files
committed
Pipeline: input: thermal: style
Signed-off-by: Lynette Miles <[email protected]>
1 parent 69f4bbe commit 5ff4f11

File tree

1 file changed

+49
-34
lines changed

1 file changed

+49
-34
lines changed

pipeline/inputs/thermal.md

Lines changed: 49 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,42 @@
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 only available 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

3133
```bash
32-
$ bin/fluent-bit -i thermal -t my_thermal -o stdout -m '*'
34+
bin/fluent-bit -i thermal -t my_thermal -o stdout -m '*'
35+
```
36+
37+
You should see output similar to the following:
38+
39+
```text
3340
Fluent Bit v1.x.x
3441
* Copyright (C) 2019-2020 The Fluent Bit Authors
3542
* Copyright (C) 2015-2018 Treasure Data
@@ -43,10 +50,15 @@ Fluent Bit v1.x.x
4350
[2] my_thermal: [1566099586.000083156, {"name"=>"thermal_zone0", "type"=>"x86_pkg_temp", "temp"=>59.000000}]
4451
```
4552

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

4855
```bash
49-
$ bin/fluent-bit -i thermal -t my_thermal -p "interval_sec=60" -p "name_regex=thermal_zone0" -o stdout -m '*'
56+
bin/fluent-bit -i thermal -t my_thermal -p "interval_sec=60" -p "name_regex=thermal_zone0" -o stdout -m '*'
57+
```
58+
59+
Which returns output similar to:
60+
61+
```text
5062
Fluent Bit v1.3.0
5163
Copyright (C) Treasure Data
5264
@@ -56,12 +68,26 @@ Copyright (C) Treasure Data
5668
[0] my_temp: [1565759602.001661061, {"name"=>"thermal_zone0", "type"=>"pch_skylake", "temp"=>48.500000}]
5769
```
5870

59-
### Configuration File
71+
### Configuration file
6072

61-
In your main configuration file append the following _Input_ & _Output_ sections:
73+
In your main configuration file append the following sections:
6274

6375
{% tabs %}
76+
{% tab title="fluent-bit.yaml" %}
77+
78+
```yaml
79+
pipeline:
80+
inputs:
81+
- name: thermal
82+
tag: my_thermal
83+
outputs:
84+
- name: stdout
85+
match: '*'
86+
```
87+
88+
{% endtab %}
6489
{% tab title="fluent-bit.conf" %}
90+
6591
```python
6692
[INPUT]
6793
Name thermal
@@ -71,17 +97,6 @@ In your main configuration file append the following _Input_ & _Output_ sections
7197
Name stdout
7298
Match *
7399
```
74-
{% endtab %}
75100

76-
{% tab title="fluent-bit.yaml" %}
77-
```yaml
78-
pipeline:
79-
inputs:
80-
- name: thermal
81-
tag: my_thermal
82-
outputs:
83-
- name: stdout
84-
match: '*'
85-
```
86101
{% endtab %}
87102
{% endtabs %}

0 commit comments

Comments
 (0)