Merge pull request voxpupuli#1396 from juokelis/debug_connection

Add debug_connection events option

manifests/config.pp

@@ -56,6 +56,7 @@
   $lingering_timeout              = $nginx::lingering_timeout
   $etag                           = $nginx::etag
   $events_use                     = $nginx::events_use
+  $debug_connections              = $nginx::debug_connections
   $fastcgi_cache_inactive         = $nginx::fastcgi_cache_inactive
   $fastcgi_cache_key              = $nginx::fastcgi_cache_key
   $fastcgi_cache_keys_zone        = $nginx::fastcgi_cache_keys_zone

manifests/init.pp

@@ -40,6 +40,10 @@
 #   already installed.  If the fact is unavailable, it defaults to '1.6.0'.
 #   You may need to set this manually to get a working and idempotent
 #   configuration.
+#
+# @param debug_connections
+#   Configures nginx `debug_connection` lines in the `events` section of the nginx config.
+#   See http://nginx.org/en/docs/ngx_core_module.html#debug_connection
 class nginx (
   ### START Nginx Configuration ###
   Variant[Stdlib::Absolutepath, Boolean] $client_body_temp_path = $nginx::params::client_body_temp_path,
@@ -88,6 +92,7 @@
   $lingering_timeout                                         = '5s',
   Optional[Enum['on', 'off']] $etag                          = undef,
   Optional[String] $events_use                               = undef,
+  Array[Nginx::DebugConnection] $debug_connections           = [],
   String $fastcgi_cache_inactive                             = '20m',
   Optional[String] $fastcgi_cache_key                        = undef,
   String $fastcgi_cache_keys_zone                            = 'd3:100m',

spec/classes/nginx_spec.rb

@@ -1077,6 +1077,15 @@
                 attr: 'ssl_password_file',
                 value: '/path/to/password_file',
                 match: '  ssl_password_file         /path/to/password_file;'
+              },
+              {
+                title: 'should contain debug_connection directives',
+                attr: 'debug_connections',
+                value: %w[127.0.0.1 unix:],
+                match: [
+                  '  debug_connection 127.0.0.1;',
+                  '  debug_connection unix:;'
+                ]
               }
             ].each do |param|
               context "when #{param[:attr]} is #{param[:value]}" do

spec/type_aliases/debugconnection_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe 'Nginx::DebugConnection' do
+  it { is_expected.to allow_value('127.0.0.1') }
+  it { is_expected.to allow_value('localhost') }
+  it { is_expected.to allow_value('192.0.2.0/24') }
+  it { is_expected.to allow_value('::1') }
+  it { is_expected.to allow_value('2001:0db8::/32') }
+  it { is_expected.to allow_value('unix:') }
+end

templates/conf.d/nginx.conf.erb

@@ -40,10 +40,13 @@ events {
   <%- end -%>
   worker_connections <%= @worker_connections -%>;
   <%- if @multi_accept == 'on' -%>
-    multi_accept on;
+  multi_accept on;
   <%- end -%>
   <%- if @events_use -%>
-    use <%= @events_use %>;
+  use <%= @events_use %>;
+  <%- end -%>
+  <%- @debug_connections.each do |address| -%>
+  debug_connection <%= address %>;
   <%- end -%>
 }
 

types/debugconnection.pp

@@ -0,0 +1 @@
+type Nginx::DebugConnection = Variant[Stdlib::Host, Stdlib::IP::Address, Enum['unix:']]