openstack/puppet-nova
Code Issues Proposed changes

allow to use access_log_env_var for apache wsgi

Browse Source 
Change-Id: I8cf5be457e8775a96a4491bda01a0a7a18e03c25
This commit is contained in:
Benedikt Trefzer
2023-11-07 17:59:29 +01:00
parent 4044c4d598
commit a92eafa444
5 changed files with 38 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
manifests/wsgi/apache_api.pp
View File

@@ -87,6 +87,11 @@
# (Optional) The log format for the virtualhost. # (Optional) The log format for the virtualhost.
# Defaults to undef. # Defaults to undef.
# #
# [*access_log_env_var*]
# (Optional) Specifies that only requests with particular
# environment variables be logged.
# Defaults to undef.
#
# [*error_log_file*] # [*error_log_file*]
# (Optional) The error log file name for the virtualhost. # (Optional) The error log file name for the virtualhost.
# Defaults to undef. # Defaults to undef.
@@ -152,6 +157,7 @@ class nova::wsgi::apache_api (
$access_log_pipe = undef, $access_log_pipe = undef,
$access_log_syslog = undef, $access_log_syslog = undef,
$access_log_format = undef, $access_log_format = undef,
$access_log_env_var = undef,
$error_log_file = undef, $error_log_file = undef,
$error_log_pipe = undef, $error_log_pipe = undef,
$error_log_syslog = undef, $error_log_syslog = undef,
@@ -199,6 +205,7 @@ class nova::wsgi::apache_api (
access_log_pipe => $access_log_pipe, access_log_pipe => $access_log_pipe,
access_log_syslog => $access_log_syslog, access_log_syslog => $access_log_syslog,
access_log_format => $access_log_format, access_log_format => $access_log_format,
access_log_env_var => $access_log_env_var,
error_log_file => $error_log_file, error_log_file => $error_log_file,
error_log_pipe => $error_log_pipe, error_log_pipe => $error_log_pipe,
error_log_syslog => $error_log_syslog, error_log_syslog => $error_log_syslog,

7
manifests/wsgi/apache_metadata.pp
View File

@@ -91,6 +91,11 @@
# (Optional) The log format for the virtualhost. # (Optional) The log format for the virtualhost.
# Defaults to undef. # Defaults to undef.
# #
# [*access_log_env_var*]
# (Optional) Specifies that only requests with particular
# environment variables be logged.
# Defaults to undef.
#
# [*error_log_file*] # [*error_log_file*]
# (Optional) The error log file name for the virtualhost. # (Optional) The error log file name for the virtualhost.
# Defaults to undef. # Defaults to undef.
@@ -157,6 +162,7 @@ class nova::wsgi::apache_metadata (
$access_log_pipe = undef, $access_log_pipe = undef,
$access_log_syslog = undef, $access_log_syslog = undef,
$access_log_format = undef, $access_log_format = undef,
$access_log_env_var = undef,
$error_log_file = undef, $error_log_file = undef,
$error_log_pipe = undef, $error_log_pipe = undef,
$error_log_syslog = undef, $error_log_syslog = undef,
@@ -212,6 +218,7 @@ class nova::wsgi::apache_metadata (
access_log_pipe => $access_log_pipe, access_log_pipe => $access_log_pipe,
access_log_syslog => $access_log_syslog, access_log_syslog => $access_log_syslog,
access_log_format => $access_log_format, access_log_format => $access_log_format,
access_log_env_var => $access_log_env_var,
error_log_file => $error_log_file, error_log_file => $error_log_file,
error_log_pipe => $error_log_pipe, error_log_pipe => $error_log_pipe,
error_log_syslog => $error_log_syslog, error_log_syslog => $error_log_syslog,

6
releasenotes/notes/access_log_env_var-d2d8ed2f6d542276.yaml Normal file
View File

@@ -0,0 +1,6 @@
---
features:
- |
Add the ``access_log_env_var`` parameter to the ``nova::wsgi::apache_api``
and the ``nova::wsgi::apache_metadata`` classes
to allow filtering logs (eg. suppress healthecks)

15
spec/classes/nova_wsgi_apache_api_spec.rb
View File

@@ -36,6 +36,7 @@ describe 'nova::wsgi::apache_api' do
:access_log_pipe => nil, :access_log_pipe => nil,
:access_log_syslog => nil, :access_log_syslog => nil,
:access_log_format => nil, :access_log_format => nil,
:access_log_env_var => nil,
:error_log_file => nil, :error_log_file => nil,
:error_log_pipe => nil, :error_log_pipe => nil,
:error_log_syslog => nil, :error_log_syslog => nil,
@@ -118,16 +119,18 @@ describe 'nova::wsgi::apache_api' do
let :params do let :params do
{ {
:access_log_format => 'foo', :access_log_format => 'foo',
:access_log_syslog => 'syslog:local0', :access_log_syslog => 'syslog:local0',
:error_log_syslog => 'syslog:local1', :error_log_syslog => 'syslog:local1',
:access_log_env_var => '!dontlog',
} }
end end
it { should contain_openstacklib__wsgi__apache('nova_api_wsgi').with( it { should contain_openstacklib__wsgi__apache('nova_api_wsgi').with(
:access_log_format => params[:access_log_format], :access_log_format => params[:access_log_format],
:access_log_syslog => params[:access_log_syslog], :access_log_syslog => params[:access_log_syslog],
:error_log_syslog => params[:error_log_syslog], :error_log_syslog => params[:error_log_syslog],
:access_log_env_var => params[:access_log_env_var],
)} )}
end end

15
spec/classes/nova_wsgi_apache_metadata_spec.rb
View File

@@ -34,6 +34,7 @@ describe 'nova::wsgi::apache_metadata' do
:access_log_pipe => nil, :access_log_pipe => nil,
:access_log_syslog => nil, :access_log_syslog => nil,
:access_log_format => nil, :access_log_format => nil,
:access_log_env_var => nil,
:error_log_file => nil, :error_log_file => nil,
:error_log_pipe => nil, :error_log_pipe => nil,
:error_log_syslog => nil, :error_log_syslog => nil,
@@ -112,16 +113,18 @@ describe 'nova::wsgi::apache_metadata' do
let :params do let :params do
{ {
:access_log_format => 'foo', :access_log_format => 'foo',
:access_log_syslog => 'syslog:local0', :access_log_syslog => 'syslog:local0',
:error_log_syslog => 'syslog:local1', :error_log_syslog => 'syslog:local1',
:access_log_env_var => '!dontlog',
} }
end end
it { should contain_openstacklib__wsgi__apache('nova_metadata_wsgi').with( it { should contain_openstacklib__wsgi__apache('nova_metadata_wsgi').with(
:access_log_format => params[:access_log_format], :access_log_format => params[:access_log_format],
:access_log_syslog => params[:access_log_syslog], :access_log_syslog => params[:access_log_syslog],
:error_log_syslog => params[:error_log_syslog], :error_log_syslog => params[:error_log_syslog],
:access_log_env_var => params[:access_log_env_var],
)} )}
end end