From e746847962ee4312d73c421ed6e9e0b04f4a10b1 Mon Sep 17 00:00:00 2001
From: Takashi Kajinami <kajinamit@oss.nttdata.com>
Date: Sun, 22 Sep 2024 02:09:08 +0900
Subject: [PATCH] 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: I5697f9ce912fef7f3eb71514e2b8b307d338510e
---
 manifests/logging.pp                                 | 12 +++++++-----
 .../deprecate-watch_log_file-33488fd84df9225a.yaml   |  4 ++++
 spec/classes/placement_logging_spec.rb               |  1 -
 3 files changed, 11 insertions(+), 6 deletions(-)
 create mode 100644 releasenotes/notes/deprecate-watch_log_file-33488fd84df9225a.yaml

diff --git a/manifests/logging.pp b/manifests/logging.pp
index 0eb6176..bdc07a3 100644
--- a/manifests/logging.pp
+++ b/manifests/logging.pp
@@ -37,10 +37,6 @@
 #   (Optional) File where logs should be stored.
 #   Defaults to '/var/log/placement/placement.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*]
 #   (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 placement::logging(
   $use_syslog                    = $facts['os_service_default'],
   $use_json                      = $facts['os_service_default'],
@@ -113,7 +115,6 @@ class placement::logging(
   $syslog_log_facility           = $facts['os_service_default'],
   $log_dir                       = '/var/log/placement',
   $log_file                      = '/var/log/placement/placement.log',
-  $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,7 @@ class placement::logging(
   $instance_format               = $facts['os_service_default'],
   $instance_uuid_format          = $facts['os_service_default'],
   $log_date_format               = $facts['os_service_default'],
+  $watch_log_file                = undef,
 ) {
 
   include placement::deps
diff --git a/releasenotes/notes/deprecate-watch_log_file-33488fd84df9225a.yaml b/releasenotes/notes/deprecate-watch_log_file-33488fd84df9225a.yaml
new file mode 100644
index 0000000..4fa13d4
--- /dev/null
+++ b/releasenotes/notes/deprecate-watch_log_file-33488fd84df9225a.yaml
@@ -0,0 +1,4 @@
+---
+deprecations:
+  - |
+    The ``placement::logging::watch_log_file`` parameter has been deprecated.
diff --git a/spec/classes/placement_logging_spec.rb b/spec/classes/placement_logging_spec.rb
index 930cd9d..9bfe4b3 100644
--- a/spec/classes/placement_logging_spec.rb
+++ b/spec/classes/placement_logging_spec.rb
@@ -69,7 +69,6 @@ describe 'placement::logging' do
       :syslog_log_facility => '<SERVICE DEFAULT>',
       :log_dir             => '/var/log/placement',
       :log_file            => '/var/log/placement/placement.log',
-      :watch_log_file      => '<SERVICE DEFAULT>',
       :debug               => '<SERVICE DEFAULT>',
     )}
   end