Skip to content

Pipeline: output: skywalking: style #1973

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 22, 2025
+21 −17
Merged

Pipeline: output: skywalking: style #1973

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3ac3c59
Pipeline: output: skywalking: style
esmerel Jul 22, 2025
f8efd23
Update pipeline/outputs/skywalking.md
esmerel Jul 22, 2025
31c76d3
Merge branch 'master' into lynettemiles/sc-136265/update-fluent-bit-d…
esmerel Jul 22, 2025
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
36 changes: 19 additions & 17 deletions pipeline/outputs/skywalking.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,28 +1,30 @@
# Apache SkyWalking

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.
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.

## Configuration Parameters
## Configuration parameters

| parameter | description | default |
|:--------------|:---------------------------------------------------------------------------------------------------------------------|:-----------|
| host | Hostname of Apache SkyWalking OAP | 127.0.0.1 |
| port | TCP port of the Apache SkyWalking OAP | 12800 |
| auth_token | Authentication token if needed for Apache SkyWalking OAP | None |
| svc_name | Service name that fluent-bit belongs to | sw-service |
| svc_inst_name | Service instance name of fluent-bit | fluent-bit |
| workers | The number of [workers](../../administration/multithreading.md#outputs) to perform flush operations for this output. | `0` |
This plugin supports the following parameters:

| Parameter | Description | Default |
|:--------- |:----------- |:-----------|
| `host` | Hostname of Apache SkyWalking OAP. |` 127.0.0.1` |
| `port` | TCP port of the Apache SkyWalking OAP. | `12800` |
| `auth_token` | Authentication token if needed for Apache SkyWalking OAP. | _none_ |
| `svc_name` | Service name that Fluent Bit belongs to. | `sw-service` |
| `svc_inst_name` | Service instance name of Fluent Bit. | `fluent-bit` |
| `workers` | The number of [workers](../../administration/multithreading.md#outputs) to perform flush operations for this output. | `0` |

### TLS / SSL

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

## Getting Started
## Get started

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

### Configuration File
### Configuration file

In your main configuration file append the following:

Expand Down Expand Up @@ -56,19 +58,19 @@ pipeline:
{% endtab %}
{% endtabs %}

## Output Format
## Output format

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

For example, if we get log as follows,
For example, if the log is as follows:

```json
{
"log": "This is the original log message"
}
```

This message is packed into the following protocol format and written to the OAP via the REST API.
This message is packed into the following protocol format and written to the OAP using the REST API.

```json
[{
Expand All @@ -81,4 +83,4 @@ This message is packed into the following protocol format and written to the OAP
}
}
}]
```
```
1 change: 1 addition & 0 deletions vale-styles/FluentBit/Acronyms.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ exceptions:
- NIC
- NOTE
- NVDA
- OAP
- OSS
- PATH
- PEM
Expand Down
1 change: 1 addition & 0 deletions vale-styles/FluentBit/Headings.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ exceptions:
- Amazon Kinesis Firehose
- Amazon Kinesis Streams
- Amazon OpenSearch Service
- Apache SkyWalking
- Amazon S3
- Apache Arrow
- API
Expand Down