Skip to content

Commit f7a7cc2

Browse files
authored
Merge pull request #1973 from fluent/lynettemiles/sc-136265/update-fluent-bit-docs-pipeline-outputs-skywalking
2 parents f4ae065 + 31c76d3 commit f7a7cc2

File tree

3 files changed

+21
-17
lines changed

3 files changed

+21
-17
lines changed

pipeline/outputs/skywalking.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,30 @@
11
# Apache SkyWalking
22

3-
The **Apache SkyWalking** output plugin, allows to flush your records to an [Apache SkyWalking](https://skywalking.apache.org/) OAP. The following instructions assumes that you have a fully operational Apache SkyWalking OAP in place.
3+
The _Apache SkyWalking_ output plugin lets you flush your records to an [Apache SkyWalking](https://skywalking.apache.org/) OAP. The following instructions assume that you have an operational Apache SkyWalking OAP in place.
44

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

7-
| parameter | description | default |
8-
|:--------------|:---------------------------------------------------------------------------------------------------------------------|:-----------|
9-
| host | Hostname of Apache SkyWalking OAP | 127.0.0.1 |
10-
| port | TCP port of the Apache SkyWalking OAP | 12800 |
11-
| auth_token | Authentication token if needed for Apache SkyWalking OAP | None |
12-
| svc_name | Service name that fluent-bit belongs to | sw-service |
13-
| svc_inst_name | Service instance name of fluent-bit | fluent-bit |
14-
| workers | The number of [workers](../../administration/multithreading.md#outputs) to perform flush operations for this output. | `0` |
7+
This plugin supports the following parameters:
8+
9+
| Parameter | Description | Default |
10+
|:--------- |:----------- |:-----------|
11+
| `host` | Hostname of Apache SkyWalking OAP. |` 127.0.0.1` |
12+
| `port` | TCP port of the Apache SkyWalking OAP. | `12800` |
13+
| `auth_token` | Authentication token if needed for Apache SkyWalking OAP. | _none_ |
14+
| `svc_name` | Service name that Fluent Bit belongs to. | `sw-service` |
15+
| `svc_inst_name` | Service instance name of Fluent Bit. | `fluent-bit` |
16+
| `workers` | The number of [workers](../../administration/multithreading.md#outputs) to perform flush operations for this output. | `0` |
1517

1618
### TLS / SSL
1719

1820
The Apache SkyWalking output plugin supports TLS/SSL.
1921
For more details about the properties available and general configuration, see [TLS/SSL](../../administration/transport-security.md).
2022

21-
## Getting Started
23+
## Get started
2224

23-
In order to start inserting records into an Apache SkyWalking service, you can run the plugin through the configuration file:
25+
To start inserting records into an Apache SkyWalking service, you can run the plugin through the configuration file.
2426

25-
### Configuration File
27+
### Configuration file
2628

2729
In your main configuration file append the following:
2830

@@ -56,19 +58,19 @@ pipeline:
5658
{% endtab %}
5759
{% endtabs %}
5860

59-
## Output Format
61+
## Output format
6062

6163
The format of the plugin output follows the [data collect protocol](https://github.com/apache/skywalking-data-collect-protocol/blob/743f33119dc5621ae98b596eb8b131dd443445c7/logging/Logging.proto).
6264

63-
For example, if we get log as follows,
65+
For example, if the log is as follows:
6466

6567
```json
6668
{
6769
"log": "This is the original log message"
6870
}
6971
```
7072

71-
This message is packed into the following protocol format and written to the OAP via the REST API.
73+
This message is packed into the following protocol format and written to the OAP using the REST API.
7274

7375
```json
7476
[{
@@ -81,4 +83,4 @@ This message is packed into the following protocol format and written to the OAP
8183
}
8284
}
8385
}]
84-
```
86+
```

vale-styles/FluentBit/Acronyms.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ exceptions:
7373
- NIC
7474
- NOTE
7575
- NVDA
76+
- OAP
7677
- OSS
7778
- PATH
7879
- PEM

vale-styles/FluentBit/Headings.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ exceptions:
1616
- Amazon Kinesis Firehose
1717
- Amazon Kinesis Streams
1818
- Amazon OpenSearch Service
19+
- Apache SkyWalking
1920
- Amazon S3
2021
- Apache Arrow
2122
- API

0 commit comments

Comments
 (0)