Skip to content

Commit 4a71584

Browse files
committed
DITA migration changes: CAG Ch 8 (ansible#3940)
Configuring automation execution UI and modular compliance chapter 8 https://issues.redhat.com/browse/AAP-46725
1 parent 3a6e07e commit 4a71584

File tree

2 files changed

+52
-43
lines changed

2 files changed

+52
-43
lines changed

downstream/assemblies/platform/assembly-controller-log-files.adoc

Lines changed: 1 addition & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -9,48 +9,6 @@
99
* `/var/log/tower/`
1010
* `/var/log/supervisor/`
1111

12-
In the `/var/log/tower/` directory, you can view logfiles captured by:
12+
include::platform/ref-controller-log-files.adoc[leveloffset=+1]
1313

14-
* *tower.log:* Captures the log messages such as runtime errors that occur when the job is executed.
15-
* *callback_receiver.log:* Captures callback receiver logs that handles callback events when running ansible jobs.
16-
* *dispatcher.log:* Captures log messages for the {ControllerName} dispatcher worker service.
17-
* *job_lifecycle.log:* Captures details of the job run, whether it is blocked, and what condition is blocking it.
18-
* *management_playbooks.log:* Captures the logs of management playbook runs, and isolated job runs such as copying the metadata.
19-
* *rsyslog.err:* Captures rsyslog errors authenticating with external logging services when sending logs to them.
20-
* *task_system.log:* Captures the logs of tasks that {ControllerName} is running in the background, such as adding cluster instances and logs related to information gathering or processing for analytics.
21-
* *tower_rbac_migrations.log:* Captures the logs for rbac database migration or upgrade.
22-
* *tower_system_tracking_migrations.log:* Captures the logs of the controller system tracking migration or upgrade.
23-
* *wsbroadcast.log:* Captures the logs of websocket connections in the controller nodes.
2414

25-
In the `/var/log/supervisor/` directory, you can view logfiles captured by:
26-
27-
* *awx-callback-receiver.log:* Captures the log of callback receiver that handles callback events when running ansible jobs, managed by `supervisord`.
28-
* *awx-daphne.log:* Captures the logs of Websocket communication of WebUI.
29-
* *awx-dispatcher.log:* Captures the logs that occur when dispatching a task to an {ControllerName} instance, such as when running a job.
30-
* *awx-rsyslog.log:* Captures the logs for the `rsyslog` service.
31-
* *awx-uwsgi.log:* Captures the logs related to uWSGI, which is an application server.
32-
* *awx-wsbroadcast.log:* Captures the logs of the websocket service that is used by {ControllerName}.
33-
* *failure-event-handler.stderr.log:* Captures the standard errors for `/usr/bin/failure-event-handler` supervisord's subprocess.
34-
* *supervisord.log:* Captures the logs related to `supervisord` itself.
35-
* *wsrelay.log:* Captures the communication logs within the websocket relay server.
36-
* *ws_heartbeat.log:* Captures the periodic checks on the health of services running on the host.
37-
* *rsyslog_configurer.log:* Captures rsyslog configuration activity associated with authenticating with external logging services.
38-
39-
The `/var/log/supervisor/` directory includes `stdout` files for all services as well.
40-
41-
You can expect the following log paths to be generated by services used by {ControllerName} (and {PlatformNameShort}):
42-
43-
* */var/log/nginx/*
44-
* */var/lib/pgsql/data/pg_log/*
45-
* */var/log/redis/*
46-
47-
.Troubleshooting
48-
49-
Error logs can be found in the following locations:
50-
51-
* {ControllerNameStart} server errors are logged in `/var/log/tower`.
52-
* Supervisors logs can be found in `/var/log/supervisor/`.
53-
* Nginx web server errors are logged in the httpd error log.
54-
* Configure other {ControllerName} logging needs in `/etc/tower/conf.d/`.
55-
56-
Explore client-side issues using the JavaScript console built into most browsers and report any errors to Ansible through the Red Hat Customer portal at: https://access.redhat.com/.
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
:_mod-docs-content-type: REFERENCE
2+
3+
[id="ref-controller-log-files"]
4+
5+
= Access {ControllerName} logfiles
6+
7+
In the `/var/log/tower/` directory, you can view logfiles captured by:
8+
9+
* *tower.log:* Captures the log messages such as runtime errors that occur when the job is executed.
10+
* *callback_receiver.log:* Captures callback receiver logs that handles callback events when running ansible jobs.
11+
* *dispatcher.log:* Captures log messages for the {ControllerName} dispatcher worker service.
12+
* *job_lifecycle.log:* Captures details of the job run, whether it is blocked, and what condition is blocking it.
13+
* *management_playbooks.log:* Captures the logs of management playbook runs, and isolated job runs such as copying the metadata.
14+
* *rsyslog.err:* Captures rsyslog errors authenticating with external logging services when sending logs to them.
15+
* *task_system.log:* Captures the logs of tasks that {ControllerName} is running in the background, such as adding cluster instances and logs related to information gathering or processing for analytics.
16+
* *tower_rbac_migrations.log:* Captures the logs for rbac database migration or upgrade.
17+
* *tower_system_tracking_migrations.log:* Captures the logs of the controller system tracking migration or upgrade.
18+
* *wsbroadcast.log:* Captures the logs of websocket connections in the controller nodes.
19+
20+
In the `/var/log/supervisor/` directory, you can view logfiles captured by:
21+
22+
* *awx-callback-receiver.log:* Captures the log of callback receiver that handles callback events when running ansible jobs, managed by `supervisord`.
23+
* *awx-daphne.log:* Captures the logs of Websocket communication of WebUI.
24+
* *awx-dispatcher.log:* Captures the logs that occur when dispatching a task to an {ControllerName} instance, such as when running a job.
25+
* *awx-rsyslog.log:* Captures the logs for the `rsyslog` service.
26+
* *awx-uwsgi.log:* Captures the logs related to uWSGI, which is an application server.
27+
* *awx-wsbroadcast.log:* Captures the logs of the websocket service that is used by {ControllerName}.
28+
* *failure-event-handler.stderr.log:* Captures the standard errors for `/usr/bin/failure-event-handler` supervisord's subprocess.
29+
* *supervisord.log:* Captures the logs related to `supervisord` itself.
30+
* *wsrelay.log:* Captures the communication logs within the websocket relay server.
31+
* *ws_heartbeat.log:* Captures the periodic checks on the health of services running on the host.
32+
* *rsyslog_configurer.log:* Captures rsyslog configuration activity associated with authenticating with external logging services.
33+
34+
The `/var/log/supervisor/` directory includes `stdout` files for all services as well.
35+
36+
You can expect the following log paths to be generated by services used by {ControllerName} (and {PlatformNameShort}):
37+
38+
* */var/log/nginx/*
39+
* */var/lib/pgsql/data/pg_log/*
40+
* */var/log/redis/*
41+
42+
.Troubleshooting
43+
44+
Error logs can be found in the following locations:
45+
46+
* {ControllerNameStart} server errors are logged in `/var/log/tower`.
47+
* Supervisors logs can be found in `/var/log/supervisor/`.
48+
* Nginx web server errors are logged in the httpd error log.
49+
* Configure other {ControllerName} logging needs in `/etc/tower/conf.d/`.
50+
51+
Explore client-side issues using the JavaScript console built into most browsers and report any errors to Ansible through the Red Hat Customer portal at: https://access.redhat.com/.

0 commit comments

Comments
 (0)