This is an automated email from the ASF dual-hosted git repository.
monkeydluffy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix.git
The following commit(s) were added to refs/heads/master by this push:
new a992cd80a docs: populate default log_format for logging plugins (#9516)
a992cd80a is described below
commit a992cd80a8a7dd2fd258b82d414ea34c371e5b12
Author: Arghya Das <[email protected]>
AuthorDate: Thu May 25 06:57:30 2023 +0530
docs: populate default log_format for logging plugins (#9516)
---
docs/en/latest/plugins/clickhouse-logger.md | 2 +-
docs/en/latest/plugins/elasticsearch-logger.md | 2 +-
docs/en/latest/plugins/google-cloud-logging.md | 2 +-
docs/en/latest/plugins/http-logger.md | 2 +-
docs/en/latest/plugins/kafka-logger.md | 2 +-
docs/en/latest/plugins/loggly.md | 2 +-
docs/en/latest/plugins/rocketmq-logger.md | 2 +-
docs/en/latest/plugins/skywalking-logger.md | 2 +-
docs/en/latest/plugins/splunk-hec-logging.md | 2 +-
docs/en/latest/plugins/syslog.md | 2 +-
docs/en/latest/plugins/tcp-logger.md | 2 +-
docs/en/latest/plugins/tencent-cloud-cls.md | 2 +-
docs/en/latest/plugins/udp-logger.md | 2 +-
13 files changed, 13 insertions(+), 13 deletions(-)
diff --git a/docs/en/latest/plugins/clickhouse-logger.md
b/docs/en/latest/plugins/clickhouse-logger.md
index 8b6067d0a..10d359ca6 100644
--- a/docs/en/latest/plugins/clickhouse-logger.md
+++ b/docs/en/latest/plugins/clickhouse-logger.md
@@ -44,7 +44,7 @@ The `clickhouse-logger` Plugin is used to push logs to
[ClickHouse](https://clic
| timeout | integer | False | 3 | [1,...] |
Time to keep the connection alive for after sending a request. |
| name | string | False | "clickhouse logger" | |
Unique identifier for the logger. |
| ssl_verify | boolean | False | true | [true,false] |
When set to `true`, verifies SSL. |
-| log_format | object | False | | | Log
format declared as key value pairs in JSON format. Values only support strings.
[APISIX](../apisix-variable.md) or
[Nginx](http://nginx.org/en/docs/varindex.html) variables can be used by
prefixing the string with `$`. |
+| log_format | object | False | {"host": "$host", "@timestamp":
"$time_iso8601", "client_ip": "$remote_addr"} | | Log format
declared as key value pairs in JSON format. Values only support strings.
[APISIX](../apisix-variable.md) or
[Nginx](http://nginx.org/en/docs/varindex.html) variables can be used by
prefixing the string with `$`. |
| include_req_body | boolean | False | false | [false, true]
| When set to `true` includes the request body in the log. If the
request body is too big to be kept in the memory, it can't be logged due to
Nginx's limitations.
|
| include_req_body_expr | array | False | |
| Filter for when the `include_req_body` attribute is set to `true`.
Request body is only logged when the expression set here evaluates to `true`.
See [lua-resty-expr](https://github.com/api7/lua-resty-expr) for more.
|
| include_resp_body | boolean | False | false | [false, true]
| When set to `true` includes the response body in the log.
|
diff --git a/docs/en/latest/plugins/elasticsearch-logger.md
b/docs/en/latest/plugins/elasticsearch-logger.md
index f93521e50..36cc97229 100644
--- a/docs/en/latest/plugins/elasticsearch-logger.md
+++ b/docs/en/latest/plugins/elasticsearch-logger.md
@@ -42,7 +42,7 @@ When the Plugin is enabled, APISIX will serialize the request
context informatio
| field | array | True | |
Elasticsearch `field` configuration. |
| field.index | string | True | |
Elasticsearch [_index
field](https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-index-field.html#mapping-index-field).
|
| field.type | string | False | Elasticsearch default value |
Elasticsearch [_type
field](https://www.elastic.co/guide/en/elasticsearch/reference/7.17/mapping-type-field.html#mapping-type-field).
|
-| log_format | object | False | | Log format declared as key value
pairs in JSON format. Values only support strings.
[APISIX](../apisix-variable.md) or
[Nginx](http://nginx.org/en/docs/varindex.html) variables can be used by
prefixing the string with `$`. |
+| log_format | object | False | {"host": "$host", "@timestamp":
"$time_iso8601", "client_ip": "$remote_addr"} | Log format declared as key
value pairs in JSON format. Values only support strings.
[APISIX](../apisix-variable.md) or
[Nginx](http://nginx.org/en/docs/varindex.html) variables can be used by
prefixing the string with `$`. |
| auth | array | False | |
Elasticsearch
[authentication](https://www.elastic.co/guide/en/elasticsearch/reference/current/setting-up-authentication.html)
configuration. |
| auth.username | string | True | |
Elasticsearch
[authentication](https://www.elastic.co/guide/en/elasticsearch/reference/current/setting-up-authentication.html)
username. |
| auth.password | string | True | |
Elasticsearch
[authentication](https://www.elastic.co/guide/en/elasticsearch/reference/current/setting-up-authentication.html)
password. |
diff --git a/docs/en/latest/plugins/google-cloud-logging.md
b/docs/en/latest/plugins/google-cloud-logging.md
index 79adec8e2..31d3f1461 100644
--- a/docs/en/latest/plugins/google-cloud-logging.md
+++ b/docs/en/latest/plugins/google-cloud-logging.md
@@ -46,7 +46,7 @@ This plugin also allows to push logs as a batch to your
Google Cloud Logging Ser
| ssl_verify | False | true
|
When set to `true`, enables SSL verification as mentioned in [OpenResty
docs](https://github.com/openresty/lua-nginx-module#tcpsocksslhandshake).
|
| resource | False | {"type": "global"}
|
Google monitor resource. See
[MonitoredResource](https://cloud.google.com/logging/docs/reference/v2/rest/v2/MonitoredResource)
for more details. |
| log_id | False | apisix.apache.org%2Flogs
|
Google Cloud logging ID. See
[LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry)
for details. |
-| log_format | False | | Log format
declared as key value pairs in JSON format. Values only support strings.
[APISIX](../apisix-variable.md) or
[Nginx](http://nginx.org/en/docs/varindex.html) variables can be used by
prefixing the string with `$`. |
+| log_format | False | {"host": "$host", "@timestamp":
"$time_iso8601", "client_ip": "$remote_addr"} | Log format declared as key
value pairs in JSON format. Values only support strings.
[APISIX](../apisix-variable.md) or
[Nginx](http://nginx.org/en/docs/varindex.html) variables can be used by
prefixing the string with `$`. |
NOTE: `encrypt_fields = {"auth_config.private_key"}` is also defined in the
schema, which means that the field will be stored encrypted in etcd. See
[encrypted storage fields](../plugin-develop.md#encrypted-storage-fields).
diff --git a/docs/en/latest/plugins/http-logger.md
b/docs/en/latest/plugins/http-logger.md
index da5dfcd74..f9a8cc4b6 100644
--- a/docs/en/latest/plugins/http-logger.md
+++ b/docs/en/latest/plugins/http-logger.md
@@ -40,7 +40,7 @@ This will allow the ability to send log data requests as JSON
objects to monitor
| uri | string | True | |
| URI of the HTTP/HTTPS server.
|
| auth_header | string | False | |
| Authorization headers if required.
|
| timeout | integer | False | 3 | [1,...]
| Time to keep the connection alive for after sending a request.
|
-| log_format | object | False | | | Log format declared
as key value pairs in JSON format. Values only support strings.
[APISIX](../apisix-variable.md) or
[Nginx](http://nginx.org/en/docs/varindex.html) variables can be used by
prefixing the string with `$`. |
+| log_format | object | False | {"host": "$host", "@timestamp":
"$time_iso8601", "client_ip": "$remote_addr"} | | Log format
declared as key value pairs in JSON format. Values only support strings.
[APISIX](../apisix-variable.md) or
[Nginx](http://nginx.org/en/docs/varindex.html) variables can be used by
prefixing the string with `$`. |
| include_req_body | boolean | False | false | [false, true]
| When set to `true` includes the request body in the log. If the request
body is too big to be kept in the memory, it can't be logged due to Nginx's
limitations. |
| include_resp_body | boolean | False | false | [false, true]
| When set to `true` includes the response body in the log.
|
| include_resp_body_expr | array | False | |
| When the `include_resp_body` attribute is set to `true`, use this to
filter based on [lua-resty-expr](https://github.com/api7/lua-resty-expr). If
present, only logs the response if the expression evaluates to `true`. |
diff --git a/docs/en/latest/plugins/kafka-logger.md
b/docs/en/latest/plugins/kafka-logger.md
index aebd43813..11f0e8212 100644
--- a/docs/en/latest/plugins/kafka-logger.md
+++ b/docs/en/latest/plugins/kafka-logger.md
@@ -52,7 +52,7 @@ It might take some time to receive the log data. It will be
automatically sent a
| timeout | integer | False | 3 | [1,...]
| Timeout for the upstream to send data.
|
| name | string | False | "kafka logger" |
| Unique identifier for the batch processor.
|
| meta_format | enum | False | "default" |
["default"，"origin"] | Format to collect the request information. Setting to
`default` collects the information in JSON format and `origin` collects the
information with the original HTTP request. See
[examples](#meta_format-example) below.
|
-| log_format | object | False | | | Log format declared
as key value pairs in JSON format. Values only support strings.
[APISIX](../apisix-variable.md) or
[Nginx](http://nginx.org/en/docs/varindex.html) variables can be used by
prefixing the string with `$`. |
+| log_format | object | False | {"host": "$host", "@timestamp":
"$time_iso8601", "client_ip": "$remote_addr"} | | Log format
declared as key value pairs in JSON format. Values only support strings.
[APISIX](../apisix-variable.md) or
[Nginx](http://nginx.org/en/docs/varindex.html) variables can be used by
prefixing the string with `$`. |
| include_req_body | boolean | False | false | [false, true]
| When set to `true` includes the request body in the log. If the
request body is too big to be kept in the memory, it can't be logged due to
Nginx's limitations.
|
| include_req_body_expr | array | False | |
| Filter for when the `include_req_body` attribute is set to `true`.
Request body is only logged when the expression set here evaluates to `true`.
See [lua-resty-expr](https://github.com/api7/lua-resty-expr) for more.
|
| include_resp_body | boolean | False | false | [false, true]
| When set to `true` includes the response body in the log.
|
diff --git a/docs/en/latest/plugins/loggly.md b/docs/en/latest/plugins/loggly.md
index ea949a92d..e7035da03 100644
--- a/docs/en/latest/plugins/loggly.md
+++ b/docs/en/latest/plugins/loggly.md
@@ -43,7 +43,7 @@ When the maximum batch size is exceeded, the data in the
queue is pushed to Logg
| severity | string (enum) | False | INFO | Syslog log
event severity level. Choose between: `DEBUG`, `INFO`, `NOTICE`, `WARNING`,
`ERR`, `CRIT`, `ALERT`, and `EMEGR`.
|
| severity_map | object | False | nil | A way to map
upstream HTTP response codes to Syslog severity. Key-value pairs where keys are
the HTTP response codes and the values are the Syslog severity levels. For
example `{"410": "CRIT"}`. |
| tags | array | False | | Metadata to be
included with any event log to aid in segmentation and filtering.
|
-| log_format | object | False | | Log format declared
as key value pairs in JSON format. Values only support strings.
[APISIX](../apisix-variable.md) or
[Nginx](http://nginx.org/en/docs/varindex.html) variables can be used by
prefixing the string with `$`. |
+| log_format | object | False | {"host": "$host", "@timestamp":
"$time_iso8601", "client_ip": "$remote_addr"} | Log format declared as key
value pairs in JSON format. Values only support strings.
[APISIX](../apisix-variable.md) or
[Nginx](http://nginx.org/en/docs/varindex.html) variables can be used by
prefixing the string with `$`. |
| include_req_body | boolean | False | false | When set to
`true` includes the request body in the log. If the request body is too big to
be kept in the memory, it can't be logged due to Nginx's limitations.
|
| include_resp_body | boolean | False | false | When set to
`true` includes the response body in the log.
|
| include_resp_body_expr | array | False | | When the
`include_resp_body` attribute is set to `true`, use this to filter based on
[lua-resty-expr](https://github.com/api7/lua-resty-expr). If present, only logs
the response if the expression evaluates to `true`. |
diff --git a/docs/en/latest/plugins/rocketmq-logger.md
b/docs/en/latest/plugins/rocketmq-logger.md
index b5d088d53..9a3eb158d 100644
--- a/docs/en/latest/plugins/rocketmq-logger.md
+++ b/docs/en/latest/plugins/rocketmq-logger.md
@@ -40,7 +40,7 @@ It might take some time to receive the log data. It will be
automatically sent a
| topic | string | True | |
| Target topic to push the data to.
|
| key | string | False | |
| Key of the messages.
|
| tag | string | False | |
| Tag of the messages.
|
-| log_format | object | False | | | Log format declared
as key value pairs in JSON format. Values only support strings.
[APISIX](../apisix-variable.md) or
[Nginx](http://nginx.org/en/docs/varindex.html) variables can be used by
prefixing the string with `$`. |
+| log_format | object | False | {"host": "$host", "@timestamp":
"$time_iso8601", "client_ip": "$remote_addr"} | | Log format
declared as key value pairs in JSON format. Values only support strings.
[APISIX](../apisix-variable.md) or
[Nginx](http://nginx.org/en/docs/varindex.html) variables can be used by
prefixing the string with `$`. |
| timeout | integer | False | 3 | [1,...]
| Timeout for the upstream to send data.
|
| use_tls | boolean | False | false |
| When set to `true`, uses TLS.
|
| access_key | string | False | "" |
| Access key for ACL. Setting to an empty string will disable the
ACL.
|
diff --git a/docs/en/latest/plugins/skywalking-logger.md
b/docs/en/latest/plugins/skywalking-logger.md
index 22ddbf422..fb245e973 100644
--- a/docs/en/latest/plugins/skywalking-logger.md
+++ b/docs/en/latest/plugins/skywalking-logger.md
@@ -40,7 +40,7 @@ If there is an existing tracing context, it sets up the
trace-log correlation au
| endpoint_addr | string | True | |
| URI of the SkyWalking OAP server.
|
| service_name | string | False | "APISIX" |
| Service name for the SkyWalking reporter.
|
| service_instance_name | 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.
[APISIX](../apisix-variable.md) or
[Nginx](http://nginx.org/en/docs/varindex.html) variables can be used by
prefixing the string with `$`. |
+| log_format | object | False | {"host": "$host", "@timestamp":
"$time_iso8601", "client_ip": "$remote_addr"} | | Log format
declared as key value pairs in JSON format. Values only support strings.
[APISIX](../apisix-variable.md) or
[Nginx](http://nginx.org/en/docs/varindex.html) 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.
|
| include_req_body | boolean | False | false |
[false, true] | When set to `true` includes the request body in the log.
|
diff --git a/docs/en/latest/plugins/splunk-hec-logging.md
b/docs/en/latest/plugins/splunk-hec-logging.md
index df7b4e9c4..e8c8d8e0a 100644
--- a/docs/en/latest/plugins/splunk-hec-logging.md
+++ b/docs/en/latest/plugins/splunk-hec-logging.md
@@ -44,7 +44,7 @@ When the Plugin is enabled, APISIX will serialize the request
context informatio
| endpoint.channel | False | | Splunk HEC send data channel
identifier. Read more: [About HTTP Event Collector Indexer
Acknowledgment](https://docs.splunk.com/Documentation/Splunk/8.2.3/Data/AboutHECIDXAck).
|
| endpoint.timeout | False | 10 | Splunk HEC send data timeout in
seconds.
|
| ssl_verify | False | true | When set to `true` enables SSL
verification as per [OpenResty
docs](https://github.com/openresty/lua-nginx-module#tcpsocksslhandshake).
|
-| log_format | False | | Log format
declared as key value pairs in JSON format. Values only support strings.
[APISIX](../apisix-variable.md) or
[Nginx](http://nginx.org/en/docs/varindex.html) variables can be used by
prefixing the string with `$`. |
+| log_format | False | {"host": "$host", "@timestamp":
"$time_iso8601", "client_ip": "$remote_addr"} | Log format declared as key
value pairs in JSON format. Values only support strings.
[APISIX](../apisix-variable.md) or
[Nginx](http://nginx.org/en/docs/varindex.html) variables can be used by
prefixing the string with `$`. |
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 `1000`. See [Batch
Processor](../batch-processor.md#configuration) for more information or setting
your custom configuration.
diff --git a/docs/en/latest/plugins/syslog.md b/docs/en/latest/plugins/syslog.md
index 1823350c1..e17805495 100644
--- a/docs/en/latest/plugins/syslog.md
+++ b/docs/en/latest/plugins/syslog.md
@@ -45,7 +45,7 @@ Logs can be set as JSON objects.
| drop_limit | integer | False | 1048576 | |
Maximum size of the buffer (KB) and the current message before the current
message is dropped because of the size limit. |
| sock_type | string | False | "tcp" | ["tcp", "udp] |
Transport layer protocol to use.
|
| pool_size | integer | False | 5 | [5, ...] |
Keep-alive pool size used by `sock:keepalive`.
|
-| log_format | object | False | | | Log
format declared as key value pairs in JSON format. Values only support strings.
[APISIX](../apisix-variable.md) or
[Nginx](http://nginx.org/en/docs/varindex.html) variables can be used by
prefixing the string with `$`. |
+| log_format | object | False | {"host": "$host", "@timestamp":
"$time_iso8601", "client_ip": "$remote_addr"} | | Log format
declared as key value pairs in JSON format. Values only support strings.
[APISIX](../apisix-variable.md) or
[Nginx](http://nginx.org/en/docs/varindex.html) variables can be used by
prefixing the string with `$`. |
| include_req_body | boolean | False | false | | When
set to `true` includes the request body in the log.
|
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 `1000`. See [Batch
Processor](../batch-processor.md#configuration) for more information or setting
your custom configuration.
diff --git a/docs/en/latest/plugins/tcp-logger.md
b/docs/en/latest/plugins/tcp-logger.md
index 418643584..19b29459e 100644
--- a/docs/en/latest/plugins/tcp-logger.md
+++ b/docs/en/latest/plugins/tcp-logger.md
@@ -43,7 +43,7 @@ This plugin also allows to push logs as a batch to your
external TCP server. It
| host | string | True | | | IP address
or the hostname of the TCP server. |
| port | integer | True | | [0,...] | Target
upstream port. |
| timeout | integer | False | 1000 | [1,...] | Timeout for
the upstream to send data. |
-| log_format | object | False | | | Log format
declared as key value pairs in JSON format. Values only support strings.
[APISIX](../apisix-variable.md) or
[Nginx](http://nginx.org/en/docs/varindex.html) variables can be used by
prefixing the string with `$`. |
+| log_format | object | False | {"host": "$host", "@timestamp":
"$time_iso8601", "client_ip": "$remote_addr"} | | Log format
declared as key value pairs in JSON format. Values only support strings.
[APISIX](../apisix-variable.md) or
[Nginx](http://nginx.org/en/docs/varindex.html) variables can be used by
prefixing the string with `$`. |
| tls | boolean | False | false | | When set to
`true` performs SSL verification. |
| tls_options | string | False | | | TLS
options. |
| include_req_body | boolean | False | false | | When set to
`true` includes the request body in the log. |
diff --git a/docs/en/latest/plugins/tencent-cloud-cls.md
b/docs/en/latest/plugins/tencent-cloud-cls.md
index 67954d0fc..552621914 100644
--- a/docs/en/latest/plugins/tencent-cloud-cls.md
+++ b/docs/en/latest/plugins/tencent-cloud-cls.md
@@ -44,7 +44,7 @@ The `tencent-cloud-cls` Plugin uses [TencentCloud
CLS](https://cloud.tencent.com
| include_req_body | boolean | No | false | [false, true] | When set
to `true` includes the request body in the log. If the request body is too big
to be kept in the memory, it can't be logged due to NGINX's limitations. |
| include_resp_body | boolean | No | false | [false, true] | When set
to `true` includes the response body in the log.
|
| global_tag | object | No | | | kv pairs
in JSON，send with each log.
|
-| log_format | object | No | | | Log
format declared as key value pairs in JSON format. Values only support strings.
[APISIX](../apisix-variable.md) or
[Nginx](http://nginx.org/en/docs/varindex.html) variables can be used by
prefixing the string with `$`. |
+| log_format | object | No | {"host": "$host", "@timestamp":
"$time_iso8601", "client_ip": "$remote_addr"} | | Log format
declared as key value pairs in JSON format. Values only support strings.
[APISIX](../apisix-variable.md) or
[Nginx](http://nginx.org/en/docs/varindex.html) variables can be used by
prefixing the string with `$`. |
NOTE: `encrypt_fields = {"secret_key"}` is also defined in the schema, which
means that the field will be stored encrypted in etcd. See [encrypted storage
fields](../plugin-develop.md#encrypted-storage-fields).
diff --git a/docs/en/latest/plugins/udp-logger.md
b/docs/en/latest/plugins/udp-logger.md
index ee60a529a..48ec4ee49 100644
--- a/docs/en/latest/plugins/udp-logger.md
+++ b/docs/en/latest/plugins/udp-logger.md
@@ -42,7 +42,7 @@ This plugin also allows to push logs as a batch to your
external UDP server. It
| host | string | True | | | IP
address or the hostname of the UDP server. |
| port | integer | True | | [0,...] | Target
upstream port. |
| timeout | integer | False | 3 | [1,...] |
Timeout for the upstream to send data. |
-| log_format | object | False | | | Log
format declared as key value pairs in JSON format. Values only support strings.
[APISIX](../apisix-variable.md) or
[Nginx](http://nginx.org/en/docs/varindex.html) variables can be used by
prefixing the string with `$`. |
+| log_format | object | False | {"host": "$host", "@timestamp":
"$time_iso8601", "client_ip": "$remote_addr"} | | Log format
declared as key value pairs in JSON format. Values only support strings.
[APISIX](../apisix-variable.md) or
[Nginx](http://nginx.org/en/docs/varindex.html) variables can be used by
prefixing the string with `$`. |
| name | string | False | "udp logger" | | Unique
identifier for the batch processor. |
| include_req_body | boolean | False | false | | When
set to `true` includes the request body in the log. |
