From 3ac3c59fc559a9b72fb3e0600bd6b39e7ac03158 Mon Sep 17 00:00:00 2001 From: Lynette Miles Date: Tue, 22 Jul 2025 10:28:59 -0700 Subject: [PATCH 1/2] Pipeline: output: skywalking: style Signed-off-by: Lynette Miles --- pipeline/outputs/skywalking.md | 36 ++++++++++++++++-------------- vale-styles/FluentBit/Acronyms.yml | 1 + vale-styles/FluentBit/Headings.yml | 1 + 3 files changed, 21 insertions(+), 17 deletions(-) diff --git a/pipeline/outputs/skywalking.md b/pipeline/outputs/skywalking.md index f1f3b99bc..ec23d8701 100644 --- a/pipeline/outputs/skywalking.md +++ b/pipeline/outputs/skywalking.md @@ -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: @@ -56,11 +58,11 @@ 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 { @@ -68,7 +70,7 @@ For example, if we get log as follows, } ``` -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 [{ @@ -81,4 +83,4 @@ This message is packed into the following protocol format and written to the OAP } } }] -``` \ No newline at end of file +``` diff --git a/vale-styles/FluentBit/Acronyms.yml b/vale-styles/FluentBit/Acronyms.yml index c7422ef1a..84da45f44 100644 --- a/vale-styles/FluentBit/Acronyms.yml +++ b/vale-styles/FluentBit/Acronyms.yml @@ -68,6 +68,7 @@ exceptions: - NIC - NOTE - NVDA + - OAP - OSS - PATH - PEM diff --git a/vale-styles/FluentBit/Headings.yml b/vale-styles/FluentBit/Headings.yml index fb109ae38..57150e245 100644 --- a/vale-styles/FluentBit/Headings.yml +++ b/vale-styles/FluentBit/Headings.yml @@ -14,6 +14,7 @@ exceptions: - Amazon Kinesis Firehose - Amazon Kinesis Streams - Amazon OpenSearch Service + - Apache SkyWalking - API - APIs - AWS MSK IAM From f8efd23498dbea71044dbb67171e38fff1ddd6fc Mon Sep 17 00:00:00 2001 From: Lynette Miles <6818907+esmerel@users.noreply.github.com> Date: Tue, 22 Jul 2025 13:50:23 -0700 Subject: [PATCH 2/2] Update pipeline/outputs/skywalking.md Co-authored-by: Craig Norris <112565517+cnorris-cs@users.noreply.github.com> Signed-off-by: Lynette Miles <6818907+esmerel@users.noreply.github.com> --- pipeline/outputs/skywalking.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pipeline/outputs/skywalking.md b/pipeline/outputs/skywalking.md index ec23d8701..e2e4987a2 100644 --- a/pipeline/outputs/skywalking.md +++ b/pipeline/outputs/skywalking.md @@ -10,7 +10,7 @@ This plugin supports the following parameters: |:--------- |:----------- |:-----------| | `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_ | +| `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` |