Condition Monitoring - Helm Configuration
The following parameters are the most common which might be relevant to be adjusted based on client requirements.
The comprehensive list of available variables for each service can be found in the following chapters:
Standardized Helm Configuration Parameters
This module in general follows the general IAS Operations Manual and the helm parameters that are described there e.g. for logging, databases, messaging, …
Module Helm Configuration Parameters
General
global.modules.cm.enabled
| Description |
Enables or disables the module |
| Required |
Yes |
| Defaults to |
false |
| Sources |
Environment Variable |
global.modules.cm.ruleManagementLightEnabled
| Description |
Defines if the application will run in "Rules Light" (true) or "Rules Extended (Kafka)" (false) mode |
| Required |
Yes |
| Defaults to |
true |
| Sources |
Environment Variable |
cm.local.swaggerEnabled
| Description |
Flag to enable Swagger UI |
| Required |
No |
| Defaults to |
false |
| Sources |
Environment Variable (inherited from global setting, but can be overridden with local setting) |
cm.local.deviation.forwardMachineMessagesTenantIds
| Description |
List of tenant ids for which machine messages should be forwarded as deviations. Value is comma seperated tenantId list e.g. 7311ea8c-5d48-43fe-acf9-980eedf24b6c,5ce47434-c412-4e8c-8482-0ce1df556493 |
| Required |
No |
| Defaults to |
- |
| Sources |
Environment Variable |
cm.local.deviation.migrationCreateRuleFromDeviationsTenantIds
| Description |
TenantIds for which we should create Hit of event rules out of deviation notification. You need to define that before migration. Value is comma seperated tenantId list e.g. 7311ea8c-5d48-43fe-acf9-980eedf24b6c,5ce47434-c412-4e8c-8482-0ce1df556493 |
| Required |
No |
| Defaults to |
- |
| Sources |
Environment Variable |
Logging
cm.local.logging.default
| Description |
Sets the log level for the root logger |
| Required |
No |
| Defaults to |
Global setting (global.logging.default) |
| Sources |
Environment Variable (inherited from global setting, but can be overridden with local setting) |
cm.local.logging.application
| Description |
Sets the log level for all Bosch components |
| Required |
No |
| Defaults to |
Global setting (global.logging.application) |
| Sources |
Environment Variable (inherited from global setting, but can be overridden with local setting) |
cm.local.logging.kafka
| Description |
Sets the log level for Kafka client |
| Required |
No |
| Defaults to |
WARN |
| Sources |
Environment Variable |
cm.local.logging.amqp
| Description |
Sets the log level for amqp |
| Required |
No |
| Defaults to |
INFO |
| Sources |
Environment Variable |
cm.local.logging.messaging
| Description |
Sets the log level for messaging |
| Required |
No |
| Defaults to |
INFO |
| Sources |
Environment Variable |
cm.local.logging.spring
| Description |
Sets the log level for spring |
| Required |
No |
| Defaults to |
INFO |
| Sources |
Environment Variable |
cm.local.logging.springSecurity
| Description |
Sets the log level for spring security |
| Required |
No |
| Defaults to |
INFO |
| Sources |
Environment Variable |
cm.local.logging.springWeb
| Description |
Sets the log level for spring web |
| Required |
No |
| Defaults to |
INFO |
| Sources |
Environment Variable |
cm.local.logging.webServer
| Description |
Sets the log level for the webserver |
| Required |
No |
| Defaults to |
INFO |
| Sources |
Environment Variable |
Kafka
cm.local.kafkaTopicPrefix
| Description |
In case multiple environments use the same Kafka, the prefix makes the difference. |
| Required |
Yes |
| Defaults to |
Global setting (global.nexeedHost.) |
| Sources |
Environment Variable rm_kafka_topic_prefix |
cm.local.kafkaTopicPartitions
| Description |
Number of Kafka partitions for each topic. |
| Required |
No |
| Defaults to |
50 |
| Sources |
Environment Variable rm_kafka_topic_partitions |
cm.local.kafkaTopicAutoCreation
| Description |
Flag checked at service startup to create topics. |
| Required |
No |
| Defaults to |
false |
| Sources |
Environment Variable rm_kafka_topic_auto_creation |
Influx
cm.local.influx.logLevel
| Description |
The log level for Influx database related communication. Possible values: NONE, BASIC, HEADERS, FULL |
| Required |
No |
| Defaults to |
NONE |
| Sources |
Environment Variable influx_log_level |
cm.local.influx.retentionPolicyReplication
| Description |
The retention policy replication factor describes how many copies of the inserted data are stored in the cluster. Replication > 1 needs an Influx enterprise license. |
| Required |
No |
| Defaults to |
2 |
| Sources |
Environment Variable influx_retention_policy_replication |
cm.local.influx.eventRetentionPolicyDuration
| Description |
The retention policy duration describes for how long the Influx database keeps the event (rule result and machine messages) data. |
| Required |
No |
| Defaults to |
180d |
| Sources |
Environment Variable influx_event_retention_policy_duration |
cm.local.influx.msmRetentionPolicyDuration
| Description |
The retention policy duration describes for how long the Influx database keeps the raw measurements data. |
| Required |
No |
| Defaults to |
7d |
| Sources |
Environment Variable influx_msm_retention_policy_duration |
cm.local.influx.msmDeferredRetentionPolicyDuration
| Description |
The deferred retention policy duration describes for how long the Influx database keeps the raw measurements data. |
| Required |
No |
| Defaults to |
1d |
| Sources |
Environment Variable influx_msm_deferred_retention_policy_duration |
cm.local.influx.msmLevel1RetentionPolicyDuration
| Description |
The retention policy duration describes for how long the Influx database keeps the 1 minute aggregated measurements data. |
| Required |
No |
| Defaults to |
45d |
| Sources |
Environment Variable influx_msm_level1_retention_policy_duration |
cm.local.influx.msmLevel2RetentionPolicyDuration
| Description |
The retention policy duration describes for how long the Influx database keeps the 30 minute aggregated measurements data. |
| Required |
No |
| Defaults to |
90d |
| Sources |
Environment Variable influx_msm_level2_retention_policy_duration |
cm.local.influx.msmLevel3RetentionPolicyDuration
| Description |
The retention policy duration describes for how long the Influx database keeps the 12 hour aggregated measurements data. |
| Required |
No |
| Defaults to |
180d |
| Sources |
Environment Variable influx_msm_level3_retention_policy_duration |
cm.local.influx.ppmpMetaDataRetentionPolicyDuration
| Description |
The retention policy duration describes for how long the Influx database keeps the metadata information (e.g. part type). |
| Required |
No |
| Defaults to |
30d |
| Sources |
Environment Variable influx_ppmp_metadata_retention_policy_duration |
Open Telemetry
Preliminary Remark
The full list of parameter can be found in the official OpenTelemetry documentation
cm.local.observability.otelAutoInjectEnvParams
| Description |
Whether to inject the global configuration for open telemetry or not. |
| Required |
yes |
| Defaults to |
true |
cm.local.observability.otelEnabled
| Description |
Attaches the OpenTelemetry Java agent to the JVM |
| Required |
No |
| Defaults to |
false |
| Sources |
Environment Variable otel_enabled |
cm.local.observability.otelResourceAttributes
| Description |
Sets the resource attributes. Typically 'service.name=<serviceName>,service.version=<version>,deployment.environment=<host>' |
| Required |
No |
| Defaults to |
N/A |
| Sources |
Environment Variable otel_resource_attributes |
cm.local.observability.otlpLoggingEnabled
| Description |
Specifies which exporter is used for logs. |
| Required |
No |
| Defaults to |
false |
| Sources |
Environment Variable otel_logs_exporter |
cm.local.observability.otlpMetricEnabled
| Description |
Specifies which exporter is used for metrics. |
| Required |
No |
| Defaults to |
true |
| Sources |
Environment Variable otel_metrics_exporter |
cm.local.observability.otlpTracingEnabled
| Description |
Specifies which exporter is used for traces. |
| Required |
No |
| Defaults to |
true |
| Sources |
Environment Variable otel_traces_exporter |
cm.local.observability.otlpUrl
| Description |
Endpoint of the monitoring backend. |
| Required |
No |
| Defaults to |
N/A |
| Sources |
Environment Variable otel_exporter_otlp_endpoint |
cm.local.observability.otlpProtocol
| Description |
Specifies the OTLP transport protocol to be used for all telemetry data. |
| Required |
No |
| Defaults to |
grpc |
| Sources |
Environment Variable otel_exporter_otlp_protocol |
cm.local.observability.tracesSampler
| Description |
Specifies the Sampler used to sample traces by the SDK |
| Required |
No |
| Defaults to |
parentbased_always_on |
| Sources |
Environment Variable otel_traces_sampler |
cm.local.observability.tracesSamplerArg
| Description |
Specifies arguments, if applicable, to the sampler defined in by OTEL_TRACES_SAMPLER. The specified value will only be used if OTEL_TRACES_SAMPLER is set. Each Sampler type defines its own expected input, if any. Invalid or unrecognized input is logged as an error. |
| Required |
No |
| Defaults to |
1.0 |
| Sources |
Environment Variable otel_traces_sampler_arg |
cm.local.observability.otlpHeaders
| Description |
Sets authentication headers used by the OpenTelemetry OTLP exporter to authenticate against the monitoring backend. Typically, Authorization=Bearer <token> |
| Required |
No |
| Defaults to |
N/A |
| Sources |
Environment Variable otel_exporter_otlp_headers |