Merge pull request #1260 from voxpupuli/new-log4j-support

Add parameter to manage the content of log4j2.properties

Author: h-haaks

REFERENCE.md

@@ -129,6 +129,7 @@ The following parameters are available in the `elasticsearch` class:
 * [`license`](#-elasticsearch--license)
 * [`logdir`](#-elasticsearch--logdir)
 * [`logdir_mode`](#-elasticsearch--logdir_mode)
+* [`logging_content`](#-elasticsearch--logging_content)
 * [`manage_datadir`](#-elasticsearch--manage_datadir)
 * [`manage_logdir`](#-elasticsearch--manage_logdir)
 * [`manage_repo`](#-elasticsearch--manage_repo)
@@ -398,6 +399,14 @@ Mode directory that will be used for Elasticsearch logging (default 2750).
 
 Default value: `'2750'`
 
+##### <a name="-elasticsearch--logging_content"></a>`logging_content`
+
+Data type: `Optional[Variant[String, Array]]`
+
+Content to use for the logging configuration file (log4j2.properties).
+
+Default value: `undef`
+
 ##### <a name="-elasticsearch--manage_datadir"></a>`manage_datadir`
 
 Data type: `Boolean`

manifests/config.pp

@@ -141,6 +141,24 @@
       $_tls_config = {}
     }
 
+    # Logging file
+    if ! ($elasticsearch::logging_content =~ Undef) {
+      if $elasticsearch::logging_content =~ Array {
+        $_log4j_content = $elasticsearch::logging_content.join("\n")
+      } else {
+        $_log4j_content = $elasticsearch::logging_content
+      }
+      file { "${elasticsearch::configdir}/log4j2.properties":
+        ensure  => file,
+        content => $_log4j_content,
+        notify  => $elasticsearch::_notify_service,
+        require => Class['elasticsearch::package'],
+        owner   => 'root',
+        group   => $elasticsearch::elasticsearch_group,
+        mode    => '0640',
+      }
+    }
+
     # Generate Elasticsearch config
     $data =
       $elasticsearch::config + { 'path.data' => $elasticsearch::datadir } + { 'path.logs' => $elasticsearch::logdir } + $_tls_config
@@ -150,9 +168,9 @@
       content => template("${module_name}/etc/elasticsearch/elasticsearch.yml.erb"),
       notify  => $elasticsearch::_notify_service,
       require => Class['elasticsearch::package'],
-      owner   => $elasticsearch::elasticsearch_user,
+      owner   => 'root',
       group   => $elasticsearch::elasticsearch_group,
-      mode    => '0440',
+      mode    => '0640',
     }
 
     file { "${elasticsearch::configdir}/jvm.options":

manifests/init.pp

@@ -133,6 +133,9 @@
 # @param logdir_mode
 #   Mode directory that will be used for Elasticsearch logging (default 2750).
 #
+# @param logging_content
+#   Content to use for the logging configuration file (log4j2.properties).
+#
 # @param manage_datadir
 #   Enable datadir management (default true).
 #
@@ -375,6 +378,7 @@
   Optional[String]                                $keystore_password         = undef,
   Optional[Stdlib::Absolutepath]                  $keystore_path             = undef,
   Stdlib::Filemode                                $logdir_mode               = '2750',
+  Optional[Variant[String, Array]]                $logging_content           = undef,
   Boolean                                         $package_hold              = false,
   Optional[Stdlib::Absolutepath]                  $private_key               = undef,
   Enum['rsa','dsa','ec']                          $private_key_type          = 'rsa',

spec/classes/000_elasticsearch_init_spec.rb

@@ -79,6 +79,8 @@
         }
       end
 
+      it { expect(subject).not_to contain_file('/etc/elasticsearch/log4j2.properties') }
+
       context 'java installation' do
         let(:pre_condition) do
           <<-MANIFEST
@@ -346,6 +348,35 @@
           expect(subject).not_to contain_file('/var/log/elasticsearch-log')
         }
       end
+
+      context 'When using custom logging_content String' do
+        let(:params) do
+          default_params.merge(
+            logging_content: '# Content'
+          )
+        end
+
+        it {
+          expect(subject).to contain_file('/etc/elasticsearch/log4j2.properties').
+            with(ensure: 'file', content: '# Content')
+        }
+      end
+
+      context 'When using custom logging_content Array' do
+        let(:params) do
+          default_params.merge(
+            logging_content: [
+              '# Content Line 1',
+              '# Content Line 2',
+            ]
+          )
+        end
+
+        it {
+          expect(subject).to contain_file('/etc/elasticsearch/log4j2.properties').
+            with(ensure: 'file', content: "# Content Line 1\n# Content Line 2")
+        }
+      end
     end
   end
   # rubocop:enable RSpec/MultipleMemoizedHelpers