membphis commented on a change in pull request #2592: URL: https://github.com/apache/apisix/pull/2592#discussion_r525942373
########## File path: doc/plugins/error-log-logger.md ########## @@ -0,0 +1,89 @@ +<!-- +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +--> + +- [中文](../zh-cn/plugins/error-log-logger.md) + +# Summary + +- [**Name**](#name) +- [**Attributes**](#attributes) +- [**How To Enable And Disable**](#how-to-enable-and-disable) +- [**How To Update**](#how-to-update) + +## Name + +`error-log-logger` is a plugin which push the log data of APISIX's error.log to TCP servers. + +This will provide the ability to send the log data which selected by the level to Monitoring tools and other TCP servers. + +This plugin provides the ability to push the log data as a batch to you're external TCP servers. In case if you did not recieve the log data don't worry give it some time 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, chose 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_options | string | optional | | | tls options | +| batch_max_size | integer | optional | 1000 | [1,...] | Max size of each batch | +| inactive_timeout | integer | optional | 5 | [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 | + +## How To Enable And Disable + +The error-log-logger is a global plugin of APISIX. + +### Enable plugin + +Enable the plug-in `error-log-logger` in `conf/config.yaml`, then this plugin can work fine. +It does not need to be bound in any route or service. + +Here is an example of `conf/config.yaml`: + +```yaml +plugins: # plugin list + - error-log-logger Review comment: ```yaml plugins: # plugin list ... ... - request-id - hmac-auth - api-breaker - error-log-logger # enable plugin `error-log-logger` ########## File path: doc/plugins/error-log-logger.md ########## @@ -0,0 +1,89 @@ +<!-- +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +--> + +- [中文](../zh-cn/plugins/error-log-logger.md) + +# Summary + +- [**Name**](#name) +- [**Attributes**](#attributes) +- [**How To Enable And Disable**](#how-to-enable-and-disable) +- [**How To Update**](#how-to-update) + +## Name + +`error-log-logger` is a plugin which push the log data of APISIX's error.log to TCP servers. + +This will provide the ability to send the log data which selected by the level to Monitoring tools and other TCP servers. + +This plugin provides the ability to push the log data as a batch to you're external TCP servers. In case if you did not recieve the log data don't worry give it some time 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, chose 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_options | string | optional | | | tls options | +| batch_max_size | integer | optional | 1000 | [1,...] | Max size of each batch | +| inactive_timeout | integer | optional | 5 | [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 | + +## How To Enable And Disable + +The error-log-logger is a global plugin of APISIX. + +### Enable plugin + +Enable the plug-in `error-log-logger` in `conf/config.yaml`, then this plugin can work fine. +It does not need to be bound in any route or service. + +Here is an example of `conf/config.yaml`: + +```yaml +plugins: # plugin list + - error-log-logger +``` + +### Disable plugin + +Remove the plugin `error-log-logger` from `conf/config.yaml`. + +## How To Update + +step: update the attributes of the plugin + +```shell + Review comment: remove this line ########## File path: apisix/cli/ngx_tpl.lua ########## @@ -154,6 +154,10 @@ http { } {% end %} + {% if enabled_plugins["error-log-logger"] then %} + lua_capture_error_log 1m; Review comment: `1m` is small, please change to a larger size. ########## File path: doc/plugins/error-log-logger.md ########## @@ -0,0 +1,89 @@ +<!-- +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +--> + +- [中文](../zh-cn/plugins/error-log-logger.md) + +# Summary + +- [**Name**](#name) +- [**Attributes**](#attributes) +- [**How To Enable And Disable**](#how-to-enable-and-disable) +- [**How To Update**](#how-to-update) + +## Name + +`error-log-logger` is a plugin which push the log data of APISIX's error.log to TCP servers. + +This will provide the ability to send the log data which selected by the level to Monitoring tools and other TCP servers. + +This plugin provides the ability to push the log data as a batch to you're external TCP servers. In case if you did not recieve the log data don't worry give it some time 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, chose 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_options | string | optional | | | tls options | +| batch_max_size | integer | optional | 1000 | [1,...] | Max size of each batch | +| inactive_timeout | integer | optional | 5 | [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 | + +## How To Enable And Disable + +The error-log-logger is a global plugin of APISIX. + +### Enable plugin + +Enable the plug-in `error-log-logger` in `conf/config.yaml`, then this plugin can work fine. +It does not need to be bound in any route or service. + +Here is an example of `conf/config.yaml`: + +```yaml +plugins: # plugin list + - error-log-logger +``` + +### Disable plugin + +Remove the plugin `error-log-logger` from `conf/config.yaml`. + +## How To Update + +step: update the attributes of the plugin Review comment: `Step` ########## File path: doc/plugins/error-log-logger.md ########## @@ -0,0 +1,89 @@ +<!-- +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +--> + +- [中文](../zh-cn/plugins/error-log-logger.md) + +# Summary + +- [**Name**](#name) +- [**Attributes**](#attributes) +- [**How To Enable And Disable**](#how-to-enable-and-disable) +- [**How To Update**](#how-to-update) + +## Name + +`error-log-logger` is a plugin which push the log data of APISIX's error.log to TCP servers. + +This will provide the ability to send the log data which selected by the level to Monitoring tools and other TCP servers. + +This plugin provides the ability to push the log data as a batch to you're external TCP servers. In case if you did not recieve the log data don't worry give it some time 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, chose 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_options | string | optional | | | tls options | +| batch_max_size | integer | optional | 1000 | [1,...] | Max size of each batch | +| inactive_timeout | integer | optional | 5 | [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 | + +## How To Enable And Disable + +The error-log-logger is a global plugin of APISIX. + +### Enable plugin + +Enable the plug-in `error-log-logger` in `conf/config.yaml`, then this plugin can work fine. +It does not need to be bound in any route or service. + +Here is an example of `conf/config.yaml`: + +```yaml +plugins: # plugin list + - error-log-logger +``` + +### Disable plugin + +Remove the plugin `error-log-logger` from `conf/config.yaml`. + +## How To Update Review comment: bad title, 'How to set the TCP server address' ########## File path: doc/plugins/error-log-logger.md ########## @@ -0,0 +1,89 @@ +<!-- +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +--> + +- [中文](../zh-cn/plugins/error-log-logger.md) + +# Summary + +- [**Name**](#name) +- [**Attributes**](#attributes) +- [**How To Enable And Disable**](#how-to-enable-and-disable) +- [**How To Update**](#how-to-update) + +## Name + +`error-log-logger` is a plugin which push the log data of APISIX's error.log to TCP servers. + +This will provide the ability to send the log data which selected by the level to Monitoring tools and other TCP servers. + +This plugin provides the ability to push the log data as a batch to you're external TCP servers. In case if you did not recieve the log data don't worry give it some time 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, chose 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_options | string | optional | | | tls options | +| batch_max_size | integer | optional | 1000 | [1,...] | Max size of each batch | +| inactive_timeout | integer | optional | 5 | [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 | + +## How To Enable And Disable + +The error-log-logger is a global plugin of APISIX. + +### Enable plugin + +Enable the plug-in `error-log-logger` in `conf/config.yaml`, then this plugin can work fine. +It does not need to be bound in any route or service. + +Here is an example of `conf/config.yaml`: + +```yaml +plugins: # plugin list + - error-log-logger +``` + +### Disable plugin + +Remove the plugin `error-log-logger` from `conf/config.yaml`. Review comment: add a example ---------------------------------------------------------------- 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. For queries about this service, please contact Infrastructure at: [email protected]
