# SkyWalking Logger Configuration

The `skywalking-logger` plugin sends customizable APISIX and API7 Gateway request and response logs to a SkyWalking OAP server in batches for analysis.<!-- --> <!-- -->Configuration covers plugin parameters and plugin metadata.

## Parameters[​](#parameters "Direct link to Parameters")

See plugin [common configurations](https://docs.api7.ai/apisix/reference/plugin-common-configurations.md) for configuration options available to all plugins.

* endpoint\_addr

  string

  required

  ***

  URI of the SkyWalking OAP server.

* service\_name

  string

  default: `APISIX`

  ***

  Service name for the SkyWalking reporter.

* service\_instance\_name

  string

  default: `APISIX Instance Name`

  ***

  Service instance name for the SkyWalking reporter. Set to `$hostname` to get the local hostname.

* timeout

  integer

  default: `3`

  valid value:

  greater than 0

  ***

  Socket timeout in seconds applied to connect, write, and read operations when sending logs to the SkyWalking OAP server.

* log\_format

  object

  ***

  Custom log format using key-value pairs in JSON format. Values can reference [built-in variables](https://docs.api7.ai/apisix/reference/built-in-variables.md).

  If `include_req_body` or `include_resp_body` is true, reference `$request_body` or `$resp_body` to add the collected body to the custom log entry. The options do not add body fields to a custom format automatically.

  In APISIX from 3.15.0, log format nested structures are supported up to five levels deep. In API7 Enterprise, only flat key-value structures are supported; nested structures are not yet supported.

  You can also configure log format on a global scale using the [plugin metadata](https://docs.api7.ai/apisix/key-concepts/plugin-metadata.md), which configures the log format for all `skywalking-logger` plugin instances. If the log format configured on the individual plugin instance differs from the log format configured on plugin metadata, the log format configured on the individual plugin instance takes precedence. See the [example](https://docs.api7.ai/hub/skywalking-logger.md#log-request-and-response-headers-with-plugin-metadata) for more details.

* log\_format\_extra

  object

  ***

  Additional fields to add to the default log entry, using key-value pairs in JSON format. Values can reference [built-in variables](https://docs.api7.ai/apisix/reference/built-in-variables.md). A configured field does not overwrite an existing default field. A plugin instance takes precedence over plugin metadata; setting an empty object on the instance disables the metadata value. When `log_format` is configured, `log_format_extra` is ignored.

  Introduced in API7 Enterprise 3.9.15 and 3.10.2, and APISIX 3.18.0.

* include\_req\_body

  boolean

  default: `false`

  ***

  If true, collect and include the request body in the default log fields. Request bodies buffered in memory or a temporary file can be logged, and `max_req_body_bytes` limits the logged body size.

* include\_req\_body\_expr

  array\[array]

  ***

  An array of one or more conditions in the form of [APISIX expressions](https://docs.api7.ai/apisix/reference/apisix-expressions.md). When `include_req_body` is true, the expressions control proactive body reading and the `request.body` field in the default log format. A custom `log_format` or `log_format_extra` field that references `$request_body` can still include a body already buffered by NGINX when the expressions evaluate to false. Do not use this option as a data-redaction boundary.

* include\_resp\_body

  boolean

  default: `false`

  ***

  If true, include the response body in the log.

* include\_resp\_body\_expr

  array\[array]

  ***

  An array of one or more conditions in the form of [APISIX expressions](https://docs.api7.ai/apisix/reference/apisix-expressions.md). Used when the `include_resp_body` is true. Response body would only be logged when the expressions configured here evaluate to true.

* max\_req\_body\_bytes

  integer

  default: `524288`

  valid value:

  greater than or equal to 1

  ***

  Maximum request body size in bytes to include in the log. If the request body exceeds this value, it will be truncated. Available in APISIX from 3.16.0.

* max\_resp\_body\_bytes

  integer

  default: `524288`

  valid value:

  greater than or equal to 1

  ***

  Maximum response body size in bytes to include in the log. If the response body exceeds this value, it will be truncated. Available in APISIX from 3.16.0.

* name

  string

  default: `skywalking logger`

  ***

  Unique identifier of the plugin for the batch processor. If you use [Prometheus](https://docs.api7.ai/hub/prometheus.md) to monitor APISIX metrics, the name is exported in `apisix_batch_process_entries`.

* batch\_max\_size

  integer

  default: `1000`

  valid value:

  greater than 0

  ***

  The number of log entries allowed in one batch. Once reached, the batch will be sent to the logging service. Setting this parameter to 1 means immediate processing.

* inactive\_timeout

  integer

  default: `5`

  valid value:

  greater than 0

  ***

  The maximum time in seconds to wait for new logs before sending the batch to the logging service. The value should be smaller than `buffer_duration`.

* buffer\_duration

  integer

  default: `60`

  valid value:

  greater than 0

  ***

  The maximum time in seconds from the earliest entry allowed before sending the batch to the logging service.

* retry\_delay

  integer

  default: `1`

  valid value:

  greater than or equal to 0

  ***

  The time interval in seconds to retry sending the batch to the logging service if the batch was not successfully sent.

* max\_retry\_count

  integer

  default: `0`

  valid value:

  greater than or equal to 0

  ***

  The maximum number of unsuccessful retries allowed before dropping the log entries.

## Plugin Metadata[​](#plugin-metadata "Direct link to Plugin Metadata")

* log\_format

  object

  ***

  Custom log format using key-value pairs in JSON format. Values can reference [built-in variables](https://docs.api7.ai/apisix/reference/built-in-variables.md).

  In APISIX from 3.15.0, log format nested structures are supported up to five levels deep. In API7 Enterprise, only flat key-value structures are supported; nested structures are not yet supported.

* log\_format\_extra

  object

  ***

  Additional fields to add to the default log entry, using key-value pairs in JSON format. Values can reference [built-in variables](https://docs.api7.ai/apisix/reference/built-in-variables.md). A configured field does not overwrite an existing default field. A plugin instance takes precedence over plugin metadata; setting an empty object on the instance disables the metadata value. When `log_format` is configured, `log_format_extra` is ignored.

  Introduced in API7 Enterprise 3.9.15 and 3.10.2, and APISIX 3.18.0.

* max\_pending\_entries

  integer

  default: `8192`

  valid value:

  greater than or equal to 1

  ***

  Maximum number of entries waiting in the batch processor. New entries are discarded when the backlog reaches the limit.

  Introduced in API7 Enterprise 3.8.17 and APISIX 3.15.0.

  The default changed to `8192` in APISIX 3.18.0 and in API7 Enterprise 3.9.19 on the 3.9 line and 3.10.6 on the 3.10 line. In API7 Enterprise 3.9.18 and 3.10.5, and in earlier APISIX versions, omitting the parameter leaves the backlog unlimited.

  See [Batch Processor](https://docs.api7.ai/apisix/reference/batch-processor.md#configure-the-pending-entry-limit) for sizing and verification guidance.
