a9s LogMe2 SPI Configuration

This document describes a9s LogMe2 SPI configuration.

Summary

• Custom Parameter Configuration

Custom Parameter Configuration

The a9s LogMe2 SPI handles custom parameters for all service instances. It does configuration and validation of custom parameters.

The a9s LogMe2 SPI defines default values for certain custom parameters. Also, it defines whether a custom parameter can be set by the application developer.

The platform operator can overwrite those choices by changing the a9s LogMe2 SPI configuration. The platform operator has to configure the property logme2-spi.service_instance.custom_param_config. The property value must be a hash. Every key in that hash stands for a custom parameter and the value for every key contains the configuration for that particular parameter. The configuration for a particular param is a hash consisting of the following optional keys: default_value and modifiable. The key default_value specifies the default value for that parameter and modifiable specifies whether the application developer is allowed to set that custom parameter. For example:

logme2-spi:
  service_instance:
    custom_param_config:
      groks:
        default_value: []
        modifiable: false

Default Custom Parameter Configuration

The following table contains custom parameters that are configurable by the platform operator. The meaning of those custom parameters can be read in the application developer documentation for a9s LogMe2.

Name	Default value	Is modifiable
groks	[]	true
ism_job_interval	5	true
ism_deletion_after	'30d'	true
ism_jitter	0.6	true
java_heapspace	null	true
java_maxmetaspace	null	true
opensearch-tls-ciphers	null	true
opensearch-tls-protocols	null	true
fluentd-udp	514	true
fluentd-tcp	0	true
fluentd-tls	6514	true
fluentd-tls-ciphers	null	true
fluentd-tls-version	null	true
fluentd-tls-min-version	null	true
fluentd-tls-max-version	null	true

Example Configuration

Let's build an imaginary example.

The custom parameter groks should have a default value of [] and the application developer should not be allowed to change it.

Then the configuration must look the following way:

logme2-spi:
  service_instance:
    custom_param_config:
      groks:
        default_value: []
        modifiable: false

Per Plan Configuration

Take a look at Service Plans documentation if you want to configure the custom parameters per plan.

info

Additional custom parameters will be made available over time. We do not make all available custom parameters the SPIs know available to the platform operator from the beginning.

During the SPI startup, the configuration the platform operator made will be checked. When it's invalid, the SPI will not start up.

logme2-spi.protocols

For more details on this property, please refer to the a9s Framework TLS configuration documentation.