Add Apache WSGI logging parameters for pipe/syslog

Add parameters for advanced logging configurations in Apache to
support piped logging and support for syslog (via mod_syslog
available in Apache >= 2.5.0)

Co-Authored-By: Andy Botting <andy@andybotting.com>
Change-Id: Ie2f8feadd568565308210d73c2a89b2beef43697

manifests/wsgi/apache.pp

@@ -70,15 +70,33 @@
 #
 # [*access_log_file*]
 #   (Optional) The log file name for the virtualhost.
-#   Defaults to undef
+#   Defaults to undef.
+#
+# [*access_log_pipe*]
+#   (Optional) Specifies a pipe where Apache sends access logs for
+#   the virtualhost.
+#   Defaults to undef.
+#
+# [*access_log_syslog*]
+#   (Optional) Sends the virtualhost access log messages to syslog.
+#   Defaults to undef.
 #
 # [*access_log_format*]
 #   (Optional) The log format for the virtualhost.
-#   Defaults to undef
+#   Defaults to undef.
 #
 # [*error_log_file*]
 #   (Optional) The error log file name for the virtualhost.
-#   Defaults to undef
+#   Defaults to undef.
+#
+# [*error_log_pipe*]
+#   (Optional) Specifies a pipe where Apache sends error logs for
+#   the virtualhost.
+#   Defaults to undef.
+#
+# [*error_log_syslog*]
+#   (Optional) Sends the virtualhost error log messages to syslog.
+#   Defaults to undef.
 #
 # [*headers*]
 #   (optional) Headers for the vhost.
@@ -117,8 +135,12 @@ class placement::wsgi::apache (
   $ssl_crl                   = undef,
   $ssl_certs_dir             = undef,
   $access_log_file           = undef,
+  $access_log_pipe           = undef,
+  $access_log_syslog         = undef,
   $access_log_format         = undef,
   $error_log_file            = undef,
+  $error_log_pipe            = undef,
+  $error_log_syslog          = undef,
   $headers                   = undef,
   $request_headers           = undef,
   $vhost_custom_fragment     = undef,
@@ -157,8 +179,12 @@ class placement::wsgi::apache (
     headers                   => $headers,
     request_headers           => $request_headers,
     access_log_file           => $access_log_file,
+    access_log_pipe           => $access_log_pipe,
+    access_log_syslog         => $access_log_syslog,
     access_log_format         => $access_log_format,
     error_log_file            => $error_log_file,
+    error_log_pipe            => $error_log_pipe,
+    error_log_syslog          => $error_log_syslog,
   }
 
 }

releasenotes/notes/httpd-logs-piped-syslog-dfed7ae36f4dac16.yaml

@@ -0,0 +1,6 @@
+---
+features:
+  - |
+    Added parameters for advanced configuration of httpd access and error log
+    destinations including piped logging and syslog (see `mod_syslog`). Note
+    that mod_syslog requires Apache2 >= 2.5.0.

spec/classes/placement_wsgi_apache_spec.rb

@@ -31,8 +31,12 @@ describe 'placement::wsgi::apache' do
         :headers                   => nil,
         :request_headers           => nil,
         :access_log_file           => nil,
+        :access_log_pipe           => nil,
+        :access_log_syslog         => nil,
         :access_log_format         => nil,
         :error_log_file            => nil,
+        :error_log_pipe            => nil,
+        :error_log_syslog          => nil,
       )}
     end
 
@@ -56,9 +60,6 @@ describe 'placement::wsgi::apache' do
           :wsgi_process_display_name => 'custom',
           :threads                   => 5,
           :priority                  => 25,
-          :access_log_file           => '/var/log/httpd/access_log',
-          :access_log_format         => 'some format',
-          :error_log_file            => '/var/log/httpd/error_log',
           :headers                   => ['set X-XSS-Protection "1; mode=block"'],
           :request_headers           => ['set Content-Type "application/json"'],
         }
@@ -93,9 +94,70 @@ describe 'placement::wsgi::apache' do
         :wsgi_script_source        => platform_params[:wsgi_script_source],
         :headers                   => ['set X-XSS-Protection "1; mode=block"'],
         :request_headers           => ['set Content-Type "application/json"'],
-        :access_log_file           => params[:access_log_file],
-        :access_log_format         => params[:access_log_format],
-        :error_log_file            => params[:error_log_file],
+      )}
+    end
+
+    context 'with custom access logging' do
+      let :params do
+        {
+          :access_log_format => 'foo',
+          :access_log_syslog => 'syslog:local0',
+          :error_log_syslog  => 'syslog:local1',
+        }
+      end
+
+      it { should contain_openstacklib__wsgi__apache('placement_wsgi').with(
+        :access_log_format => params[:access_log_format],
+        :access_log_syslog => params[:access_log_syslog],
+        :error_log_syslog  => params[:error_log_syslog],
+      )}
+    end
+
+    context 'with access_log_file' do
+      let :params do
+        {
+          :access_log_file => '/path/to/file',
+        }
+      end
+
+      it { should contain_openstacklib__wsgi__apache('placement_wsgi').with(
+        :access_log_file => params[:access_log_file],
+      )}
+    end
+
+    context 'with access_log_pipe' do
+      let :params do
+        {
+          :access_log_pipe => 'pipe',
+        }
+      end
+
+      it { should contain_openstacklib__wsgi__apache('placement_wsgi').with(
+        :access_log_pipe => params[:access_log_pipe],
+      )}
+    end
+
+    context 'with error_log_file' do
+      let :params do
+        {
+          :error_log_file => '/path/to/file',
+        }
+      end
+
+      it { should contain_openstacklib__wsgi__apache('placement_wsgi').with(
+        :error_log_file => params[:error_log_file],
+      )}
+    end
+
+    context 'with error_log_pipe' do
+      let :params do
+        {
+          :error_log_pipe => 'pipe',
+        }
+      end
+
+      it { should contain_openstacklib__wsgi__apache('placement_wsgi').with(
+        :error_log_pipe => params[:error_log_pipe],
       )}
     end
   end