From 03f3cc692249355199c98bbebb5ccbde146c942f Mon Sep 17 00:00:00 2001
From: Takashi Kajinami <kajinamit@oss.nttdata.com>
Date: Sun, 22 Sep 2024 02:10:32 +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: I2dd8e0d19113dafc7a45b485933e1f90439d1ac6
---
 manifests/logging.pp                                | 13 ++++++++-----
 .../deprecate-watch_log_file-370604865ba4b894.yaml  |  4 ++++
 spec/classes/trove_logging_spec.rb                  |  1 -
 3 files changed, 12 insertions(+), 6 deletions(-)
 create mode 100644 releasenotes/notes/deprecate-watch_log_file-370604865ba4b894.yaml

diff --git a/manifests/logging.pp b/manifests/logging.pp
index 6e13fec8..0b529f8c 100644
--- a/manifests/logging.pp
+++ b/manifests/logging.pp
@@ -38,10 +38,6 @@
 #   If set to $facts['os_service_default'], it will not log to any file.
 #   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']
@@ -102,6 +98,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 trove::logging(
   $use_syslog                    = $facts['os_service_default'],
   $use_json                      = $facts['os_service_default'],
@@ -110,7 +112,6 @@ class trove::logging(
   $log_facility                  = $facts['os_service_default'],
   $log_dir                       = '/var/log/trove',
   $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'],
@@ -123,6 +124,8 @@ class trove::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 trove::deps
diff --git a/releasenotes/notes/deprecate-watch_log_file-370604865ba4b894.yaml b/releasenotes/notes/deprecate-watch_log_file-370604865ba4b894.yaml
new file mode 100644
index 00000000..f039fb0b
--- /dev/null
+++ b/releasenotes/notes/deprecate-watch_log_file-370604865ba4b894.yaml
@@ -0,0 +1,4 @@
+---
+deprecations:
+  - |
+    The ``trove::logging::watch_log_file`` parameter has been deprecated.
diff --git a/spec/classes/trove_logging_spec.rb b/spec/classes/trove_logging_spec.rb
index 748eeff1..a88bc3b3 100644
--- a/spec/classes/trove_logging_spec.rb
+++ b/spec/classes/trove_logging_spec.rb
@@ -67,7 +67,6 @@ describe 'trove::logging' do
         :syslog_log_facility => '<SERVICE DEFAULT>',
         :log_dir             => '/var/log/trove',
         :log_file            => '<SERVICE DEFAULT>',
-        :watch_log_file      => '<SERVICE DEFAULT>',
         :debug               => '<SERVICE DEFAULT>',
       )
     end