logging: Deprecate watch_log_file

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: Iaafbb48f78ecb413527151c30beda29bdf2fc581
This commit is contained in:
Takashi Kajinami
2024-09-22 01:52:14 +09:00
parent 4345c14d13
commit f6f3f3b156
3 changed files with 12 additions and 6 deletions

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']
@@ -105,6 +101,12 @@
# 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 undef
#
class cloudkitty::logging(
$use_syslog = $facts['os_service_default'],
$use_json = $facts['os_service_default'],
@@ -113,7 +115,6 @@ class cloudkitty::logging(
$syslog_log_facility = $facts['os_service_default'],
$log_dir = '/var/log/cloudkitty',
$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 cloudkitty::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 cloudkitty::deps

View File

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

View File

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