Skip to content

Commit 6445769

Browse files
committed
Pipeline: inputs: mqtt: style
Signed-off-by: Lynette Miles <[email protected]>
1 parent 4ea5e13 commit 6445769

File tree

2 files changed

+23
-15
lines changed

2 files changed

+23
-15
lines changed

pipeline/inputs/mqtt.md

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,35 @@
11
# MQTT
22

3-
The **MQTT** input plugin, allows to retrieve messages/data from MQTT control packets over a TCP connection. The incoming data to receive _must_ be a JSON map.
3+
The _MQTT_ input plugin retrieves messages and data from MQTT control packets over a TCP connection. The incoming data to receive must be a JSON map.
44

5-
## Configuration Parameters
5+
## Configuration parameters
66

77
The plugin supports the following configuration parameters:
88

99
| Key | Description | Default |
1010
| :---------- | :------------------------------------------------------------- | :------ |
11-
| Listen | Listener network interface. | `0.0.0.0` |
12-
| Port | TCP port where listening for connections. | `1883` |
13-
| Payload_Key | Specify the key where the payload key/value will be preserved. | _none_ |
14-
| Threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
11+
| `Listen` | Listener network interface. | `0.0.0.0` |
12+
| `Port` | TCP port where listening for connections. | `1883` |
13+
| `Payload_Key` | Specify the key where the payload key/value will be preserved. | _none_ |
14+
| `Threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
1515

16-
## Getting Started
16+
## Get started
1717

18-
In order to start listening for MQTT messages, you can run the plugin from the command line or through the configuration file:
18+
To listen for MQTT messages, you can run the plugin from the command line or through the configuration file.
1919

20-
### Command Line
20+
### Command line
2121

22-
Since the **MQTT** input plugin let Fluent Bit behave as a server, we need to dispatch some messages using some MQTT client, in the following example _mosquitto_ tool is being used for the purpose:
22+
The MQTT input plugin lets Fluent Bit behave as a server. Dispatch some messages using a MQTT client. In the following example `mosquitto` tool is being used for the purpose:
23+
24+
Running the following command:
2325

2426
```bash
25-
$ fluent-bit -i mqtt -t data -o stdout -m '*'
27+
fluent-bit -i mqtt -t data -o stdout -m '*'
28+
```
29+
30+
Returns a response like the following:
31+
32+
```text
2633
Fluent Bit v1.x.x
2734
* Copyright (C) 2019-2020 The Fluent Bit Authors
2835
* Copyright (C) 2015-2018 Treasure Data
@@ -33,15 +40,15 @@ Fluent Bit v1.x.x
3340
[0] data: [1463775773, {"topic"=>"some/topic", "key1"=>123, "key2"=>456}]
3441
```
3542

36-
The following command line will send a message to the **MQTT** input plugin:
43+
The following command line will send a message to the MQTT input plugin:
3744

3845
```bash
39-
$ mosquitto_pub -m '{"key1": 123, "key2": 456}' -t some/topic
46+
mosquitto_pub -m '{"key1": 123, "key2": 456}' -t some/topic
4047
```
4148

42-
### Configuration File
49+
### Configuration file
4350

44-
In your main configuration file append the following _Input_ & _Output_ sections:
51+
In your main configuration file append the following `Input` and `Output` sections:
4552

4653
```python
4754
[INPUT]

vale-styles/FluentBit/Acronyms.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ exceptions:
5252
- LLDB
5353
- LLVM
5454
- LTS
55+
- MQTT
5556
- NET
5657
- NOTE
5758
- NVDA

0 commit comments

Comments
 (0)