Skip to content

Commit

Permalink
Store logs in /var/log (#7979)
Browse files Browse the repository at this point in the history
* Store Traffic Router logs in /var/log/traffic_router

* Store Tomcat logs in /var/log/tomcat

* Store Traffic Monitor logs in /var/log

* Store Traffic Stats logs in /var/log/traffic_stats

* chore: fix tomcat log path (#121)

* Add path separator

---------

Co-authored-by: The Anh Nguyen <ntheanh201@gmail.com>
  • Loading branch information
zrhoffman and ntheanh201 committed Apr 15, 2024
1 parent e4729e8 commit f449e50
Show file tree
Hide file tree
Showing 25 changed files with 58 additions and 58 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
- [#7832](https://github.com/apache/trafficcontrol/pull/7832) *t3c* Removed perl dependency
- Updated the CacheGroups Traffic Portal page to use a more performant AG-Grid-based table.
- Updated Go version to 1.22.0
- [#7979](https://github.com/apache/trafficcontrol/pull/7979) *Traffic Router*, *Traffic Monitor*, *Traffic Stats*: Store logs in /var/log

### Fixed
- [#7984](https://github.com/apache/trafficcontrol/pull/7984) *Traffic Ops* Fixed TO Client cert authentication with respect to returning response cookie.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/admin/traffic_monitor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ However newer versions of astats also support CSV output, which can have some CP

Troubleshooting and Log Files
=============================
Traffic Monitor log files are in :file:`/opt/traffic_monitor/var/log/`.
Traffic Monitor log files are in :file:`/var/log/traffic_monitor`.

.. _admin-tm-extensions:

Expand Down
4 changes: 2 additions & 2 deletions docs/source/admin/traffic_router.rst
Original file line number Diff line number Diff line change
Expand Up @@ -447,14 +447,14 @@ The following is an example of the request flow when a client requests the routi

Troubleshooting and log files
=============================
Traffic Router log files can be found under :file:`/opt/traffic_router/var/log` and :file:`/opt/tomcat/logs`. Initialization and shutdown logs are in :file:`/opt/tomcat/logs/catalina{date}.out`. Application related logging is in :file:`/opt/traffic_router/var/log/traffic_router.log`, while access logs are written to :file:`/opt/traffic_router/var/log/access.log`.
Traffic Router log files can be found under :file:`/var/log/traffic_router` and :file:`/var/log/tomcat`. Initialization and shutdown logs are in :file:`/var/log/tomcat/catalina{date}.out`. Application related logging is in :file:`/var/log/traffic_router/traffic_router.log`, while access logs are written to :file:`/var/log/traffic_route/raccess.log`.

Event Log File Format
---------------------

Summary
"""""""
All access events to Traffic Router are logged to the file :file:`/opt/traffic_router/var/log/access.log`. This file grows up to 200MB and gets rolled into older log files, ten log files total are kept (total of up to 2GB of logged events per Traffic Router instance)
All access events to Traffic Router are logged to the file :file:`/var/log/traffic_router/access.log`. This file grows up to 200MB and gets rolled into older log files, ten log files total are kept (total of up to 2GB of logged events per Traffic Router instance)

Traffic Router logs access events in a format that largely follows :abbr:`ATS (Apache Traffic Service)` `event logging format <https://docs.trafficserver.apache.org/en/6.0.x/admin/event-logging-formats.en.html>`_.

Expand Down
18 changes: 9 additions & 9 deletions docs/source/development/debugging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -447,27 +447,27 @@ Traffic Router
Waiting for Traffic Monitor to start...
Waiting for Traffic Monitor to start...
Waiting for Traffic Monitor to start...
tail: cannot open '/opt/tomcat/logs/catalina.log' for reading: No such file or directory
tail: cannot open '/opt/tomcat/logs/catalina.2020-02-21.log' for reading: No such file or directory
==> /opt/traffic_router/var/log/traffic_router.log <==
tail: cannot open '/var/log/tomcat/catalina.log' for reading: No such file or directory
tail: cannot open '/var/log/tomcat/catalina.2020-02-21.log' for reading: No such file or directory
==> /var/log/traffic_router/traffic_router.log <==
==> /opt/traffic_router/var/log/access.log <==
==> /var/log/traffic_routr/access.log <==
Tomcat started.
tail: '/opt/tomcat/logs/catalina.log' has appeared; following end of new file
tail: '/opt/tomcat/logs/catalina.2020-02-21.log' has appeared; following end of new file
tail: '/var/log/tomcat/catalina.log' has appeared; following end of new file
tail: '/var/log/tomcat/catalina.2020-02-21.log' has appeared; following end of new file
==> /opt/traffic_router/var/log/traffic_router.log <==
==> /var/log/traffic_router/traffic_router.log <==
INFO 2020-02-21T05:16:07.557 [Thread-3] org.apache.traffic_control.traffic_router.protocol.LanguidPoller - Waiting for state from mbean path traffic-router:name=languidState
INFO 2020-02-21T05:16:07.557 [Thread-4] org.apache.traffic_control.traffic_router.protocol.LanguidPoller - Waiting for state from mbean path traffic-router:name=languidState
INFO 2020-02-21T05:16:07.558 [Thread-5] org.apache.traffic_control.traffic_router.protocol.LanguidPoller - Waiting for state from mbean path traffic-router:name=languidState
INFO 2020-02-21T05:16:07.559 [Thread-6] org.apache.traffic_control.traffic_router.protocol.LanguidPoller - Waiting for state from mbean path traffic-router:name=languidState
==> /opt/tomcat/logs/catalina.log <==
==> /var/log/tomcat/catalina.log <==
Listening for transport dt_socket at address: 5005
Watch for the line that mentions port 5005 -----------^^^^
==> /opt/tomcat/logs/catalina.2020-02-21.log <==
==> /var/log/tomcat/catalina.2020-02-21.log <==
21-Feb-2020 05:16:07.359 WARNING [main] org.apache.traffic_control.traffic_router.protocol.LanguidNioProtocol.<clinit> Adding BouncyCastle provider
21-Feb-2020 05:16:07.452 WARNING [main] org.apache.traffic_control.traffic_router.protocol.LanguidNioProtocol.<init> Serving wildcard certs for multiple domains
21-Feb-2020 05:16:07.459 WARNING [main] org.apache.traffic_control.traffic_router.protocol.LanguidNioProtocol.<init> Serving wildcard certs for multiple domains
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ tm_pkg_name: "{% if tm_version is defined and tm_version != omit %}{{ 'traffic_m

# Traffic Monitor installation information
tm_base_dir: '/opt/traffic_monitor'
tm_log_dir: "{{ tm_base_dir}}/var/log"
tm_log_dir: '/var/log/traffic_monitor'
tm_exec_path: "{{ tm_base_dir}}/bin/traffic_monitor"
tm_to_config: "{{ tm_base_dir}}/conf/traffic_ops.cfg"
tm_config: "{{ tm_base_dir}}/conf/traffic_monitor.cfg"
Expand Down
4 changes: 2 additions & 2 deletions infrastructure/ansible/roles/traffic-router/defaults/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ tomcat_pkg_name: "{% if tr_version is defined and tr_version != omit %}tomcat-{{
tr_base_dir: '/opt/traffic_router'
tr_conf_dir: "{{ tr_base_dir }}/conf"
tr_temp_dir: "{{ tr_base_dir }}/temp"
tr_log_dir: "{{ tr_base_dir }}/var/log"
tr_log_dir: "/var/log/traffic_router"
tr_db_dir: "{{ tr_base_dir }}/db"
tr_tomcat_base_dir: '/opt/tomcat'
tr_tomcat_logs_dir: "{{ tr_tomcat_base_dir }}/logs"
tr_tomcat_logs_dir: "/var/log/tomcat"

# JAVA_HOME to use in order to specify the desired JRE
tr_java_home_dir: '/usr/lib/jvm/jre-11-openjdk'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
# under the License.


/opt/traffic_router/var/log/access.log {
/var/log/traffic_router/access.log {
daily
size 100m
compress
Expand All @@ -25,11 +25,11 @@
copytruncate
}

/opt/traffic_router/var/log/traffic_router.log {
/var/log/traffic_router/traffic_router.log {
daily
size 100m
compress
rotate 7
dateformat -%d%m%Y
copytruncate
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ ts_group: traffic_stats
# Traffic Stats Installation information
ts_install_basedir: /opt/traffic_stats
ts_install_confdir: "{{ ts_install_basedir }}/conf"
ts_install_logdir: "{{ ts_install_basedir }}/var/log/traffic_stats"
ts_install_logdir: "/var/log/traffic_stats"

# Traffic Ops connection data
ts_toUser:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"params": [
{
"configFile": "inputs.conf",
"name": "monitor:///opt/tomcat/logs/access.log",
"name": "monitor:///var/log/tomcat/access.log",
"value": "index=index_odol_test;sourcetype=access_ccr"
},
{
Expand Down
4 changes: 2 additions & 2 deletions infrastructure/cdn-in-a-box/traffic_router/run.sh
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,8 @@ JAVA_OPTS="\

TO_PROPERTIES="$CATALINA_BASE/conf/traffic_ops.properties"
TM_PROPERTIES="$CATALINA_BASE/conf/traffic_monitor.properties"
LOGFILE="$CATALINA_BASE/var/log/traffic_router.log"
ACCESSLOG="$CATALINA_BASE/var/log/access.log"
LOGFILE="/var/log/traffic_router/traffic_router.log"
ACCESSLOG="/var/log/traffic_router/access.log"

export JAVA_HOME JAVA_OPTS
export TO_PROPERTIES TM_PROPERTIES
Expand Down
6 changes: 3 additions & 3 deletions infrastructure/cdn-in-a-box/traffic_stats/run.sh
Original file line number Diff line number Diff line change
Expand Up @@ -95,12 +95,12 @@ cat <<-EOF >/opt/traffic_stats/conf/traffic_stats_seelog.xml
<?xml version='1.0'?>
<seelog minlevel="debug">
<outputs formatid="std:debug-short">
<file path="/opt/traffic_stats/var/log/traffic_stats/traffic_stats.log" />
<file path="/var/log/traffic_stats/traffic_stats.log" />
</outputs>
</seelog>
EOF

touch /opt/traffic_stats/var/log/traffic_stats/traffic_stats.log
touch /var/log/traffic_stats/traffic_stats.log

# Wait for influxdb
until nc $INFLUXDB_HOST $INFLUXDB_PORT </dev/null >/dev/null 2>&1; do
Expand All @@ -124,5 +124,5 @@ else
"${traffic_stats_command[@]}" &
fi;

exec tail -f /opt/traffic_stats/var/log/traffic_stats/traffic_stats.log
exec tail -f /var/log/traffic_stats/traffic_stats.log

6 changes: 3 additions & 3 deletions traffic_monitor/build/traffic_monitor.logrotate
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
# specific language governing permissions and limitations
# under the License.

/opt/traffic_monitor/var/log/traffic_monitor.log {
/var/log/traffic_monitor/traffic_monitor.log {
compress
maxage 30
missingok
Expand All @@ -25,7 +25,7 @@
copytruncate
}

/opt/traffic_monitor/var/log/event.log {
/var/log/traffic_monitor/event.log {
compress
maxage 30
missingok
Expand All @@ -35,7 +35,7 @@
copytruncate
}

/opt/traffic_monitor/var/log/access.log {
/var/log/traffic_monitor/access.log {
compress
maxage 30
missingok
Expand Down
4 changes: 2 additions & 2 deletions traffic_monitor/build/traffic_monitor.spec
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ mkdir -p "${RPM_BUILD_ROOT}"/opt/traffic_monitor/conf
mkdir -p "${RPM_BUILD_ROOT}"/opt/traffic_monitor/backup
mkdir -p "${RPM_BUILD_ROOT}"/opt/traffic_monitor/static
mkdir -p "${RPM_BUILD_ROOT}"/opt/traffic_monitor/var/run
mkdir -p "${RPM_BUILD_ROOT}"/opt/traffic_monitor/var/log
mkdir -p "${RPM_BUILD_ROOT}"/var/log/traffic_monitor
mkdir -p "${RPM_BUILD_ROOT}"/etc/init.d
mkdir -p "${RPM_BUILD_ROOT}"/etc/logrotate.d

Expand Down Expand Up @@ -108,7 +108,7 @@ fi
%dir /opt/traffic_monitor/backup
%dir /opt/traffic_monitor/static
%dir /opt/traffic_monitor/var
%dir /opt/traffic_monitor/var/log
%dir /var/log/traffic_monitor
%dir /opt/traffic_monitor/var/run

%attr(600, traffic_monitor, traffic_monitor) /opt/traffic_monitor/static/index.html
Expand Down
8 changes: 4 additions & 4 deletions traffic_monitor/conf/traffic_monitor.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@
"distributed_polling": false,
"health_flush_interval_ms": 20,
"stat_flush_interval_ms": 20,
"log_location_access": "/opt/traffic_monitor/var/log/access.log",
"log_location_event": "/opt/traffic_monitor/var/log/event.log",
"log_location_error": "/opt/traffic_monitor/var/log/traffic_monitor.log",
"log_location_warning": "/opt/traffic_monitor/var/log/traffic_monitor.log",
"log_location_access": "/var/log/traffic_monitor/access.log",
"log_location_event": "/var/log/traffic_monitor/event.log",
"log_location_error": "/var/log/traffic_monitor/traffic_monitor.log",
"log_location_warning": "/var/log/traffic_monitor/traffic_monitor.log",
"log_location_info": "null",
"log_location_debug": "null",
"serve_read_timeout_ms": 10000,
Expand Down
12 changes: 6 additions & 6 deletions traffic_monitor/tests/_integration/tm/Dockerfile_run.sh
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ done

start() {
service traffic_monitor start
touch /opt/traffic_monitor/var/log/traffic_monitor.log
exec tail -f /opt/traffic_monitor/var/log/traffic_monitor.log
touch /var/log/traffic_monitor/traffic_monitor.log
exec tail -f /var/log/traffic_monitor/traffic_monitor.log
}

init() {
Expand All @@ -44,10 +44,10 @@ init() {
"max_events": 200,
"health_flush_interval_ms": 20,
"stat_flush_interval_ms": 20,
"log_location_access": "/opt/traffic_monitor/var/log/access.log",
"log_location_event": "/opt/traffic_monitor/var/log/event.log",
"log_location_error": "/opt/traffic_monitor/var/log/traffic_monitor.log",
"log_location_warning": "/opt/traffic_monitor/var/log/traffic_monitor.log",
"log_location_access": "/var/log/traffic_monitor/access.log",
"log_location_event": "/var/log/traffic_monitor/event.log",
"log_location_error": "/var/log/traffic_monitor/traffic_monitor.log",
"log_location_warning": "/var/log/traffic_monitor/traffic_monitor.log",
"log_location_info": "null",
"log_location_debug": "null",
"serve_read_timeout_ms": 10000,
Expand Down
2 changes: 1 addition & 1 deletion traffic_router/build/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@
</sources>
</mapping>
<mapping>
<directory>${deploy.dir}/var/log</directory>
<directory>/var/log/traffic_router</directory>
<filemode>755</filemode>
<username>root</username>
<groupname>root</groupname>
Expand Down
4 changes: 2 additions & 2 deletions traffic_router/core/src/main/conf/log4j2.xml
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@
<Console name="stdout" target="SYSTEM_OUT">
<PatternLayout pattern="%m%n" />
</Console>
<File name="traffic_router" fileName="/opt/traffic_router/var/log/traffic_router.log" immediateFlush="true" append="true">
<File name="traffic_router" fileName="/var/log/traffic_router/traffic_router.log" immediateFlush="true" append="true">
<PatternLayout pattern="%-5p %d{yyyy-MM-dd'T'HH:mm:ss.SSS} [%t] %c - %m%n" />
<ThresholdFilter level="ALL" />
</File>
<File name="traffic_router_access" fileName="/opt/traffic_router/var/log/access.log" immediateFlush="true" append="true">
<File name="traffic_router_access" fileName="/var/log/traffic_router/access.log" immediateFlush="true" append="true">
<PatternLayout pattern="%m%n" />
<ThresholdFilter level="INFO" />
</File>
Expand Down
2 changes: 1 addition & 1 deletion traffic_router/core/src/main/conf/logging.properties
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ handlers = 1catalina.org.apache.juli.AsyncFileHandler, 2localhost.org.apache.jul
############################################################

1catalina.org.apache.juli.AsyncFileHandler.level = INFO
1catalina.org.apache.juli.AsyncFileHandler.directory = ${catalina.home}/logs
1catalina.org.apache.juli.AsyncFileHandler.directory = /var/log/tomcat
1catalina.org.apache.juli.AsyncFileHandler.prefix = catalina.
1catalina.org.apache.juli.AsyncFileHandler.rotatable = true
1catalina.org.apache.juli.AsyncFileHandler.maxDays = 30
6 changes: 3 additions & 3 deletions traffic_router/core/src/main/lib/logrotate/traffic_router
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
# specific language governing permissions and limitations
# under the License.

/opt/traffic_router/var/log/access.log {
/var/log/traffic_router/access.log {
daily
size 1k
compress
Expand All @@ -24,11 +24,11 @@
copytruncate
}

/opt/traffic_router/var/log/traffic_router.log {
/var/log/traffic_router/traffic_router.log {
daily
size 1k
compress
rotate 7
dateformat -%d%m%Y
copytruncate
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Environment=JAVA_HOME=/usr/lib/jvm/jre-11-openjdk
Environment=CATALINA_PID=/opt/traffic_router/temp/tomcat.pid
Environment=CATALINA_HOME=/opt/tomcat
Environment=CATALINA_BASE=/opt/traffic_router
Environment=CATALINA_OUT=/opt/tomcat/logs/catalina.log
Environment=CATALINA_OUT=/var/log/tomcat/catalina.log
EnvironmentFile=/opt/traffic_router/conf/startup.properties
ExecStartPre=/bin/bash /opt/traffic_router/conf/generatingCerts.sh
ExecStart=/opt/tomcat/bin/startup.sh
Expand Down
8 changes: 4 additions & 4 deletions traffic_router/core/src/test/conf/log4j2.xml
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@
<PatternLayout pattern="%m%n" />
</Console>
<RollingFile name="traffic_router_access"
fileName="${deploy.dir}/var/log/access.log"
filePattern="${deploy.dir}/var/log/access.log.%i" >
fileName="/var/log/traffic_router/access.log"
filePattern="/var/log/traffic_router/access.log.%i" >
<PatternLayout pattern="%m%n" />
<Policies>
<SizeBasedTriggeringPolicy size="200MB" />
Expand All @@ -29,8 +29,8 @@
<ThresholdFilter level="INFO" />
</RollingFile>
<RollingFile name="traffic_router"
fileName="${deploy.dir}/var/log/traffic_router.log"
filePattern="${deploy.dir}/var/log/traffic_router.log.%i" >
fileName="/var/log/traffic_router/traffic_router.log"
filePattern="/var/log/traffic_router/traffic_router.log.%i" >
<PatternLayout pattern="%-5p %d{yyyy-MM-dd'T'HH:mm:ss.SSS} [%t] %c - %m%n" />
<Policies>
<SizeBasedTriggeringPolicy size="100MB" />
Expand Down
5 changes: 2 additions & 3 deletions traffic_stats/build/traffic_stats.spec
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ mkdir -p "${RPM_BUILD_ROOT}"/opt/traffic_stats/conf
mkdir -p "${RPM_BUILD_ROOT}"/opt/traffic_stats/backup
mkdir -p "${RPM_BUILD_ROOT}"/opt/traffic_stats/influxdb_tools
mkdir -p "${RPM_BUILD_ROOT}"/opt/traffic_stats/var/run
mkdir -p "${RPM_BUILD_ROOT}"/opt/traffic_stats/var/log/traffic_stats
mkdir -p "${RPM_BUILD_ROOT}"/var/log/traffic_stats
mkdir -p "${RPM_BUILD_ROOT}"/etc/init.d
mkdir -p "${RPM_BUILD_ROOT}"/etc/logrotate.d
mkdir -p "${RPM_BUILD_ROOT}"/var/lib/grafana/plugins/trafficcontrol-scenes-app
Expand Down Expand Up @@ -129,9 +129,8 @@ fi
%dir /opt/traffic_stats/conf
%dir /opt/traffic_stats/backup
%dir /opt/traffic_stats/var
%dir /opt/traffic_stats/var/log
%dir /opt/traffic_stats/var/run
%dir /opt/traffic_stats/var/log/traffic_stats
%dir /var/log/traffic_stats
%dir /var/lib/grafana/plugins/trafficcontrol-scenes-app
%dir /opt/traffic_stats/influxdb_tools

Expand Down
2 changes: 1 addition & 1 deletion traffic_stats/traffic_stats.init
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ start() {

# Start daemons.
echo -n $"Starting $name: "
daemon nohup $prog $options < /dev/null > /opt/traffic_stats/var/log/traffic_stats/traffic_stats.out 2>&1 &
daemon nohup $prog $options < /dev/null > /var/log/traffic_stats/traffic_stats.out 2>&1 &
RETVAL=$?
echo
[ $RETVAL -eq 0 ] && touch $lockfile
Expand Down
2 changes: 1 addition & 1 deletion traffic_stats/traffic_stats.logrotate
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
# specific language governing permissions and limitations
# under the License.

/opt/traffic_stats/var/log/traffic_stats/traffic_stats.log {
/var/log/traffic_stats/traffic_stats.log {
compress
maxage 30
missingok
Expand Down
2 changes: 1 addition & 1 deletion traffic_stats/traffic_stats_seelog.xml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,6 @@ under the License.

<seelog minlevel="info">
<outputs formatid="std:debug-short">
<file path="/opt/traffic_stats/var/log/traffic_stats/traffic_stats.log" />
<file path="/var/log/traffic_stats/traffic_stats.log" />
</outputs>
</seelog>

0 comments on commit f449e50

Please sign in to comment.