You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by zw...@apache.org on 2018/08/01 16:01:32 UTC
[trafficserver] branch master updated: Mark log collation as
deprecated
This is an automated email from the ASF dual-hosted git repository.
zwoop pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/trafficserver.git
The following commit(s) were added to refs/heads/master by this push:
new 26b3087 Mark log collation as deprecated
26b3087 is described below
commit 26b30870d656eb26d752b7f7f841dbfb6e93c970
Author: Leif Hedstrom <zw...@apache.org>
AuthorDate: Tue Jul 31 13:41:58 2018 -0600
Mark log collation as deprecated
---
doc/admin-guide/files/logging.yaml.en.rst | 4 +-
doc/admin-guide/files/records.config.en.rst | 14 +-
doc/admin-guide/logging/destinations.en.rst | 7 +
doc/admin-guide/logging/formatting.en.rst | 5 +
.../monitoring/logging/log-collation.en.po | 210 ---------------------
proxy/logging/LogConfig.cc | 1 +
6 files changed, 28 insertions(+), 213 deletions(-)
diff --git a/doc/admin-guide/files/logging.yaml.en.rst b/doc/admin-guide/files/logging.yaml.en.rst
index 00be1ec..670a492 100644
--- a/doc/admin-guide/files/logging.yaml.en.rst
+++ b/doc/admin-guide/files/logging.yaml.en.rst
@@ -320,7 +320,9 @@ collation_hosts array of If present, one or more strings specifying th
strings log collation hosts to which logs should be
delivered, each in the form of "<ip>:<port>".
:ref:`admin-logging-collation` for more
- information.
+ information. NOTE: This is a deprecated feature,
+ which will be removed in ATS v9.0.0. See the
+ logging documentation (above) for more details.
====================== =========== =================================================
Enabling log rolling may be done globally in :file:`records.config`, or on a
diff --git a/doc/admin-guide/files/records.config.en.rst b/doc/admin-guide/files/records.config.en.rst
index 66cf80b..d0f4c5a 100644
--- a/doc/admin-guide/files/records.config.en.rst
+++ b/doc/admin-guide/files/records.config.en.rst
@@ -2764,6 +2764,7 @@ Logging Configuration
.. ts:cv:: LOCAL proxy.local.log.collation_mode INT 0
:reloadable:
+ :deprecated:
Set the log collation mode.
@@ -2786,34 +2787,42 @@ Logging Configuration
.. note::
- Although Traffic Server supports traditional custom logging, you should use
- the more versatile XML-based custom formats.
+ Log collation is a *deprecated* feature as of ATS v8.0.0, and will be
+ removed in ATS v9.0.0. Our recommendation is to use one of the many existing
+ log collection tools, such as Kafka, LogStash, FileBeat, Fluentd or even
+ syslog / syslog-ng.
.. ts:cv:: CONFIG proxy.config.log.collation_host STRING NULL
+ :deprecated:
The hostname of the log collation server.
.. ts:cv:: CONFIG proxy.config.log.collation_port INT 8085
:reloadable:
+ :deprecated:
The port used for communication between the collation server and client.
.. ts:cv:: CONFIG proxy.config.log.collation_secret STRING foobar
:reloadable:
+ :deprecated:
The password used to validate logging data and prevent the exchange of unauthorized information when a collation server is being used.
.. ts:cv:: CONFIG proxy.config.log.collation_host_tagged INT 0
:reloadable:
+ :deprecated:
When enabled (``1``), configures Traffic Server to include the hostname of the collation client that generated the log entry in each entry.
.. ts:cv:: CONFIG proxy.config.log.collation_retry_sec INT 5
:reloadable:
+ :deprecated:
The number of seconds between collation server connection retries.
.. ts:cv:: CONFIG proxy.config.log.collation_host_timeout INT 86390
+ :deprecated:
The number of seconds before inactivity time-out events for the host side.
This setting over-rides the default set with proxy.config.net.default_inactivity_timeout
@@ -2826,6 +2835,7 @@ Logging Configuration
when it reaches its own time-out and then re-connect automatically.
.. ts:cv:: CONFIG proxy.config.log.collation_client_timeout INT 86400
+ :deprecated:
The number of seconds before inactivity time-out events for the client side.
This setting over-rides the default set with proxy.config.net.default_inactivity_timeout
diff --git a/doc/admin-guide/logging/destinations.en.rst b/doc/admin-guide/logging/destinations.en.rst
index 044200c..f8521de 100644
--- a/doc/admin-guide/logging/destinations.en.rst
+++ b/doc/admin-guide/logging/destinations.en.rst
@@ -202,6 +202,13 @@ such as Logstash, to accomplish this by having them handle the ingestion of
Log Collation
-------------
+.. note::
+
+ Log collation is a *deprecated* feature as of ATS v8.0.0, and will be
+ removed in ATS v9.0.0. Our recommendation is to use one of the many existing
+ log collection tools, such as Kafka, LogStash, FileBeat, Fluentd or even
+ syslog / syslog-ng (see above).
+
|TS| offers remote log shipping natively through the log collation feature,
which allows one or more |TS| instances handling regular traffic to transmit
their log data to one or more |TS| instances acting as collation servers.
diff --git a/doc/admin-guide/logging/formatting.en.rst b/doc/admin-guide/logging/formatting.en.rst
index baecf9c..fce1edd 100644
--- a/doc/admin-guide/logging/formatting.en.rst
+++ b/doc/admin-guide/logging/formatting.en.rst
@@ -432,6 +432,11 @@ phn Proxy Hostname of the |TS| node which generated the collated log entry.
phi Proxy IP of the |TS| node which generated the collated log entry.
===== ====== ==================================================================
+.. note::
+
+ Log collation is a *deprecated* feature as of ATS v8.0.0, and will be
+ removed in ATS v9.0.0.
+
.. _admin-logging-fields-network:
Network Addresses, Ports, and Interfaces
diff --git a/doc/locale/ja/LC_MESSAGES/admin-guide/monitoring/logging/log-collation.en.po b/doc/locale/ja/LC_MESSAGES/admin-guide/monitoring/logging/log-collation.en.po
deleted file mode 100644
index f229885..0000000
--- a/doc/locale/ja/LC_MESSAGES/admin-guide/monitoring/logging/log-collation.en.po
+++ /dev/null
@@ -1,210 +0,0 @@
-# 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.
-#
-#, fuzzy
-msgid ""
-msgstr ""
-"Project-Id-Version: Apache Traffic Server 6.2\n"
-"Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2016-06-30 14:07+0900\n"
-"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
-"Last-Translator: FULL NAME <EM...@ADDRESS>\n"
-"Language-Team: LANGUAGE <LL...@li.org>\n"
-"MIME-Version: 1.0\n"
-"Content-Type: text/plain; charset=utf-8\n"
-"Content-Transfer-Encoding: 8bit\n"
-"Generated-By: Babel 2.2.0\n"
-
-#: ../../../admin-guide/monitoring/logging/log-collation.en.rst:21
-msgid "Log Collation"
-msgstr ""
-
-#: ../../../admin-guide/monitoring/logging/log-collation.en.rst:23
-msgid ""
-"You can use the |TS| log file collation feature to collect all logged "
-"information in one place. Log collation enables you to analyze a set of |"
-"TS| clustered nodes as a whole (rather than as individual nodes) and to use "
-"a large disk that might only be located on one of the nodes in the cluster."
-msgstr ""
-
-#: ../../../admin-guide/monitoring/logging/log-collation.en.rst:28
-msgid ""
-"|TS| collates log files by using one or more nodes as log collation servers "
-"and all remaining nodes as log collation clients. When a |TS| node "
-"generates a buffer of event log entries, it first determines if it is the "
-"collation server or a collation client. The collation server node writes "
-"all log buffers to its local disk, just as it would if log collation was "
-"not enabled. Log collation servers can be part of a node running |TS|."
-msgstr ""
-
-#: ../../../admin-guide/monitoring/logging/log-collation.en.rst:35
-msgid ""
-"The collation client nodes prepare their log buffers for transfer across "
-"the network and send the buffers to the log collation server. When the log "
-"collation server receives a log buffer from a client, it writes it to its "
-"own log file as if it was generated locally. For a visual representation of "
-"this, see the figure below."
-msgstr ""
-
-#: ../../../admin-guide/monitoring/logging/log-collation.en.rst:45
-msgid "Log collation"
-msgstr ""
-
-#: ../../../admin-guide/monitoring/logging/log-collation.en.rst:47
-msgid ""
-"If log clients cannot contact their log collation server, then they write "
-"their log buffers to their local disks, into *orphan* log files. Orphaned "
-"log files require manual collation."
-msgstr ""
-
-#: ../../../admin-guide/monitoring/logging/log-collation.en.rst:53
-msgid ""
-"Log collation can have an impact on network performance. Because all nodes "
-"are forwarding their log data buffers to the single collation server, a "
-"bottleneck can occur. In addition, collated log files contain timestamp "
-"information for each entry, but entries in the files do not appear in "
-"strict chronological order. You may want to sort collated log files before "
-"doing analysis."
-msgstr ""
-
-#: ../../../admin-guide/monitoring/logging/log-collation.en.rst:63
-msgid "Server Configuration"
-msgstr ""
-
-#: ../../../admin-guide/monitoring/logging/log-collation.en.rst:65
-msgid ""
-"To configure a |TS| node to be a collation server, perform the following "
-"configuration adjustments in :file:`records.config`:"
-msgstr ""
-
-#: ../../../admin-guide/monitoring/logging/log-collation.en.rst:68
-msgid ""
-"Set :ts:cv:`proxy.local.log.collation_mode` to ``1`` to indicate this node "
-"will be a server. ::"
-msgstr ""
-
-#: ../../../admin-guide/monitoring/logging/log-collation.en.rst:73
-msgid ""
-"Configure the port on which the server will listen to incoming collation "
-"transfers from clients, using :ts:cv:`proxy.config.log.collation_port`. If "
-"omitted, this defaults to port ``8085``. ::"
-msgstr ""
-
-#: ../../../admin-guide/monitoring/logging/log-collation.en.rst:79
-msgid ""
-"Configure the shared secret used by collation clients to authenticate their "
-"sessions, using :ts:cv:`proxy.config.log.collation_secret`. ::"
-msgstr ""
-
-#: ../../../admin-guide/monitoring/logging/log-collation.en.rst:84
-#: ../../../admin-guide/monitoring/logging/log-collation.en.rst:115
-#, fuzzy
-msgid ""
-"Run the command :option:`traffic_ctl config reload` to apply the "
-"configuration changes."
-msgstr ":option:`traffic_line -x` を実行して設定の変更を適用してください。"
-
-#: ../../../admin-guide/monitoring/logging/log-collation.en.rst:89
-msgid ""
-"If you modify the ``collation_port`` or ``secret`` after connections "
-"between the collation server and collation clients have been established, "
-"then you must restart Traffic Server on all nodes."
-msgstr ""
-
-#: ../../../admin-guide/monitoring/logging/log-collation.en.rst:96
-msgid "Client Configuration"
-msgstr ""
-
-#: ../../../admin-guide/monitoring/logging/log-collation.en.rst:98
-msgid ""
-"To configure a |TS| node to be a collation client, follow the steps below. "
-"If you modify the ``collation_port`` or ``secret`` after connections "
-"between the collation clients and the collation server have been "
-"established, then you must restart |TS|."
-msgstr ""
-
-#: ../../../admin-guide/monitoring/logging/log-collation.en.rst:103
-msgid "In the :file:`records.config` file, edit the following variables:"
-msgstr ""
-
-#: ../../../admin-guide/monitoring/logging/log-collation.en.rst:105
-msgid ""
-":ts:cv:`proxy.local.log.collation_mode`: ``2`` to configure this node as "
-"log collation client and sen standard formatted log entries to the "
-"collation server. For XML-based formatted log entries, see :file:`logs_xml."
-"config` file."
-msgstr ""
-
-#: ../../../admin-guide/monitoring/logging/log-collation.en.rst:109
-msgid ":ts:cv:`proxy.config.log.collation_host`"
-msgstr ""
-
-#: ../../../admin-guide/monitoring/logging/log-collation.en.rst:110
-msgid ":ts:cv:`proxy.config.log.collation_port`"
-msgstr ""
-
-#: ../../../admin-guide/monitoring/logging/log-collation.en.rst:111
-msgid ":ts:cv:`proxy.config.log.collation_secret`"
-msgstr ""
-
-#: ../../../admin-guide/monitoring/logging/log-collation.en.rst:112
-msgid ":ts:cv:`proxy.config.log.collation_host_tagged`"
-msgstr ""
-
-#: ../../../admin-guide/monitoring/logging/log-collation.en.rst:113
-msgid ":ts:cv:`proxy.config.log.max_space_mb_for_orphan_logs`"
-msgstr ""
-
-#: ../../../admin-guide/monitoring/logging/log-collation.en.rst:119
-msgid "Collating Custom Logs"
-msgstr ""
-
-#: ../../../admin-guide/monitoring/logging/log-collation.en.rst:121
-msgid ""
-"If you use custom event log files, then you must edit :file:`logs_xml."
-"config`, in addition to configuring a collation server and collation "
-"clients."
-msgstr ""
-
-#: ../../../admin-guide/monitoring/logging/log-collation.en.rst:124
-msgid "To collate custom event log files:"
-msgstr ""
-
-#: ../../../admin-guide/monitoring/logging/log-collation.en.rst:126
-msgid ""
-"On each collation client, edit :file:`logging.config` and add the :ref:"
-"`CollationHosts <logs-xml-logobject-collationhost>` attribute to the :ref:"
-"`LogObject` specification::"
-msgstr ""
-
-#: ../../../admin-guide/monitoring/logging/log-collation.en.rst:136
-msgid ""
-"Where ``ipaddress`` is the hostname or IP address of the collation server "
-"to which all log entries (for this object) are forwarded, and ``port`` is "
-"the port number for communication between the collation server and "
-"collation clients."
-msgstr ""
-
-#: ../../../admin-guide/monitoring/logging/log-collation.en.rst:141
-#, fuzzy
-msgid ""
-"Run the command :option:`traffic_ctl config reload` to restart Traffic "
-"Server on the local node or :option:`traffic_ctl config reload` to restart "
-"Traffic Server on all the nodes in a cluster."
-msgstr ""
-"ローカルノード上の Traffic Server をリスタートするために :option:"
-"`traffic_line -L` を、もしくはクラスター内のすべての Traffic Server をリス"
-"タートするためには :option:`traffic_line -M` を実行してください。"
diff --git a/proxy/logging/LogConfig.cc b/proxy/logging/LogConfig.cc
index 15c960e..8c3dec6 100644
--- a/proxy/logging/LogConfig.cc
+++ b/proxy/logging/LogConfig.cc
@@ -332,6 +332,7 @@ LogConfig::setup_collation(LogConfig *prev_config)
prev_config->m_log_collation_accept = nullptr;
}
} else {
+ Warning("Log collation is deprecated as of ATS v8.0.0!");
if (!collation_port) {
Note("Cannot activate log collation, %d is an invalid collation port", collation_port);
} else if (collation_mode > Log::COLLATION_HOST && strcmp(collation_host, "none") == 0) {