Skip to main content

Configuration

Tasklist is a Spring Boot application. That means all ways to configure a Spring Boot application can be applied. By default, the configuration for Tasklist is stored in a YAML file application.yml. All Tasklist related settings are prefixed with zeebe.tasklist. The following parts are configurable:

Webserver​

Tasklist supports customizing the context-path by using default spring configuration.

Example for application.yml: server.servlet.context-path: /tasklist

Example for environment variable: SERVER_SERVLET_CONTEXT_PATH=/tasklist

Default context-path is /

GraphQL API access​

Tasklist provides a GraphQL API under the endpoint /graphql. Clients can access this API by using a JWT access token in an authorization header Authorization: Bearer <JWT>.

Tasklist server needs the following settings to validate the token:

SettingDescriptionExample
zeebe.tasklist.client.audienceTasklist tries to match this with aud in JWTtasklist.camunda.io
zeebe.tasklist.client.clusterIdTasklist tries to match this with scope in JWTcafe-0815-0235-a221-21cc6df91dc5
spring.security.oauth2.resourceserver.jwt.jwk-set-uri (recommended)Complete URI to get public keys for JWT validationhttps://weblogin.cloud.company.com/.well-known/jwks.json
OR
spring.security.oauth2.resourceserver.jwt.issuer-uriURI to get public keys for JWT validationhttps://weblogin.cloud.company.com/

The settings can be given in application.yml (eg. zeebe.tasklist.client.audience: tasklist.camunda.io) or as environment variables (eg. ZEEBE_TASKLIST_CLIENT_AUDIENCE=tasklist.camunda.io)

The API client needs to obtain JWT token and send it in each request to graphql in an authorization header as described above.

Elasticsearch​

Tasklist stores and reads data in/from Elasticsearch.

Settings to connect​

Tasklist supports basic authentication for elasticsearch. Set the appropriate username/password combination in the configuration to use it.

NameDescriptionDefault value
zeebe.tasklist.elasticsearch.clusterNameClustername of Elasticsearchelasticsearch
zeebe.tasklist.elasticsearch.urlURL of Elasticsearch REST APIhttp://localhost:9200
zeebe.tasklist.elasticsearch.usernameUsername to access Elasticsearch REST API-
zeebe.tasklist.elasticsearch.passwordPassword to access Elasticsearch REST API-

Settings for shards and replicas​

Tasklist creates the template with index settings named tasklist-<version>_template that Elasticsearch will use for all Tasklist indices. These settings can be changed.

Following configuration parameters will define the settings:

NameDescriptionDefault value
zeebe.tasklist.elasticsearch.numberOfShardsHow many shards Elasticsearch uses for all Tasklist indices1
zeebe.tasklist.elasticsearch.numberOfReplicasHow many replicas Elasticsearch uses for all Tasklist indices0

These values are applied only on first startup of Tasklist or during version upgrade. After Tasklist ELS schema is created, settings may be adjusted directly in ELS template and the new settings will be applied to indices created after adjustment.

A snippet from application.yml:​

zeebe.tasklist:
  elasticsearch:
    # Cluster name
    clusterName: elasticsearch
    # Url
    url: http://localhost:9200

Zeebe broker connection​

Tasklist needs a connection to Zeebe Broker to start the import.

Settings to connect​

NameDescriptionDefault value
zeebe.tasklist.zeebe.brokerContactPointBroker contact point to zeebe as hostname and portlocalhost:26500

A snippet from application.yml:​

zeebe.tasklist:
  zeebe:
    # Broker contact point
    brokerContactPoint: localhost:26500

Zeebe Elasticsearch exporter​

Tasklist imports data from Elasticsearch indices created and filled in by Zeebe Elasticsearch Exporter. Therefore settings for this Elasticsearch connection must be defined and must correspond to the settings on Zeebe side.

Settings to connect and import:​

NameDescriptionDefault value
zeebe.tasklist.zeebeElasticsearch.clusterNameCluster name of Elasticsearchelasticsearch
zeebe.tasklist.zeebeElasticsearch.urlURL of Elasticsearch REST APIhttp://localhost:9200
zeebe.tasklist.zeebeElasticsearch.hostHostname where Elasticsearch is runninglocalhost
zeebe.tasklist.zeebeElasticsearch.portPort of Elasticsearch REST API9200
zeebe.tasklist.zeebeElasticsearch.prefixIndex prefix as configured in Zeebe Elasticsearch exporterzeebe-record
zeebe.tasklist.zeebeElasticsearch.usernameUsername to access Elasticsearch REST API-
zeebe.tasklist.zeebeElasticsearch.passwordPassword to access Elasticsearch REST API-

