[ENHANCEMENT] Zeebe add support for additional Exporter Configuration

[felicijus]

Describe the use case:

The configuration of additional Zeebe exporters are currently not supported directly via the camunda-platform Helm Chart. The usage of custom exporters should be possible natively.

UseCases See:

• zeebe-redis-exporter
• zeebe-kafka-exporter
• zeebe-hazelcast-exporter

All of these examples of exporters expect the user to change the application.yaml of zeebe to something like this:

zeebe:
  broker:
    exporters:
      <exporter>:
        className: <className>
        jarPath: <jarPath>
        args:
          <key: value>

Describe the enhancement/feature:

Currently camunda-platform Helm Charts only supports the addition of Zeebe exporters by using initContainer and environment variables. Or manually changing the Zeebe application.yaml.

This could be changed by providing a property like additionalExporterConfig inside values.yaml:

zeebe:
  additionalExporterConfig:
      redis:
        className: "io.zeebe.redis.exporter.RedisExporter"
        jarPath: "/usr/local/zeebe/lib/zeebe-redis-exporter-1.0.2-jar-with-dependencies.jar"
        args:
          remoteAddress: "redis://redis:6379"
      
      kafka:
        className: "io.zeebe.kafka.exporter.KafkaExporter"
        jarPath: "/usr/local/zeebe/lib/zeebe-kafka-exporter-1.0.2-jar-with-dependencies.jar"
        args:
          bootstrapServers: "kafka:9092"

Desired outcome and acceptance tests:

Contents of a property like additionalExporterConfig should be rendered by the Helm Chart into the Zeebe configmap inside application.yaml to support additional exporters.

[hisImminence]

@theburi please have a look on this feature request regarding prioritization.

Related to:

• [ENHANCEMENT] As a User I can extend the default application configuration #2197
• [TASK] Extend default applications configuration #2186

[jessesimpson36]

for 8.8, the options appear to be

camunda.data.exporters.[exporter name].class-name
camunda.data.exporters.[exporter name].jar-path
camunda.data.exporters.[exporters].args.[key]

in orchestration configmap

[hisImminence]

Thanks @felicijus for your contribution and sorry for the late response - @jessesimpson36 added support for 8.6 and 8.7. The remaining work here is:

• add support for 8.8 and 8.9 for this feature
• have an integration test scenario that QA use for testing.
• update the guide in the docs and move it back to helm chart/configuration.

@theburi, can you give feedback regarding priorization of this FR? If we decide to not implement this feature - we should at least update the guide in the doc.

[jessesimpson36]

PM responded that since a small number of users use custom exporters, and it's possible to get this functionality working via env vars or a custom application.yaml via the configuration option, it does not make sense to support via values.yaml a new option for easier configuration of custom exporters.

Closing this issue and related PR as wontfix