Project: APISIX (Orchestration & Management / API Gateway)
File: skywalking-logger.md

title: skywalking-logger keywords: Apache APISIX API Gateway Plugin SkyWalking Logger skywalking-logger description: This document contains information about the Apache APISIX skywalking-logger Plugin. <!-- --> The `skywalking-logger` Plugin can be used to push access log data to SkyWalking OAP server of HTTP. If there is an existing tracing context, it sets up the trace-log correlation automatically and relies on . This provides the ability to send access logs as JSON objects to the SkyWalking OAP server. | Name | Type | Required | Default | Valid values | Description | |--||-|||--| | endpoint_addr | string | True | | | URI of the SkyWalking OAP server. | | service_name | string | False | "APISIX" | | Service name for the SkyWalking reporter. | | serviceinstancename | string | False | "APISIX Instance Name" | | Service instance name for the SkyWalking reporter. Set it to `$hostname` to directly get the local hostname. | | log_format | object | False | | | Log format declared as key value pairs in JSON format. Values only support strings. or variables can be used by prefixing the string with `$`. | | timeout | integer | False | 3 | [1,...] | Time to keep the connection alive for after sending a request. | | name | string | False | "skywalking logger" | | Unique identifier to identify the logger. If you use Prometheus to monitor APISIX metrics, the name is exported in `apisixbatchprocess_entries`. | | includereqbody | boolean | False | false | [false, true] | When set to `true` includes the request body in the log. | | includereqbodyexpr | array | False | | | Filter for when the `includereq_body` attribute is set to `true`. Request body is only logged when the expression set here evaluates to `true`. See for more. | | includerespbody | boolean | False | false | [false, true] | When set to `true` includes the response body in the log. | | includerespbodyexpr | array | False | | | When the `includeresp_body` attribute is set to `true`, use this to filter based on . If present, only logs the response if the expression evaluates to `true`. | This Plugin supports using batch processors to aggregate and process entries (logs/data) in a batch. This avoids the need for frequently submitting the data. The batch processor submits data every `5` seconds or when the data in the queue reaches

See for more information or setting your custom configuration. ```json { "serviceInstance": "APISIX Instance Name", "body": { "json": { "json": "body-json" } }, "endpoint": "/opentracing", "service": "APISIX" } ``` For body-json data, it is an escaped json string ```json { "response": { "status": 200, "headers": { "server": "APISIX/3.7.0", "content-type": "text/plain", "transfer-encoding": "chunked", "connection": "close" }, "size": 136 }, "route_id": "1", "upstream": "127.0.0.1:1982", "upstream_latency": 8, "apisix_latency": 101.00020599365, "client_ip": "127.0.0.1", "service_id": "", "server": { "hostname": "localhost", "version": "3.7.0" }, "start_time": 1704429712768, "latency": 109.00020599365, "request": { "headers": { "content-length": "9", "host": "localhost", "connection": "close" }, "method": "POST", "body": "body-data", "size": 94, "querystring": {}, "url": "http://localhost:1984/opentracing", "uri": "/opentracing" } } ``` You can also set the format of the logs by configuring the Plugin metadata. The following configurations are available: | Name | Type | Required | Default | Description | | - | | -- | -- | - | | log_format | object | False | | Log format declared as key value pairs in JSON format. Values only support strings. or variables can be used by prefixing the string with `$`. | :::info IMPORTANT Configuring the Plugin metadata is global in scope. This means that it will take effect on all Routes and Services which use the `skywalking-logger` Plugin. ::: The example below shows how you can configure through the Admin API: :::note You can fetch the `admin_key` from `config.yaml` and save to an environment variable with the following command: ```bash adminkey=$(yq '.deployment.admin.adminkey[0].key' conf/config.yaml | sed 's/"//g') ``` ::: ```shell curl http://127.0.0.1:9180/apisix/admin/pluginmetadata/skywalking-logger -H "X-API-KEY: $adminkey" -X PUT -d ' { "log_format": { "host": "$host", "@timestamp": "$time_iso8601", "clientip": "$remoteaddr" } }' ``` With this configuration, your logs would be formatted as shown below: ```shell {"host":"localhost","@timestamp":"2020-09-23T19:05:05-04:00","clientip":"127.0.0.1","routeid":"1"} {"host":"localhost","@timestamp":"2020-09-23T19:05:05-04:00","clientip":"127.0.0.1","routeid":"1"} ``` Once you have set up your SkyWalking OAP server, you can enable the Plugin on a specific Route as shown below: ```shell curl http://127.0.0.1:9180/apisix/admin/routes/1 -H "X-API-KEY: $admin_key" -X PUT -d ' { "plugins": { "skywalking-logger": { "endpoint_addr": "http://127.0.0.1:12800" } }, "upstream": { "type": "roundrobin", "nodes": { "127.0.0.1:1980": 1 } }, "uri": "/hello" }' ``` Now, if you make a request to APISIX, it will be logged in your SkyWalking OAP server: ```shell curl -i http://127.0.0.1:9080/hello ``` To remove the `skywalking-logger` Plugin, you can delete the corresponding JSON configuration from the Plugin configuration. APISIX will automatically reload and you do not have to restart for this to take effect. ```shell curl http://127.0.0.1:9180/apisix/admin/routes/1 -H "X-API-KEY: $admin_key" -X PUT -d ' { "uri": "/hello", "plugins": {}, "upstream": { "type": "roundrobin", "nodes": { "127.0.0.1:1980": 1 } } }' ```