Merge "Deprecate use_syslog"

manifests/init.pp

@@ -174,10 +174,6 @@
 #   (optional) Set log output to debug output.
 #   Defaults to undef
 #
-# [*use_syslog*]
-#   (optional) Use syslog for logging
-#   Defaults to undef
-#
 # [*use_stderr*]
 #   (optional) Use stderr for logging
 #   Defaults to undef
@@ -237,6 +233,10 @@
 #   (optional) Deprecated. Set log output to verbose output.
 #   Defaults to undef
 #
+# [*use_syslog*]
+#   (optional) DEPRECATED. Use syslog for logging
+#   Defaults to undef
+#
 class aodh (
   $ensure_package                     = 'present',
   $alarm_history_time_to_live         = $::os_service_default,
@@ -275,7 +275,6 @@ class aodh (
   $amqp_username                      = $::os_service_default,
   $amqp_password                      = $::os_service_default,
   $debug                              = undef,
-  $use_syslog                         = undef,
   $use_stderr                         = undef,
   $log_facility                       = undef,
   $log_dir                            = undef,
@@ -292,6 +291,7 @@ class aodh (
   $gnocchi_url                        = $::os_service_default,
   # DEPRECATED PARAMETERS
   $verbose                            = undef,
+  $use_syslog                         = undef,
 ) inherits aodh::params {
 
   include ::aodh::db
@@ -307,6 +307,10 @@ class aodh (
     warning('verbose is deprecated, has no effect and will be removed after Newton cycle.')
   }
 
+  if $use_syslog {
+    warning('use_syslog is deprecated, has no effect and will be removed in a future release')
+  }
+
   if $rpc_backend == 'rabbit' {
     oslo::messaging::rabbit { 'aodh_config':
       rabbit_userid               => $rabbit_userid,

manifests/logging.pp

@@ -8,10 +8,6 @@
 #    (Optional) Should the daemons log debug messages
 #    Defaults to $::os_service_default
 #
-#  [*use_syslog*]
-#    (Optional) Use syslog for logging.
-#    Defaults to $::os_service_default
-#
 #  [*use_stderr*]
 #    (optional) Use stderr for logging
 #    Defaults to $::os_service_default
@@ -92,8 +88,11 @@
 #    (Optional) Deprecated. Should the daemons log verbose messages
 #    Defaults to undef
 #
+#  [*use_syslog*]
+#    (Optional) Deprecated. Use syslog for logging.
+#    Defaults to undef
+#
 class aodh::logging(
-  $use_syslog                    = $::os_service_default,
   $use_stderr                    = $::os_service_default,
   $log_facility                  = $::os_service_default,
   $log_dir                       = '/var/log/aodh',
@@ -111,15 +110,19 @@ class aodh::logging(
   $log_date_format               = $::os_service_default,
   # DEPRECATED PARAMETERS
   $verbose                       = undef,
+  $use_syslog                    = undef,
 ) {
 
   if $verbose {
     warning('verbose is deprecated, has no effect and will be removed after Newton cycle.')
   }
 
+  if $use_syslog {
+    warning('use_syslog is deprecated, has no effect and will be removed in a future release.')
+  }
+
   # NOTE(spredzy): In order to keep backward compatibility we rely on the pick function
   # to use aodh::<myparam> first then aodh::logging::<myparam>.
-  $use_syslog_real   = pick($::aodh::use_syslog,$use_syslog)
   $use_stderr_real   = pick($::aodh::use_stderr,$use_stderr)
   $log_facility_real = pick($::aodh::log_facility,$log_facility)
   $log_dir_real      = pick($::aodh::log_dir,$log_dir)
@@ -127,7 +130,6 @@ class aodh::logging(
 
   oslo::log { 'aodh_config':
     debug                         => $debug_real,
-    use_syslog                    => $use_syslog_real,
     use_stderr                    => $use_stderr_real,
     log_dir                       => $log_dir_real,
     syslog_log_facility           => $log_facility_real,

releasenotes/notes/use_syslog-8829d3bda185a189.yaml

@@ -0,0 +1,4 @@
+---
+deprecations:
+ - use_syslog in DEFAULT section was deprecated in Mitaka, this parameter
+   has no effect and will be removed in a future release.

spec/classes/aodh_logging_spec.rb

@@ -23,7 +23,6 @@ describe 'aodh::logging' do
      :instance_format => '[instance: %(uuid)s] ',
      :instance_uuid_format => '[instance: %(uuid)s] ',
      :log_date_format => '%Y-%m-%d %H:%M:%S',
-     :use_syslog => true,
      :use_stderr => false,
      :log_facility => 'LOG_FOO',
      :log_dir => '/var/log',
@@ -55,7 +54,6 @@ describe 'aodh::logging' do
 
   shared_examples 'basic default logging settings' do
     it 'configures aodh logging settings with default values' do
-      is_expected.to contain_aodh_config('DEFAULT/use_syslog').with(:value => '<SERVICE DEFAULT>')
       is_expected.to contain_aodh_config('DEFAULT/use_stderr').with(:value => '<SERVICE DEFAULT>')
       is_expected.to contain_aodh_config('DEFAULT/syslog_log_facility').with(:value => '<SERVICE DEFAULT>')
       is_expected.to contain_aodh_config('DEFAULT/log_dir').with(:value => '/var/log/aodh')
@@ -65,7 +63,6 @@ describe 'aodh::logging' do
 
   shared_examples 'basic non-default logging settings' do
     it 'configures aodh logging settins with non-default values' do
-      is_expected.to contain_aodh_config('DEFAULT/use_syslog').with(:value => 'true')
       is_expected.to contain_aodh_config('DEFAULT/use_stderr').with(:value => 'false')
       is_expected.to contain_aodh_config('DEFAULT/syslog_log_facility').with(:value => 'LOG_FOO')
       is_expected.to contain_aodh_config('DEFAULT/log_dir').with(:value => '/var/log')