spacewander commented on a change in pull request #2592: URL: https://github.com/apache/apisix/pull/2592#discussion_r532030653
########## File path: doc/plugins/error-log-logger.md ########## @@ -0,0 +1,101 @@ +<!-- +# +# 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. Review comment: push => pushes ########## File path: .travis/apisix_cli_test.sh.bak ########## @@ -0,0 +1,130 @@ +#!/usr/bin/env bash Review comment: This file is useless? ########## File path: apisix/plugins/error-log-logger.lua ########## @@ -0,0 +1,206 @@ +-- +-- 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. +-- + +local core = require("apisix.core") +local errlog = require("ngx.errlog") +local batch_processor = require("apisix.utils.batch-processor") +local plugin = require("apisix.plugin") +local timers = require("apisix.timers") +local plugin_name = "error-log-logger" +local table = core.table +local schema_def = core.schema +local ngx = ngx +local tcp = ngx.socket.tcp +local string = string +local tostring = tostring +local ipairs = ipairs +local lrucache = core.lrucache.new({ + ttl = 300, count = 32 +}) + + +local metadata_schema = { + type = "object", + properties = { + host = schema_def.host_def, + port = {type = "integer", minimum = 0}, + tls = {type = "boolean", default = false}, + tls_options = {type = "string"}, + timeout = {type = "integer", minimum = 1, default = 3}, + keepalive = {type = "integer", minimum = 1, default = 30}, + name = {type = "string", default = plugin_name}, + level = {type = "string", default = "WARN", enum = {"STDERR", "EMERG", "ALERT", "CRIT", + "ERR", "ERROR", "WARN", "NOTICE", "INFO", "DEBUG"}}, + batch_max_size = {type = "integer", minimum = 0, default = 1000}, + max_retry_count = {type = "integer", minimum = 0, default = 0}, + retry_delay = {type = "integer", minimum = 0, default = 1}, + buffer_duration = {type = "integer", minimum = 1, default = 60}, + inactive_timeout = {type = "integer", minimum = 1, default = 3}, + }, + required = {"host", "port"} +} + + +local log_level = { + STDERR = ngx.STDERR, + EMERG = ngx.EMERG, + ALERT = ngx.ALERT, + CRIT = ngx.CRIT, + ERR = ngx.ERR, + ERROR = ngx.ERR, + WARN = ngx.WARN, + NOTICE = ngx.NOTICE, + INFO = ngx.INFO, + DEBUG = ngx.DEBUG +} + + +local config = {} +local buffers = {} + + +local _M = { + version = 0.1, + priority = 1091, + name = plugin_name, + metadata_schema = metadata_schema, +} + + +local function send_to_server(data) + local sock, soc_err = tcp() + + if not sock then + return false, "failed to init the socket " .. soc_err + end + + sock:settimeout(config.timeout * 1000) + + local ok, err = sock:connect(config.host, config.port) + if not ok then + return false, "failed to connect the TCP server: host[" .. config.host + .. "] port[" .. tostring(config.port) .. "] err: " .. err + end + + if config.tls then + ok, err = sock:sslhandshake(true, config.tls_options, false) Review comment: The name `tls_options` is bad, in fact it isn't related with any options. Would be better to use `tls_sni` or `tls_server_name`. ########## File path: doc/plugins/error-log-logger.md ########## @@ -0,0 +1,101 @@ +<!-- +# +# 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 your external TCP servers. In case if you did not receive 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, 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_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 | Review comment: The `inactive_timeout` in code is 3, but it is 5 in the doc? ########## File path: doc/plugins/error-log-logger.md ########## @@ -0,0 +1,101 @@ +<!-- +# +# 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 your external TCP servers. In case if you did not receive 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, 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_options | string | optional | | | tls options | Review comment: The name tls_options is bad ---------------------------------------------------------------- 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]
