openstack/puppet-watcher
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: Ia5fc2634a463e5b6c82f4f793a6a9246c6556098
This commit is contained in:
Takashi Kajinami 2024-09-22 02:13:22 +09:00
parent fb8848ae17
commit 5c99ae753d
3 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
manifests/logging.pp
View File

@ -37,10 +37,6 @@
# (Optional) File where logs should be stored. # (Optional) File where logs should be stored.
# Defaults to '/var/log/watcher/watcher.log' # Defaults to '/var/log/watcher/watcher.log'
# #
# [*watch_log_file*]
# (Optional) Uses logging handler designed to watch file system (boolean value).
# Defaults to $facts['os_service_default']
#
# [*logging_context_format_string*] # [*logging_context_format_string*]
# (Optional) Format string to use for log messages with context. # (Optional) Format string to use for log messages with context.
# Defaults to $facts['os_service_default'] # Defaults to $facts['os_service_default']
@ -105,6 +101,12 @@
# Defaults to $facts['os_service_default'] # Defaults to $facts['os_service_default']
# Example: 'Y-%m-%d %H:%M:%S' # 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 undef
#
class watcher::logging( class watcher::logging(
$use_syslog = $facts['os_service_default'], $use_syslog = $facts['os_service_default'],
$use_json = $facts['os_service_default'], $use_json = $facts['os_service_default'],
@ -113,7 +115,6 @@ class watcher::logging(
$syslog_log_facility = $facts['os_service_default'], $syslog_log_facility = $facts['os_service_default'],
$log_dir = '/var/log/watcher', $log_dir = '/var/log/watcher',
$log_file = '/var/log/watcher/watcher.log', $log_file = '/var/log/watcher/watcher.log',
$watch_log_file = $facts['os_service_default'],
$debug = $facts['os_service_default'], $debug = $facts['os_service_default'],
$logging_context_format_string = $facts['os_service_default'], $logging_context_format_string = $facts['os_service_default'],
$logging_default_format_string = $facts['os_service_default'], $logging_default_format_string = $facts['os_service_default'],
@ -126,6 +127,8 @@ class watcher::logging(
$instance_format = $facts['os_service_default'], $instance_format = $facts['os_service_default'],
$instance_uuid_format = $facts['os_service_default'], $instance_uuid_format = $facts['os_service_default'],
$log_date_format = $facts['os_service_default'], $log_date_format = $facts['os_service_default'],
# DEPRECATED PARAMETERS
$watch_log_file = undef,
) { ) {
include watcher::deps include watcher::deps

4
releasenotes/notes/deprecate-watch_log_file-14671e9b45171daa.yaml Normal file
View File

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

1
spec/classes/watcher_logging_spec.rb
View File

@ -67,7 +67,6 @@ describe 'watcher::logging' do
:syslog_log_facility => '<SERVICE DEFAULT>', :syslog_log_facility => '<SERVICE DEFAULT>',
:log_dir => '/var/log/watcher', :log_dir => '/var/log/watcher',
:log_file => '/var/log/watcher/watcher.log', :log_file => '/var/log/watcher/watcher.log',
:watch_log_file => '<SERVICE DEFAULT>',
:debug => '<SERVICE DEFAULT>', :debug => '<SERVICE DEFAULT>',
) )
end end