A snippet from application.yml:​

zeebe.tasklist:
  zeebeElasticsearch:
    # Cluster name
    clusterName: elasticsearch
    # Url
    url: localhost:9200
    # Index prefix, configured in Zeebe Elasticsearch exporter
    prefix: zeebe-record

Monitoring and health probes​

Tasklist includes Spring Boot Actuator inside, that provides number of monitoring possibilities., e.g. health check (http://localhost:8080/actuator/health) and metrics (http://localhost:8080/actuator/prometheus) endpoints.

Tasklist uses following Actuator configuration by default:

# enable health check and metrics endpoints
management.endpoints.web.exposure.include: health,prometheus
# enable Kubernetes health groups:
# https://docs.spring.io/spring-boot/docs/current/reference/html/production-ready-features.html#production-ready-kubernetes-probes
management.health.probes.enabled: true

With this configuration following endpoints are available for use out of the box:

<server>:8080/actuator/prometheus Prometheus metrics

<server>:8080/actuator/health/liveness Liveness probe

<server>:8080/actuator/health/readiness Readiness probe

Example snippets to use Tasklist probes in Kubernetes:​

For details to set Kubernetes probes parameters see: Kubernetes configure probes

Readiness probe as yaml config:​

readinessProbe:
     httpGet:
        path: /actuator/health/readiness
        port: 8080
     initialDelaySeconds: 30
     periodSeconds: 30

Liveness probe as yaml config:​

livenessProbe:
     httpGet:
        path: /actuator/health/liveness
        port: 8080
     initialDelaySeconds: 30
     periodSeconds: 30

Logging​

Tasklist uses Log4j2 framework for logging. In distribution archive as well as inside a Docker image config/log4j2.xml logging configuration files is included, that can be further adjusted to your needs:

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN" monitorInterval="30">
  <Properties>
    <Property name="LOG_PATTERN">%clr{%d{yyyy-MM-dd HH:mm:ss.SSS}}{faint} %clr{%5p} %clr{${sys:PID}}{magenta} %clr{---}{faint} %clr{[%15.15t]}{faint} %clr{%-40.40c{1.}}{cyan} %clr{:}{faint} %m%n%xwEx</Property>
    <Property name="log.stackdriver.serviceName">${env:TASKLIST_LOG_STACKDRIVER_SERVICENAME:-tasklist}</Property>
    <Property name="log.stackdriver.serviceVersion">${env:TASKLIST_LOG_STACKDRIVER_SERVICEVERSION:-}</Property>
  </Properties>
  <Appenders>
    <Console name="Console" target="SYSTEM_OUT" follow="true">
      <PatternLayout pattern="${LOG_PATTERN}"/>
    </Console>
    <Console name="Stackdriver" target="SYSTEM_OUT" follow="true">
      <StackdriverLayout serviceName="${log.stackdriver.serviceName}"
        serviceVersion="${log.stackdriver.serviceVersion}" />
    </Console>
  </Appenders>
  <Loggers>
    <Logger name="io.zeebe.tasklist" level="info" />
    <Root level="info">
      <AppenderRef ref="${env:TASKLIST_LOG_APPENDER:-Console}"/>
    </Root>
  </Loggers>
</Configuration>

By default, Console log appender will be used.

JSON logging configuration​

You can choose to output logs in JSON format (Stackdriver compatible). To enable it, define the environment variable TASKLIST_LOG_APPENDER like this:

TASKLIST_LOG_APPENDER=Stackdriver

An example of application.yml file​

The following snippet represents the default Tasklist configuration, which is shipped with the distribution. It can be found inside the config folder (config/application.yml) and can be used to adjust Tasklist to your needs.

# Tasklist configuration file

zeebe.tasklist:
  # Set Tasklist username and password.
  # If user with <username> does not exists it will be created.
  # Default: demo/demo
  #username:
  #password:
  # ELS instance to store Tasklist data
  elasticsearch:
    # Cluster name
    clusterName: elasticsearch
    # Host
    host: localhost
    # Transport port
    port: 9200
  # Zeebe instance
  zeebe:
    # Broker contact point
    brokerContactPoint: localhost:26500
  # ELS instance to export Zeebe data to
  zeebeElasticsearch:
    # Cluster name
    clusterName: elasticsearch
    # Host
    host: localhost
    # Transport port
    port: 9200
    # Index prefix, configured in Zeebe Elasticsearch exporter
    prefix: zeebe-record