Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add syslog configuration improvements #353

Open
wants to merge 3 commits into
base: qa/1.x
Choose a base branch
from
Open

Add syslog configuration improvements #353

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dca7b62
Cosmetic change
sevein Oct 13, 2021
a5f61e7
Syslog: write Nginx messages to separate files
sevein Oct 13, 2021
e7daa08
Syslog: add to Nginx more config vars
sevein Oct 13, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions defaults/main.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,12 +210,19 @@ archivematica_src_configure_am_whitelist: '""' # Dashboard API whi
# Send logs to syslog
#
archivematica_src_syslog_enabled: "false"
archivematica_src_syslog_nginx_enabled: "false"
archivematica_src_syslog_server: "localhost"
archivematica_src_syslog_port: "514"
archivematica_src_syslog_storageservice_facility: "local0"
archivematica_src_syslog_storageservice_level: "DEBUG"
archivematica_src_syslog_storageservice_nginx_identifier: "storage"
archivematica_src_syslog_storageservice_nginx_facility: "local7"
archivematica_src_syslog_storageservice_nginx_level: "info"
archivematica_src_syslog_dashboard_facility: "local1"
archivematica_src_syslog_dashboard_level: "DEBUG"
archivematica_src_syslog_dashboard_nginx_identifier: "dashboard"
archivematica_src_syslog_dashboard_nginx_facility: "local7"
archivematica_src_syslog_dashboard_nginx_level: "info"
archivematica_src_syslog_mcpclient_facility: "local2"
archivematica_src_syslog_mcpclient_level: "DEBUG"
archivematica_src_syslog_mcpserver_facility: "local3"
Expand Down
2 changes: 1 addition & 1 deletion templates/etc/archivematica/dashboard.logging.json.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
{% if archivematica_src_syslog_enabled|bool %}
"syslog": {
"class": "logging.handlers.SysLogHandler",
"address": [ "{{ archivematica_src_syslog_server }}",{{ archivematica_src_syslog_port }} ],
"address": ["{{ archivematica_src_syslog_server }}", {{ archivematica_src_syslog_port }}],
"formatter": "syslog",
"facility": "{{ archivematica_src_syslog_dashboard_facility }}",
"level": "{{ archivematica_src_syslog_dashboard_level }}"
Expand Down
2 changes: 1 addition & 1 deletion templates/etc/archivematica/serverConfig.logging.json.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
{% if archivematica_src_syslog_enabled|bool %}
"syslog": {
"class": "logging.handlers.SysLogHandler",
"address": [ "{{ archivematica_src_syslog_server }}", {{ archivematica_src_syslog_port }} ],
"address": ["{{ archivematica_src_syslog_server }}", {{ archivematica_src_syslog_port }}],
"formatter": "syslog",
"facility": "{{ archivematica_src_syslog_mcpserver_facility }}",
"level": "{{ archivematica_src_syslog_mcpserver_level }}"
Expand Down
2 changes: 1 addition & 1 deletion templates/etc/archivematica/storageService.logging.json.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
{% if archivematica_src_syslog_enabled|bool %}
"syslog": {
"class": "logging.handlers.SysLogHandler",
"address": [ "{{ archivematica_src_syslog_server }}", {{ archivematica_src_syslog_port }} ],
"address": ["{{ archivematica_src_syslog_server }}", {{ archivematica_src_syslog_port }}],
"formatter": "syslog",
"facility": "{{ archivematica_src_syslog_storageservice_facility }}",
"level": "{{ archivematica_src_syslog_storageservice_level }}"
Expand Down
9 changes: 5 additions & 4 deletions templates/etc/nginx/sites-available/dashboard-ssl.conf.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,15 @@ server {

listen 80;
server_name _;
{% if archivematica_src_syslog_enabled|bool %}
error_log syslog:server={{ archivematica_src_syslog_server }},tag=dashboard info;
access_log syslog:server={{ archivematica_src_syslog_server }},tag=dashboard combined;
{% endif %}

# Adjust to taste
client_max_body_size 256M;

{% if archivematica_src_syslog_enabled|bool and archivematica_src_syslog_nginx_enabled|bool %}
access_log syslog:server={{ archivematica_src_syslog_server }},tag={{ archivematica_src_syslog_dashboard_nginx_identifier }},facility={{ archivematica_src_syslog_dashboard_nginx_facility }},severity={{ archivematica_src_syslog_dashboard_nginx_level }} combined;
error_log syslog:server={{ archivematica_src_syslog_server }},tag={{ archivematica_src_syslog_dashboard_nginx_identifier }},facility={{ archivematica_src_syslog_dashboard_nginx_facility }} info;
{% endif %}

{% if archivematica_src_ssl_include_acme_chlg_loc|bool %}
# location for acme challenge (non-encrypted)
include /etc/nginx/acmetool-location.conf;
Expand Down
10 changes: 5 additions & 5 deletions templates/etc/nginx/sites-available/dashboard.conf.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ upstream archivematica_dashboard_backend {
server {

listen 80;
server_name _;

# Adjust to taste
client_max_body_size 256M;

server_name _;
{% if archivematica_src_syslog_enabled|bool %}
error_log syslog:server={{ archivematica_src_syslog_server }},tag=dashboard info;
access_log syslog:server={{ archivematica_src_syslog_server }},tag=dashboard combined;
{% endif %}
{% if archivematica_src_syslog_enabled|bool and archivematica_src_syslog_nginx_enabled|bool %}
access_log syslog:server={{ archivematica_src_syslog_server }},tag={{ archivematica_src_syslog_dashboard_nginx_identifier }},facility={{ archivematica_src_syslog_dashboard_nginx_facility }},severity={{ archivematica_src_syslog_dashboard_nginx_level }} combined;
error_log syslog:server={{ archivematica_src_syslog_server }},tag={{ archivematica_src_syslog_dashboard_nginx_identifier }},facility={{ archivematica_src_syslog_dashboard_nginx_facility }} info;
{% endif %}

location / {
proxy_set_header Host $http_host;
Expand Down
9 changes: 5 additions & 4 deletions templates/etc/nginx/sites-available/storage-ssl.conf.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,11 @@ upstream archivematica_storage_service_backend {
server {

listen 8000 ssl;
{% if archivematica_src_syslog_enabled|bool %}
error_log syslog:server={{ archivematica_src_syslog_server }},tag=storage info;
access_log syslog:server={{ archivematica_src_syslog_server }},tag=storage combined;
{% endif %}

{% if archivematica_src_syslog_enabled|bool and archivematica_src_syslog_nginx_enabled|bool %}
access_log syslog:server={{ archivematica_src_syslog_server }},tag={{ archivematica_src_syslog_storageservice_nginx_identifier }},facility={{ archivematica_src_syslog_storageservice_nginx_facility }},severity={{ archivematica_src_syslog_storageservice_nginx_level }} combined;
error_log syslog:server={{ archivematica_src_syslog_server }},tag={{ archivematica_src_syslog_storageservice_nginx_identifier }},facility={{ archivematica_src_syslog_storageservice_nginx_facility }} info;
{% endif %}

ssl_certificate {{ archivematica_src_ssl_fullchain }};
ssl_certificate_key {{ archivematica_src_ssl_privkey }};
Expand Down
10 changes: 6 additions & 4 deletions templates/etc/nginx/sites-available/storage.conf.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,14 @@ server {

listen 8000;

{% if archivematica_src_syslog_enabled|bool %}
access_log syslog:server={{ archivematica_src_syslog_server }},tag={{ archivematica_src_syslog_storageservice_nginx_identifier }},facility={{ archivematica_src_syslog_storageservice_nginx_facility }},severity={{ archivematica_src_syslog_storageservice_nginx_level }} combined;
error_log syslog:server={{ archivematica_src_syslog_server }},tag={{ archivematica_src_syslog_storageservice_nginx_identifier }},facility={{ archivematica_src_syslog_storageservice_nginx_facility }} info;
{% endif %}

# Adjust to taste
client_max_body_size 256M;
{% if archivematica_src_syslog_enabled|bool %}
error_log syslog:server={{ archivematica_src_syslog_server }},tag=storage info;
access_log syslog:server={{ archivematica_src_syslog_server }},tag=storage combined;
{% endif %}

location / {
proxy_set_header Host $http_host;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
Expand Down
20 changes: 17 additions & 3 deletions templates/etc/rsyslog.d/archivematica.conf.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,27 @@
#Create templates
# Create templates.
$template AMLOG,"{{ archivematica_src_syslog_logdir }}/%$YEAR%/%$MONTH%/%$DAY%/%programname%.log"
{% if archivematica_src_syslog_nginx_enabled|bool %}
$template NGINXAMLOG,"/var/log/archivematica/%$YEAR%/%$MONTH%/%$DAY%/%programname%-access.log"
$template NGINXAMLOGERROR,"/var/log/archivematica/%$YEAR%/%$MONTH%/%$DAY%/%programname%-error.log"

#Log each service on it's own file
if (re_match($programname, '({{ archivematica_src_syslog_dashboard_nginx_identifier }}|{{ archivematica_src_syslog_storageservice_nginx_identifier }})') and $syslogseverity-text == 'error') then {
?NGINXAMLOGERROR
stop
}

if (re_match($programname, '({{ archivematica_src_syslog_dashboard_nginx_identifier }}|{{ archivematica_src_syslog_storageservice_nginx_identifier }})')) then {
?NGINXAMLOG
stop
}
{% endif %}

# Log each service on its own file.
{{ archivematica_src_syslog_storageservice_facility }}.* -?AMLOG
{{ archivematica_src_syslog_dashboard_facility }}.* -?AMLOG
{{ archivematica_src_syslog_mcpclient_facility }}.* -?AMLOG
{{ archivematica_src_syslog_mcpserver_facility }}.* -?AMLOG

#Stop processing
# Stop processing.
{{ archivematica_src_syslog_storageservice_facility }}.* stop
{{ archivematica_src_syslog_dashboard_facility }}.* stop
{{ archivematica_src_syslog_mcpclient_facility }}.* stop
Expand Down