From ec4f21b17c310b047ea537cc041e52c7080335a3 Mon Sep 17 00:00:00 2001
From: Takashi Kajinami <kajinamit@oss.nttdata.com>
Date: 2024年9月22日 01:37:27 +0900
Subject: [PATCH] logging: Deprecate watch_log_file
This option was deprecated in oslo.log 6.0.0 [1].
[1] https://review.opendev.org/914788
Change-Id: I9aea6b99a2efee78fb561a6a36d796103d4c755e
---
 manifests/log.pp &#124; 22 ++++++++++++++-----
 ...ecate-watch_log_file-255b789d22db61ee.yaml &#124; 5 +++++
 2 files changed, 21 insertions(+), 6 deletions(-)
 create mode 100644 releasenotes/notes/deprecate-watch_log_file-255b789d22db61ee.yaml
diff --git a/manifests/log.pp b/manifests/log.pp
index 13e6be0..e7e4be8 100644
--- a/manifests/log.pp
+++ b/manifests/log.pp
@@ -31,10 +31,6 @@
 # If set to $facts['os_service_default'], it will not log to any directory.
 # 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']
-#
 # [*use_syslog*]
 # (Optional) Use syslog for logging (boolean value).
 # Defaults to $facts['os_service_default']
@@ -110,13 +106,18 @@
 # (Optional) Enables or disables fatal status of deprecations (boolean value).
 # Defaults to $facts['os_service_default']
 #
+# DEPRECATED PARAMETERS
+#
+# [*watch_log_file*]
+# (Optional) Uses logging handler designed to watch file system (boolean value).
+# Defaults to undef
+#
 define oslo::log(
 $debug = $facts['os_service_default'],
 $log_config_append = $facts['os_service_default'],
 $log_date_format = $facts['os_service_default'],
 $log_file = $facts['os_service_default'],
 $log_dir = $facts['os_service_default'],
- $watch_log_file = $facts['os_service_default'],
 $use_syslog = $facts['os_service_default'],
 $use_journal = $facts['os_service_default'],
 $use_json = $facts['os_service_default'],
@@ -132,8 +133,17 @@ define oslo::log(
 $instance_format = $facts['os_service_default'],
 $instance_uuid_format = $facts['os_service_default'],
 $fatal_deprecations = $facts['os_service_default'],
+ # DEPRECATED PARMETERS
+ $watch_log_file = undef,
 ){
 
+ if $watch_log_file {
+ warning('The watch_log_file parameter has been deprecated and has no effect.')
+ $watch_log_file_real = $watch_log_file
+ } else {
+ $watch_log_file_real = $facts['os_service_default']
+ }
+
 $default_log_levels_real = $default_log_levels ? {
 Hash => join(sort(join_keys_to_values($default_log_levels, '=')), ','),
 Array => join(sort($default_log_levels), ','),
@@ -154,7 +164,7 @@ define oslo::log(
 'DEFAULT/log_date_format' => { value => $log_date_format },
 'DEFAULT/log_file' => { value => $log_file },
 'DEFAULT/log_dir' => { value => $log_dir },
- 'DEFAULT/watch_log_file' => { value => $watch_log_file },
+ 'DEFAULT/watch_log_file' => { value => $watch_log_file_real },
 'DEFAULT/use_syslog' => { value => $use_syslog },
 'DEFAULT/use_journal' => { value => $use_journal },
 'DEFAULT/use_json' => { value => $use_json },
diff --git a/releasenotes/notes/deprecate-watch_log_file-255b789d22db61ee.yaml b/releasenotes/notes/deprecate-watch_log_file-255b789d22db61ee.yaml
new file mode 100644
index 0000000..96df64f
--- /dev/null
+++ b/releasenotes/notes/deprecate-watch_log_file-255b789d22db61ee.yaml
@@ -0,0 +1,5 @@
+---
+features:
+ - &#124;
+ The ``oslo::logging::watch_log_file`` parameter has been deprecated and
+ has no effect now.
</div><div class="naked_ctrl">
<form action="/index.cgi/larger-text" method="get" name="gate">
<p><a href="http://altstyle.alfasado.net">AltStyle</a> によって変換されたページ <a href="https://opendev.org/openstack/puppet-oslo/commit/ec4f21b17c310b047ea537cc041e52c7080335a3.patch">(-&gt;オリジナル)</a>
/ <label>アドレス: <input type="text" name="naked_post_url" value="https://opendev.org/openstack/puppet-oslo/commit/ec4f21b17c310b047ea537cc041e52c7080335a3.patch" size="22" /></label> <label>モード: <select name="naked_post_mode">
<option value="default">デフォルト</option>
<option value="speech">音声ブラウザ</option>
<option value="ruby">ルビ付き</option>
<option value="contrast">配色反転</option>
<option value="larger-text" selected="selected">文字拡大</option>
<option value="mobile">モバイル</option>
</select>
<input type="submit" value="表示" />
</p>
</form>
</div>