tokers commented on a change in pull request #4633: URL: https://github.com/apache/apisix/pull/4633#discussion_r681647888
########## File path: docs/en/latest/plugins/error-log-logger.md ########## @@ -30,31 +30,38 @@ title: error-log-logger ## Name -`error-log-logger` is a plugin which pushes the log data of APISIX's error.log to TCP servers. +`error-log-logger` is a plugin which pushes the log data of APISIX's `error.log` to TCP servers or [Apache SkyWalking](https://skywalking.apache.org/). -This plugin will provide the ability to send the log data which selected by the level to Monitoring tools and other TCP servers. +This plugin will provide the ability to send the log data which selected by the level to Monitoring tools and other TCP servers, and SkyWalking over HTTP. -This plugin provides the ability as a batch to push the log data to your external TCP servers. If not receive the log data, don't worry, it will automatically send the logs after the timer function expires in our Batch Processor. +This plugin provides the ability as a batch to push the log data to your external TCP servers or monitoring tools. If not receive the log data, don't worry, it will automatically send the logs after the timer function expires in our Batch Processor. For more info on Batch-Processor in Apache APISIX please refer. [Batch-Processor](../batch-processor.md) ## Attributes -| Name | Type | Requirement | Default | Valid | Description | -| ---------------- | ------- | ----------- | ------- | ------- | ---------------------------------------------------------------------------------------- | -| host | string | required | | | IP address or the Hostname of the TCP server. | -| port | integer | required | | [0,...] | Target upstream port. | -| timeout | integer | optional | 3 | [1,...] | Timeout for the upstream to connect and send, unit: second. | -| keepalive | integer | optional | 30 | [1,...] | Time for keeping the cosocket alive, unit: second. | -| level | string | optional | WARN | | The filter's log level, default warn, choose the level in ["STDERR", "EMERG", "ALERT", "CRIT", "ERR", "ERROR", "WARN", "NOTICE", "INFO", "DEBUG"], the value ERR equals ERROR. | -| tls | boolean | optional | false | | Control whether to perform SSL verification | -| tls_server_name | string | optional | | | The server name for the new TLS extension SNI | -| batch_max_size | integer | optional | 1000 | [1,...] | Max size of each batch | -| inactive_timeout | integer | optional | 3 | [1,...] | Maximum age in seconds when the buffer will be flushed if inactive | -| buffer_duration | integer | optional | 60 | [1,...] | Maximum age in seconds of the oldest entry in a batch before the batch must be processed | -| max_retry_count | integer | optional | 0 | [0,...] | Maximum number of retries before removing from the processing pipe line | -| retry_delay | integer | optional | 1 | [0,...] | Number of seconds the process execution should be delayed if the execution fails | +| Name | Type | Requirement | Default | Valid | Description | +| -------------------------------- | ------- | ----------- | ------------------------------ | ------- | ---------------------------------------------------------------------------------------------------- | +| tcp.host | string | required | | | IP address or the Hostname of the TCP server. | +| tcp.port | integer | required | | [0,...] | Target upstream port. | +| tcp.tls | boolean | optional | false | | Control whether to perform SSL verification. | +| tcp.tls_server_name | string | optional | | | The server name for the new TLS extension SNI. | +| skywalking.endpoint_addr | string | optional | http://127.0.0.1:12900/v3/logs | | the http endpoint of Skywalking. | +| skywalking.service_name | string | optional | APISIX | | service name for skywalking reporter | +| skywalking.service_instance_name | String | optional | APISIX Instance Name | | Service instance name for skywalking reporter, set it to `$hostname` to get local hostname directly. | +| host | string | optional | | | (`Deprecated`, replaced with `tcp.host`) IP address or the Hostname of the TCP server. | Review comment: ```suggestion | host | string | optional | | | (`Deprecated`, use `tcp.host` instead) IP address or the Hostname of the TCP server. | ``` ########## File path: docs/en/latest/plugins/error-log-logger.md ########## @@ -30,31 +30,38 @@ title: error-log-logger ## Name -`error-log-logger` is a plugin which pushes the log data of APISIX's error.log to TCP servers. +`error-log-logger` is a plugin which pushes the log data of APISIX's `error.log` to TCP servers or [Apache SkyWalking](https://skywalking.apache.org/). -This plugin will provide the ability to send the log data which selected by the level to Monitoring tools and other TCP servers. +This plugin will provide the ability to send the log data which selected by the level to Monitoring tools and other TCP servers, and SkyWalking over HTTP. -This plugin provides the ability as a batch to push the log data to your external TCP servers. If not receive the log data, don't worry, it will automatically send the logs after the timer function expires in our Batch Processor. +This plugin provides the ability as a batch to push the log data to your external TCP servers or monitoring tools. If not receive the log data, don't worry, it will automatically send the logs after the timer function expires in our Batch Processor. For more info on Batch-Processor in Apache APISIX please refer. [Batch-Processor](../batch-processor.md) ## Attributes -| Name | Type | Requirement | Default | Valid | Description | -| ---------------- | ------- | ----------- | ------- | ------- | ---------------------------------------------------------------------------------------- | -| host | string | required | | | IP address or the Hostname of the TCP server. | -| port | integer | required | | [0,...] | Target upstream port. | -| timeout | integer | optional | 3 | [1,...] | Timeout for the upstream to connect and send, unit: second. | -| keepalive | integer | optional | 30 | [1,...] | Time for keeping the cosocket alive, unit: second. | -| level | string | optional | WARN | | The filter's log level, default warn, choose the level in ["STDERR", "EMERG", "ALERT", "CRIT", "ERR", "ERROR", "WARN", "NOTICE", "INFO", "DEBUG"], the value ERR equals ERROR. | -| tls | boolean | optional | false | | Control whether to perform SSL verification | -| tls_server_name | string | optional | | | The server name for the new TLS extension SNI | -| batch_max_size | integer | optional | 1000 | [1,...] | Max size of each batch | -| inactive_timeout | integer | optional | 3 | [1,...] | Maximum age in seconds when the buffer will be flushed if inactive | -| buffer_duration | integer | optional | 60 | [1,...] | Maximum age in seconds of the oldest entry in a batch before the batch must be processed | -| max_retry_count | integer | optional | 0 | [0,...] | Maximum number of retries before removing from the processing pipe line | -| retry_delay | integer | optional | 1 | [0,...] | Number of seconds the process execution should be delayed if the execution fails | +| Name | Type | Requirement | Default | Valid | Description | +| -------------------------------- | ------- | ----------- | ------------------------------ | ------- | ---------------------------------------------------------------------------------------------------- | +| tcp.host | string | required | | | IP address or the Hostname of the TCP server. | +| tcp.port | integer | required | | [0,...] | Target upstream port. | +| tcp.tls | boolean | optional | false | | Control whether to perform SSL verification. | +| tcp.tls_server_name | string | optional | | | The server name for the new TLS extension SNI. | +| skywalking.endpoint_addr | string | optional | http://127.0.0.1:12900/v3/logs | | the http endpoint of Skywalking. | +| skywalking.service_name | string | optional | APISIX | | service name for skywalking reporter | +| skywalking.service_instance_name | String | optional | APISIX Instance Name | | Service instance name for skywalking reporter, set it to `$hostname` to get local hostname directly. | +| host | string | optional | | | (`Deprecated`, replaced with `tcp.host`) IP address or the Hostname of the TCP server. | +| port | integer | optional | | [0,...] | (`Deprecated`, replaced with `tcp.port`) Target upstream port. | +| tls | boolean | optional | false | | (`Deprecated`, replaced with `tcp.tls`) Control whether to perform SSL verification. | Review comment: ```suggestion | tls | boolean | optional | false | | (`Deprecated`, use `tcp.tls` instead) Control whether to perform SSL verification. | ``` ########## File path: docs/en/latest/plugins/error-log-logger.md ########## @@ -30,31 +30,38 @@ title: error-log-logger ## Name -`error-log-logger` is a plugin which pushes the log data of APISIX's error.log to TCP servers. +`error-log-logger` is a plugin which pushes the log data of APISIX's `error.log` to TCP servers or [Apache SkyWalking](https://skywalking.apache.org/). -This plugin will provide the ability to send the log data which selected by the level to Monitoring tools and other TCP servers. +This plugin will provide the ability to send the log data which selected by the level to Monitoring tools and other TCP servers, and SkyWalking over HTTP. -This plugin provides the ability as a batch to push the log data to your external TCP servers. If not receive the log data, don't worry, it will automatically send the logs after the timer function expires in our Batch Processor. +This plugin provides the ability as a batch to push the log data to your external TCP servers or monitoring tools. If not receive the log data, don't worry, it will automatically send the logs after the timer function expires in our Batch Processor. For more info on Batch-Processor in Apache APISIX please refer. [Batch-Processor](../batch-processor.md) ## Attributes -| Name | Type | Requirement | Default | Valid | Description | -| ---------------- | ------- | ----------- | ------- | ------- | ---------------------------------------------------------------------------------------- | -| host | string | required | | | IP address or the Hostname of the TCP server. | -| port | integer | required | | [0,...] | Target upstream port. | -| timeout | integer | optional | 3 | [1,...] | Timeout for the upstream to connect and send, unit: second. | -| keepalive | integer | optional | 30 | [1,...] | Time for keeping the cosocket alive, unit: second. | -| level | string | optional | WARN | | The filter's log level, default warn, choose the level in ["STDERR", "EMERG", "ALERT", "CRIT", "ERR", "ERROR", "WARN", "NOTICE", "INFO", "DEBUG"], the value ERR equals ERROR. | -| tls | boolean | optional | false | | Control whether to perform SSL verification | -| tls_server_name | string | optional | | | The server name for the new TLS extension SNI | -| batch_max_size | integer | optional | 1000 | [1,...] | Max size of each batch | -| inactive_timeout | integer | optional | 3 | [1,...] | Maximum age in seconds when the buffer will be flushed if inactive | -| buffer_duration | integer | optional | 60 | [1,...] | Maximum age in seconds of the oldest entry in a batch before the batch must be processed | -| max_retry_count | integer | optional | 0 | [0,...] | Maximum number of retries before removing from the processing pipe line | -| retry_delay | integer | optional | 1 | [0,...] | Number of seconds the process execution should be delayed if the execution fails | +| Name | Type | Requirement | Default | Valid | Description | +| -------------------------------- | ------- | ----------- | ------------------------------ | ------- | ---------------------------------------------------------------------------------------------------- | +| tcp.host | string | required | | | IP address or the Hostname of the TCP server. | +| tcp.port | integer | required | | [0,...] | Target upstream port. | +| tcp.tls | boolean | optional | false | | Control whether to perform SSL verification. | +| tcp.tls_server_name | string | optional | | | The server name for the new TLS extension SNI. | +| skywalking.endpoint_addr | string | optional | http://127.0.0.1:12900/v3/logs | | the http endpoint of Skywalking. | +| skywalking.service_name | string | optional | APISIX | | service name for skywalking reporter | +| skywalking.service_instance_name | String | optional | APISIX Instance Name | | Service instance name for skywalking reporter, set it to `$hostname` to get local hostname directly. | +| host | string | optional | | | (`Deprecated`, replaced with `tcp.host`) IP address or the Hostname of the TCP server. | +| port | integer | optional | | [0,...] | (`Deprecated`, replaced with `tcp.port`) Target upstream port. | +| tls | boolean | optional | false | | (`Deprecated`, replaced with `tcp.tls`) Control whether to perform SSL verification. | +| tls_server_name | string | optional | | | (`Deprecated`, replaced with `tcp.tls_server_name`) The server name for the new TLS extension SNI. | Review comment: ```suggestion | tls_server_name | string | optional | | | (`Deprecated`, use `tcp.tls_server_name` instead) The server name for the new TLS extension SNI. | ``` ########## File path: docs/en/latest/plugins/error-log-logger.md ########## @@ -30,31 +30,38 @@ title: error-log-logger ## Name -`error-log-logger` is a plugin which pushes the log data of APISIX's error.log to TCP servers. +`error-log-logger` is a plugin which pushes the log data of APISIX's `error.log` to TCP servers or [Apache SkyWalking](https://skywalking.apache.org/). -This plugin will provide the ability to send the log data which selected by the level to Monitoring tools and other TCP servers. +This plugin will provide the ability to send the log data which selected by the level to Monitoring tools and other TCP servers, and SkyWalking over HTTP. -This plugin provides the ability as a batch to push the log data to your external TCP servers. If not receive the log data, don't worry, it will automatically send the logs after the timer function expires in our Batch Processor. +This plugin provides the ability as a batch to push the log data to your external TCP servers or monitoring tools. If not receive the log data, don't worry, it will automatically send the logs after the timer function expires in our Batch Processor. For more info on Batch-Processor in Apache APISIX please refer. [Batch-Processor](../batch-processor.md) ## Attributes -| Name | Type | Requirement | Default | Valid | Description | -| ---------------- | ------- | ----------- | ------- | ------- | ---------------------------------------------------------------------------------------- | -| host | string | required | | | IP address or the Hostname of the TCP server. | -| port | integer | required | | [0,...] | Target upstream port. | -| timeout | integer | optional | 3 | [1,...] | Timeout for the upstream to connect and send, unit: second. | -| keepalive | integer | optional | 30 | [1,...] | Time for keeping the cosocket alive, unit: second. | -| level | string | optional | WARN | | The filter's log level, default warn, choose the level in ["STDERR", "EMERG", "ALERT", "CRIT", "ERR", "ERROR", "WARN", "NOTICE", "INFO", "DEBUG"], the value ERR equals ERROR. | -| tls | boolean | optional | false | | Control whether to perform SSL verification | -| tls_server_name | string | optional | | | The server name for the new TLS extension SNI | -| batch_max_size | integer | optional | 1000 | [1,...] | Max size of each batch | -| inactive_timeout | integer | optional | 3 | [1,...] | Maximum age in seconds when the buffer will be flushed if inactive | -| buffer_duration | integer | optional | 60 | [1,...] | Maximum age in seconds of the oldest entry in a batch before the batch must be processed | -| max_retry_count | integer | optional | 0 | [0,...] | Maximum number of retries before removing from the processing pipe line | -| retry_delay | integer | optional | 1 | [0,...] | Number of seconds the process execution should be delayed if the execution fails | +| Name | Type | Requirement | Default | Valid | Description | +| -------------------------------- | ------- | ----------- | ------------------------------ | ------- | ---------------------------------------------------------------------------------------------------- | +| tcp.host | string | required | | | IP address or the Hostname of the TCP server. | +| tcp.port | integer | required | | [0,...] | Target upstream port. | +| tcp.tls | boolean | optional | false | | Control whether to perform SSL verification. | +| tcp.tls_server_name | string | optional | | | The server name for the new TLS extension SNI. | +| skywalking.endpoint_addr | string | optional | http://127.0.0.1:12900/v3/logs | | the http endpoint of Skywalking. | +| skywalking.service_name | string | optional | APISIX | | service name for skywalking reporter | +| skywalking.service_instance_name | String | optional | APISIX Instance Name | | Service instance name for skywalking reporter, set it to `$hostname` to get local hostname directly. | +| host | string | optional | | | (`Deprecated`, replaced with `tcp.host`) IP address or the Hostname of the TCP server. | +| port | integer | optional | | [0,...] | (`Deprecated`, replaced with `tcp.port`) Target upstream port. | Review comment: ```suggestion | port | integer | optional | | [0,...] | (`Deprecated`, use `tcp.port` instead) Target upstream port. | ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
