openstack/puppet-zaqar
Code Issues Proposed changes

logging: Deprecate watch_log_file

Browse Source 
This option was deprecated in oslo.log 6.0.0 [1]. Because the warning
to catch usage of the parameter is implemented in the underlying
oslo::log defined resource type, no additional warning message is
implemented in this module.

[1] https://review.opendev.org/914788

Depends-on: https://review.opendev.org/930126
Change-Id: I3630f8773977c388c227378b28323be920b78b6a
This commit is contained in:
Takashi Kajinami 2024-09-22 02:17:55 +09:00
parent b7517bb4d1
commit 6fb6ebfaf0
3 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
manifests/logging.pp
View File

@ -37,10 +37,6 @@
# (Optional) File where logs should be stored.
# Defaults to $facts['os_service_default']
#
# [*watch_log_file*]
# (Optional) Uses logging handler designed to watch file system (boolean value).
# Defaults to $facts['os_service_default']
#
# [*logging_context_format_string*]
# (Optional) Format string to use for log messages with context.
# Defaults to $facts['os_service_default'].
@ -99,12 +95,18 @@
# it like this (string value).
# Defaults to $facts['os_service_default'].
# Example: instance_uuid_format='[instance: %(uuid)s] '
#
# [*log_date_format*]
# (Optional) Format string for %%(asctime)s in log records.
# Defaults to $facts['os_service_default'].
# Example: 'Y-%m-%d %H:%M:%S'
#
# DEPRECATED PARAMETERS
#
# [*watch_log_file*]
# (Optional) Uses logging handler designed to watch file system (boolean value).
# Defaults to $facts['os_service_default']
#
class zaqar::logging(
$use_syslog = $facts['os_service_default'],
$use_json = $facts['os_service_default'],
@ -113,7 +115,6 @@ class zaqar::logging(
$log_facility = $facts['os_service_default'],
$log_dir = '/var/log/zaqar',
$log_file = $facts['os_service_default'],
$watch_log_file = $facts['os_service_default'],
$debug = $facts['os_service_default'],
$logging_context_format_string = $facts['os_service_default'],
$logging_default_format_string = $facts['os_service_default'],
@ -126,6 +127,8 @@ class zaqar::logging(
$instance_format = $facts['os_service_default'],
$instance_uuid_format = $facts['os_service_default'],
$log_date_format = $facts['os_service_default'],
# DEPRECATED PARAMETERS
$watch_log_file = undef,
) {
include zaqar::deps

4
releasenotes/notes/deprecate-watch_log_file-1f04fab3473d5caf.yaml Normal file
View File

@ -0,0 +1,4 @@
---
deprecations:
- |
The ``zaqar::logging::watch_log_file`` parameter has been deprecated.

1
spec/classes/zaqar_logging_spec.rb
View File

@ -57,7 +57,6 @@ describe 'zaqar::logging' do
:use_stderr => '<SERVICE DEFAULT>',
:log_dir => '/var/log/zaqar',
:log_file => '<SERVICE DEFAULT>',
:watch_log_file => '<SERVICE DEFAULT>',
:debug => '<SERVICE DEFAULT>',
)
end