Add support loggin conf for designate
Add support logging conf openstack_log_appender param
with fluentd and syslog log handlers
Change-Id: I621a8c7bb7221ee1aa1cbff04c26986a0e90a9d8
Related-Prod: PROD-19781
diff --git a/.travis.yml b/.travis.yml
index c7a3dd8..8099b1e 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -19,7 +19,7 @@
env:
- PLATFORM=epcim/salt:saltstack-ubuntu-xenial-salt-2016.3 SUITE=designate-without-backend
- PLATFORM=epcim/salt:saltstack-ubuntu-xenial-salt-2017.7 SUITE=designate-without-backend
- - PLATFORM=epcim/salt:saltstack-ubuntu-xenial-salt-2018.3 SUITE=designate-without-backend
+# - PLATFORM=epcim/salt:saltstack-ubuntu-xenial-salt-2018.3 SUITE=designate-without-backend
# - PLATFORM=epcim/salt:saltstack-ubuntu-bionic-salt-2017.7 SUITE=designate-without-backend
# - PLATFORM=epcim/salt:saltstack-ubuntu-bionic-salt-2018.3 SUITE=designate-without-backend
diff --git a/README.rst b/README.rst
index c07a44d..2ba22ba 100644
--- a/README.rst
+++ b/README.rst
@@ -146,6 +146,31 @@
rndc_port: 953
rndc_key_file: /etc/designate/rndc.key
+Enhanced logging with logging.conf
+----------------------------------
+
+By default logging.conf is disabled.
+
+That is possible to enable per-binary logging.conf with new variables:
+ * openstack_log_appender - set it to true to enable log_config_append for all OpenStack services;
+ * openstack_fluentd_handler_enabled - set to true to enable FluentHandler for all Openstack services.
+
+Only WatchedFileHandler and FluentHandler are available.
+
+Also it is possible to configure this with pillar:
+
+.. code-block:: yaml
+
+ designate:
+ server:
+ logging:
+ log_appender: true
+ log_handlers:
+ watchedfile:
+ enabled: true
+ fluentd:
+ enabled: true
+
Usage
=====
diff --git a/designate/files/default b/designate/files/default
new file mode 100644
index 0000000..985fb17
--- /dev/null
+++ b/designate/files/default
@@ -0,0 +1,4 @@
+# Generated by Salt.
+{% if values.logging.log_appender %}
+DAEMON_ARGS="--log-config-append=/etc/designate/logging/logging-{{ service_name }}.conf"
+{% endif %}
diff --git a/designate/files/logging.conf b/designate/files/logging.conf
new file mode 100644
index 0000000..48922cc
--- /dev/null
+++ b/designate/files/logging.conf
@@ -0,0 +1,90 @@
+{%- set log_handlers = [] -%}
+{%- for log_handler_name, log_handler_attrs in values.logging.log_handlers.items() %}
+ {%- if log_handler_attrs.get('enabled', False) %}
+ {%- do log_handlers.append(log_handler_name) -%}
+ {%- endif %}
+{%- endfor %}
+[loggers]
+keys = root, designate
+
+[handlers]
+keys = {{ log_handlers | join(", ") }}
+
+[formatters]
+keys = context, default{% if values.logging.log_handlers.get('fluentd',{}).get('enabled', False) %}, fluentd{% endif %}
+
+[logger_root]
+level = {{ values.logging.get('loggers', {}).get('root', {}).get('level', 'WARNING') }}
+handlers = {{ log_handlers | join(", ") }}
+
+[logger_amqp]
+level = {{ values.logging.get('loggers', {}).get('amqp', {}).get('level', 'WARNING') }}
+handlers = {{ log_handlers | join(", ") }}
+qualname = amqp
+
+[logger_designate]
+level = {{ values.logging.get('loggers', {}).get('designate', {}).get('level', 'INFO') }}
+handlers = {{ log_handlers | join(", ") }}
+qualname = designate
+propagate = 0
+
+[logger_amqplib]
+level = {{ values.logging.get('loggers', {}).get('amqplib', {}).get('level', 'WARNING') }}
+handlers = {{ log_handlers | join(", ") }}
+qualname = amqplib
+
+[logger_sqlalchemy]
+level = {{ values.logging.get('loggers', {}).get('sqlalchemy', {}).get('level', 'WARNING') }}
+handlers = {{ log_handlers | join(", ") }}
+qualname = sqlalchemy
+# "level = INFO" logs SQL queries.
+# "level = DEBUG" logs SQL queries and results.
+# "level = WARNING" logs neither. (Recommended for production systems.)
+
+[logger_boto]
+level = {{ values.logging.get('loggers', {}).get('boto', {}).get('level', 'WARNING') }}
+handlers = {{ log_handlers | join(", ") }}
+qualname = boto
+
+[logger_suds]
+level = {{ values.logging.get('loggers', {}).get('suds', {}).get('level', 'INFO') }}
+handlers = {{ log_handlers | join(", ") }}
+qualname = suds
+
+[logger_eventletwsgi]
+level = {{ values.logging.get('loggers', {}).get('eventletwsgi', {}).get('level', 'WARNING') }}
+handlers = {{ log_handlers | join(", ") }}
+qualname = eventlet.wsgi.server
+
+{%- if values.logging.log_handlers.get('fluentd', {}).get('enabled', False) %}
+[handler_fluentd]
+class = fluent.handler.FluentHandler
+args = ('openstack.{{ service_name | replace("-", ".") }}', 'localhost', 24224)
+formatter = fluentd
+{%- endif %}
+
+{%- if values.logging.log_handlers.watchedfile.enabled %}
+[handler_watchedfile]
+class = handlers.WatchedFileHandler
+args = ('/var/log/designate/{{ service_name }}.log',)
+formatter = context
+{%- endif %}
+
+{% if values.logging.log_handlers.get('ossyslog', {}).get('enabled', False) -%}
+{%- set ossyslog_args = values.logging.log_handlers.ossyslog.get('args', {}) -%}
+[handler_ossyslog]
+class = oslo_log.handlers.OSSysLogHandler
+args = ( handlers.SysLogHandler.{{ ossyslog_args.get('facility', 'LOG_USER') }}, )
+formatter = context
+{%- endif %}
+
+[formatter_context]
+class = oslo_log.formatters.ContextFormatter
+
+[formatter_default]
+format = %(message)s
+
+{%- if values.logging.log_handlers.get('fluentd', {}).get('enabled', False) %}
+[formatter_fluentd]
+class = oslo_log.formatters.FluentFormatter
+{%- endif %}
\ No newline at end of file
diff --git a/designate/map.jinja b/designate/map.jinja
index c770dcc..cf215c6 100644
--- a/designate/map.jinja
+++ b/designate/map.jinja
@@ -15,11 +15,27 @@
'pkgs': ['designate-api', 'designate-central', 'designate-sink'],
'services': ['designate-api', 'designate-central', 'designate-sink'],
'cacert_file': '/etc/ssl/certs/ca-certificates.crt',
+ 'logging': {
+ 'log_appender': false,
+ 'log_handlers': {
+ 'watchedfile': {
+ 'enabled': true
+ }
+ },
+ },
},
'RedHat': {
'pkgs': ['openstack-designate-api', 'openstack-designate-central', 'openstack-designate-sink'],
'services': ['designate-api', 'designate-central', 'designate-sink'],
'cacert_file': '/etc/pki/tls/certs/ca-bundle.crt',
+ 'logging': {
+ 'log_appender': false,
+ 'log_handlers': {
+ 'watchedfile': {
+ 'enabled': true
+ }
+ },
+ },
},
}, merge=pillar.designate.get('server', {}), base='default') %}
@@ -38,10 +54,26 @@
'Debian': {
'pkgs': ['designate-worker', 'designate-mdns', 'designate-producer'],
'services': ['designate-worker', 'designate-mdns', 'designate-producer'],
+ 'logging': {
+ 'log_appender': false,
+ 'log_handlers': {
+ 'watchedfile': {
+ 'enabled': true
+ }
+ },
+ },
},
'RedHat': {
'pkgs': ['openstack-designate-worker', 'openstack-designate-mdns', 'openstack-designate-producer'],
'services': ['designate-worker', 'designate-mdns', 'designate-producer'],
+ 'logging': {
+ 'log_appender': false,
+ 'log_handlers': {
+ 'watchedfile': {
+ 'enabled': true
+ }
+ },
+ },
},
}, merge=pillar.designate.get('worker', {})) %}
diff --git a/designate/meta/fluentd.yml b/designate/meta/fluentd.yml
new file mode 100644
index 0000000..2959ade
--- /dev/null
+++ b/designate/meta/fluentd.yml
@@ -0,0 +1,119 @@
+{%- from "designate/map.jinja" import server with context %}
+{%- if pillar.get('fluentd', {}).get('agent', {}).get('enabled', False) %}
+{%- set positiondb = pillar.fluentd.agent.dir.positiondb %}
+agent:
+ config:
+ label:
+ forward_input:
+ input:
+ generic_forward_input:
+ type: forward
+ bind: 0.0.0.0
+ port: 24224
+ match:
+ route_openstack_designate:
+ tag: openstack.designate.**
+ type: relabel
+ label: openstack_designate
+ openstack_designate:
+ filter:
+ set_programname:
+ tag: openstack.designate.*
+ type: record_transformer
+ enable_ruby: true
+ record:
+ - name: programname
+ value: designate-${ tag_parts[2] }
+ filter:
+ set_log_record_fields:
+ tag: openstack.designate
+ type: record_transformer
+ enable_ruby: true
+ record:
+ - name: Severity
+ value: ${ {'TRACE'=>7,'DEBUG'=>7,'INFO'=>6,'AUDIT'=>6,'WARNING'=>4,'ERROR'=>3,'CRITICAL'=>2}[record['level']].to_i }
+ - name: severity_label
+ value: ${ record['level'] }
+ - name: Payload
+ value: ${ record['message'] }
+ - name: python_module
+ value: ${ record['name'] }
+ - name: programname
+ value: '${ record["programname"] ? record["programname"] : "designate" }'
+ parse_http_stats:
+ tag: openstack.designate
+ type: parser
+ key_name: Payload
+ reserve_data: true
+ emit_invalid_record_to_error: false
+ parser:
+ type: regexp
+ # Parse openstack http stats: https://regex101.com/r/Tf0XUK/1/
+ format: '\"(?<http_method>GET|POST|OPTIONS|DELETE|PUT|HEAD|TRACE|CONNECT|PATCH)\s(?<http_url>\S+)\s(?<http_version>[.\/\dHTFSP]+)\"\sstatus:\s(?<http_status>\d{3})\slen:\s(?<http_response_size>\d+)\stime:\s(?<http_response_time>\d+\.\d+)'
+ types: http_response_time:float
+ match:
+ unify_tag:
+ tag: openstack.designate.*
+ type: rewrite_tag_filter
+ rule:
+ - name: level
+ regexp: '.*'
+ result: openstack.designate
+ send_to_default:
+ tag: openstack.designate
+ type: copy
+ store:
+ - type: relabel
+ label: default_output
+ - type: rewrite_tag_filter
+ rule:
+ - name: severity_label
+ regexp: '.'
+ result: metric.designate_log_messages
+ - type: rewrite_tag_filter
+ rule:
+ - name: http_status
+ regexp: '.'
+ result: metric.designate_openstack_http_response
+ push_to_metric:
+ tag: 'metric.**'
+ type: relabel
+ label: default_metric
+ default_metric:
+ filter:
+ designate_logs_per_severity:
+ tag: metric.designate_log_messages
+ require:
+ - add_general_fields
+ type: prometheus
+ metric:
+ - name: log_messages
+ type: counter
+ desc: Total number of log lines by severity
+ label:
+ - name: service
+ value: designate
+ - name: level
+ value: ${severity_label}
+ - name: host
+ value: ${Hostname}
+ designate_openstack_http_response_times:
+ tag: metric.designate_openstack_http_response
+ require:
+ - add_general_fields
+ type: prometheus
+ metric:
+ - name: openstack_http_response_times
+ type: summary
+ desc: Total number of requests per method and status
+ key: http_response_time
+ label:
+ - name: http_method
+ value: ${http_method}
+ - name: http_status
+ value: ${http_status}
+ - name: service
+ value: designate
+ - name: host
+ value: ${Hostname}
+{% endif %}
diff --git a/designate/server.sls b/designate/server.sls
index d860909..341a1a4 100644
--- a/designate/server.sls
+++ b/designate/server.sls
@@ -25,6 +25,76 @@
{%- endif %}
+{%- for service_name in server.services %}
+{{ service_name }}_default:
+ file.managed:
+ - name: /etc/default/{{ service_name }}
+ - source: salt://designate/files/default
+ - template: jinja
+ - require:
+ - pkg: designate_server_packages
+ - defaults:
+ service_name: {{ service_name }}
+ values: {{ server }}
+ - watch_in:
+ - service: designate_server_services
+{%- endfor %}
+
+{% if server.logging.log_appender %}
+
+{%- if server.logging.log_handlers.get('fluentd', {}).get('enabled', False) %}
+designate_fluentd_server_logger_package:
+ pkg.installed:
+ - name: python-fluent-logger
+{%- endif %}
+
+designate_general_logging_conf:
+ file.managed:
+ - name: /etc/designate/logging.conf
+ - source: salt://designate/files/logging.conf
+ - template: jinja
+ - user: designate
+ - group: designate
+ - defaults:
+ service_name: designate
+ values: {{ server }}
+ - require:
+ - pkg: designate_server_packages
+{%- if server.logging.log_handlers.get('fluentd', {}).get('enabled', False) %}
+ - pkg: designate_fluentd_server_logger_package
+{%- endif %}
+ - watch_in:
+ - service: designate_server_services
+
+/var/log/designate/designate.log:
+ file.managed:
+ - user: designate
+ - group: designate
+ - watch_in:
+ - service: designate_server_services
+
+{% for service_name in server.services %}
+{{ service_name }}_logging_conf:
+ file.managed:
+ - name: /etc/designate/logging/logging-{{ service_name }}.conf
+ - source: salt://designate/files/logging.conf
+ - template: jinja
+ - makedirs: True
+ - user: designate
+ - group: designate
+ - defaults:
+ service_name: {{ service_name }}
+ values: {{ server }}
+ - require:
+ - pkg: designate_server_packages
+{%- if server.logging.log_handlers.get('fluentd', {}).get('enabled', False) %}
+ - pkg: designate_fluentd_server_logger_package
+{%- endif %}
+ - watch_in:
+ - service: designate_server_services
+{% endfor %}
+{% endif %}
+
designate_server_packages:
pkg.installed:
- names: {{ server.pkgs }}
@@ -43,16 +113,21 @@
- require:
- pkg: designate_server_packages
-{%- if not grains.get('noservices', False) %}
designate_syncdb:
cmd.run:
- name: designate-manage database sync
+ {%- if grains.get('noservices') %}
+ - onlyif: /bin/false
+ {%- endif %}
- require:
- file: /etc/designate/designate.conf
designate_pool_sync:
cmd.run:
- name: designate-manage pool-manager-cache sync
+ {%- if grains.get('noservices') %}
+ - onlyif: /bin/false
+ {%- endif %}
- require:
- file: /etc/designate/designate.conf
@@ -60,6 +135,9 @@
service.running:
- enable: true
- names: {{ server.services }}
+ {%- if grains.get('noservices') %}
+ - onlyif: /bin/false
+ {%- endif %}
- require:
- cmd: designate_syncdb
- cmd: designate_pool_sync
@@ -71,7 +149,6 @@
{%- if server.database.get('ssl',{}).get('enabled', False) %}
- file: mysql_ca_designate_server
{%- endif %}
-{%- endif %}
{%- if server.version not in ['liberty', 'juno', 'kilo'] and server.pools is defined %}
# Since Mitaka it is recommended to use pools.yaml for pools configuration
diff --git a/designate/worker.sls b/designate/worker.sls
index abff6e4..b6998e2 100644
--- a/designate/worker.sls
+++ b/designate/worker.sls
@@ -1,5 +1,5 @@
{%- from "designate/map.jinja" import worker with context %}
-{%- if worker.enabled %}
+{%- if worker.get('enabled', False) %}
designate_worker_packages:
pkg.installed:
@@ -11,4 +11,50 @@
- names: {{ worker.services }}
- watch:
- file: /etc/designate/designate.conf
+
+{% for service_name in worker.services %}
+{{ service_name }}_default:
+ file.managed:
+ - name: /etc/default/{{ service_name }}
+ - source: salt://designate/files/default
+ - template: jinja
+ - require:
+ - pkg: designate_worker_packages
+ - defaults:
+ service_name: {{ service_name }}
+ values: {{ worker }}
+ - watch_in:
+ - service: designate_worker_services
+{% endfor %}
+
+{% if worker.logging.log_appender %}
+
+{%- if worker.logging.log_handlers.get('fluentd', {}).get('enabled', False) %}
+designate_fluentd_worker_logger_package:
+ pkg.installed:
+ - name: python-fluent-logger
+{%- endif %}
+
+{% for service_name in worker.services %}
+{{ service_name }}_worker_logging_conf:
+ file.managed:
+ - name: /etc/designate/logging/logging-{{ service_name }}.conf
+ - source: salt://designate/files/logging.conf
+ - template: jinja
+ - makedirs: True
+ - user: designate
+ - group: designate
+ - defaults:
+ service_name: {{ service_name }}
+ values: {{ worker }}
+ - require:
+ - pkg: designate_worker_packages
+{%- if worker.logging.log_handlers.get('fluentd', {}).get('enabled', False) %}
+ - pkg: designate_fluentd_worker_logger_package
+{%- endif %}
+ - watch_in:
+ - service: designate_worker_services
+{% endfor %}
+{% endif %}
+
{%- endif %}
diff --git a/metadata/service/server/cluster.yml b/metadata/service/server/cluster.yml
index dfeea19..6080424 100644
--- a/metadata/service/server/cluster.yml
+++ b/metadata/service/server/cluster.yml
@@ -3,6 +3,10 @@
classes:
- service.designate.support
parameters:
+ _param:
+ openstack_log_appender: false
+ openstack_fluentd_handler_enabled: false
+ openstack_ossyslog_handler_enabled: false
designate:
server:
enabled: true
@@ -37,3 +41,22 @@
virtual_host: '/openstack'
sink:
listener_pool_name: 'designate-sink'
+ logging:
+ log_appender: ${_param:openstack_log_appender}
+ log_handlers:
+ watchedfile:
+ enabled: true
+ fluentd:
+ enabled: ${_param:openstack_fluentd_handler_enabled}
+ ossyslog:
+ enabled: ${_param:openstack_ossyslog_handler_enabled}
+ worker:
+ logging:
+ log_appender: ${_param:openstack_log_appender}
+ log_handlers:
+ watchedfile:
+ enabled: true
+ fluentd:
+ enabled: ${_param:openstack_fluentd_handler_enabled}
+ ossyslog:
+ enabled: ${_param:openstack_ossyslog_handler_enabled}
diff --git a/metadata/service/server/single.yml b/metadata/service/server/single.yml
index e3884c5..a3796ef 100644
--- a/metadata/service/server/single.yml
+++ b/metadata/service/server/single.yml
@@ -3,6 +3,10 @@
classes:
- service.designate.support
parameters:
+ _param:
+ openstack_log_appender: false
+ openstack_fluentd_handler_enabled: false
+ openstack_ossyslog_handler_enabled: false
designate:
server:
enabled: true
@@ -37,3 +41,22 @@
virtual_host: '/openstack'
sink:
listener_pool_name: 'designate-sink'
+ logging:
+ log_appender: ${_param:openstack_log_appender}
+ log_handlers:
+ watchedfile:
+ enabled: true
+ fluentd:
+ enabled: ${_param:openstack_fluentd_handler_enabled}
+ ossyslog:
+ enabled: ${_param:openstack_ossyslog_handler_enabled}
+ worker:
+ logging:
+ log_appender: ${_param:openstack_log_appender}
+ log_handlers:
+ watchedfile:
+ enabled: true
+ fluentd:
+ enabled: ${_param:openstack_fluentd_handler_enabled}
+ ossyslog:
+ enabled: ${_param:openstack_ossyslog_handler_enabled}
diff --git a/metadata/service/support.yml b/metadata/service/support.yml
index b43a633..45c972c 100644
--- a/metadata/service/support.yml
+++ b/metadata/service/support.yml
@@ -11,3 +11,5 @@
enabled: true
config:
enabled: true
+ fluentd:
+ enabled: true
diff --git a/tests/pillar/designate_liberty.sls b/tests/pillar/designate_liberty.sls
index 320489a..67f072a 100644
--- a/tests/pillar/designate_liberty.sls
+++ b/tests/pillar/designate_liberty.sls
@@ -26,6 +26,15 @@
- host: 127.0.0.1
- host: 127.0.1.1
- host: 127.0.2.1
+ logging:
+ log_appender: false
+ log_handlers:
+ watchedfile:
+ enabled: true
+ fluentd:
+ enabled: false
+ ossyslog:
+ enabled: false
pool:
pool_id: cae73b6f-95eb-4a7d-a567-099ae6176e08
nameservers:
diff --git a/tests/pillar/designate_mitaka.sls b/tests/pillar/designate_mitaka.sls
index 7c8a53d..1b5a148 100644
--- a/tests/pillar/designate_mitaka.sls
+++ b/tests/pillar/designate_mitaka.sls
@@ -26,6 +26,15 @@
- host: 127.0.0.1
- host: 127.0.1.1
- host: 127.0.2.1
+ logging:
+ log_appender: false
+ log_handlers:
+ watchedfile:
+ enabled: true
+ fluentd:
+ enabled: false
+ ossyslog:
+ enabled: false
pools:
default:
description: 'default pool'
diff --git a/tests/pillar/designate_ocata.sls b/tests/pillar/designate_ocata.sls
index acf1f8f..048756f 100644
--- a/tests/pillar/designate_ocata.sls
+++ b/tests/pillar/designate_ocata.sls
@@ -39,6 +39,15 @@
user: openstack
password: password
virtual_host: '/openstack'
+ logging:
+ log_appender: false
+ log_handlers:
+ watchedfile:
+ enabled: true
+ fluentd:
+ enabled: false
+ ossyslog:
+ enabled: false
pools:
default:
description: 'default pool'
@@ -75,6 +84,15 @@
zones: 40
worker:
enabled: true
+ logging:
+ log_appender: false
+ log_handlers:
+ watchedfile:
+ enabled: true
+ fluentd:
+ enabled: false
+ ossyslog:
+ enabled: false
mysql:
client:
enabled: true