Skip to content

Commit 59947cf

Browse files
committed
Add logging parameters support
Signed-off-by: Eric D. Helms <ericdhelms@gmail.com>
1 parent 338fd53 commit 59947cf

File tree

6 files changed

+56
-4
lines changed

6 files changed

+56
-4
lines changed

docs/parameters.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,23 @@ There are multiple use cases from the users perspective that dictate what parame
6060
| foreman-installer Parameter | Description | Reason |
6161
| --------------------------- | ----------- | ------ |
6262

63+
#### Logging
64+
65+
##### Mapped
66+
67+
| Parameter | Description | foreman-installer Parameter |
68+
| ----------| ----------- | --------------------------- |
69+
| `--foreman-logging-level` | Allows setting the level of the Foreman logs | `--foreman-logging-level` |
70+
| `--foreman-loggers` | Allows enabling specific loggers in Foreman | `--foreman-loggers` |
71+
| `--candlepin-loggers` | Allows enabling specific loggers in Candlepin | `--candlepin-loggers` |
72+
73+
##### Unmapped
74+
75+
| foreman-installer Parameter | Description | Reason |
76+
| --------------------------- | ----------- | ------ |
77+
| `--foreman-logging-type` | The type of logging - syslog, file, journald | For containers logging should be to stdout |
78+
| `--foreman-logging-layout` | Allow defining a different style of structured output for Foreman logs | For now this should be hardcoded to a single style |
79+
6380
#### Undetermined
6481

6582
| foreman-installer Parameter | Description | Module | Puppet Parameter | Keep |
@@ -69,7 +86,6 @@ There are multiple use cases from the users perspective that dictate what parame
6986
| `--foreman-foreman-service-puma-threads-max` | | foreman | foreman_service_puma_threads_max | `--foreman-puma-threads-max` |
7087
| `--foreman-dynflow-worker-instances` | | foreman | dynflow_worker_instances |
7188
| `--foreman-dynflow-worker-concurrency` | | foreman | dynflow_worker_concurrency |
72-
| `--foreman-loggers` | | foreman | loggers |
7389
| `--foreman-plugin-tasks-cron-line` | | foreman::plugin::tasks | cron_line |
7490
| `--foreman-plugin-tasks-automatic-cleanup` | | foreman::plugin::tasks | automatic_cleanup |
7591
| `--tuning` | Sets the tuning profile | foreman-installer | |
@@ -90,9 +106,6 @@ There are multiple use cases from the users perspective that dictate what parame
90106
| `--foreman-keycloak` | | |
91107
| `--foreman-keycloak-app-name` | | |
92108
| `--foreman-keycloak-realm` | | |
93-
| `--foreman-logging-layout` | | |
94-
| `--foreman-logging-level` | | |
95-
| `--foreman-logging-type` | | |
96109
| `--foreman-oauth-map-users` | | |
97110
| `--foreman-plugin-remote-execution-cockpit-ensure` | | |
98111
| `--foreman-telemetry-prometheus-enabled` | | |

src/playbooks/deploy/metadata.obsah.yaml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,18 @@ variables:
4747
help: User of the Pulp database.
4848
pulp_database_password:
4949
help: Password for the Pulp database.
50+
foreman_logging_level:
51+
help: Set the log level for Foreman.
52+
choices:
53+
- fatal
54+
- error
55+
- warn
56+
- info
57+
- debug
58+
foreman_loggers:
59+
help: Enable specific loggers for debugging Foreman.
60+
candlepin_loggers:
61+
help: Set the log level for Candlepin loggers.
5062
constraints:
5163
required_together:
5264
- [database_ssl_mode, database_ssl_ca]

src/roles/candlepin/defaults/main.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,5 @@ candlepin_database_ssl_mode: disable
2222
candlepin_database_ssl_ca:
2323
candlepin_database_ssl_cert:
2424
candlepin_database_ssl_key:
25+
26+
candlepin_loggers:

src/roles/candlepin/templates/candlepin.conf.j2

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,3 +38,9 @@ org.quartz.dataSource.myDS.user={{ candlepin_database_user }}
3838
org.quartz.dataSource.myDS.password={{ candlepin_database_password }}
3939
org.quartz.dataSource.myDS.maxConnections=5
4040
org.quartz.dataSource.myDS.URL=jdbc:postgresql://{{ candlepin_database_host }}:{{ candlepin_database_port }}/{{ candlepin_database_name }}?sslmode={{ candlepin_database_ssl_mode }}{% if candlepin_database_ssl_ca is defined %}&sslrootcert={{ candlepin_database_ssl_ca }}{% endif %}
41+
42+
{% if candlepin_loggers %}
43+
{% for logger, log_level in candlepin_loggers.items() %}
44+
log4j.logger.{{ logger }}= {{ log_level }}
45+
{% endfor %}
46+
{% endif %}

src/roles/foreman/defaults/main.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,8 @@ foreman_database_port: 5432
99
foreman_database_pool: 9
1010
foreman_database_sslmode: disable
1111
foreman_database_sslrootcert:
12+
13+
14+
foreman_logging_level: info
15+
foreman_logging_layout: multiline_request_pattern
16+
foreman_loggers: {}

src/roles/foreman/templates/settings.yaml.j2

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,17 @@
1616
:oauth_consumer_key: {{ foreman_oauth_consumer_key }}
1717
:oauth_consumer_secret: {{ foreman_oauth_consumer_secret }}
1818
{% endif %}
19+
20+
:logging:
21+
:level: "{{ foreman_logging_level }}"
22+
:production:
23+
:type: stdout
24+
:layout: "{{ foreman_logging_layout }}"
25+
26+
{% if foreman_loggers %}
27+
:loggers:
28+
{% for logger, enabled in foreman_loggers.items() %}
29+
:{{ logger }}:
30+
:enabled: {{ enabled }}
31+
{% endfor %}
32+
{% endif %}

0 commit comments

Comments
 (0)