Configuration

Configuration properties

Deprecated settings for Axon Server connection

While these configuration options are still valid, please migrate to the new ones specified below. In future releases, these configuration options might no longer exists.

synapse.server-list

Comma-separated list of Axon Servers.

The property is deprecated. Please use synapse.axonServer.server-list instead.

SYNAPSE_SERVER_LIST

localhost

synapse.use-tls

Whether Axon Server connection is TLS encrypted

The property is deprecated. Please use synapse.axonServer.tlsEnabled instead.

SYNAPSE_USE_TLS

synapse.certificate-chain

Path to the file with a certificate

The property is deprecated. Please use synapse.axonServer.trustManagerFile instead.

SYNAPSE_CERTIFICATE_CHAIN

Axon Server connection

synapse.axon-server.server-list

Comma-separated list of known Axon Server instances. See "TLS for outgoing connections to AxonServer" below for TLS settings

SYNAPSE_AXON_SERVER_SERVER_LIST

localhost:8124

synapse.axon-server-http.port

HTTP port of Axon Server. See "TLS for outgoing connections to AxonServer" below for TLS settings

SYNAPSE_AXON_SERVER_HTTP_PORT

8024

synapse.axon-server-http.clients-for-component-endpoints-path

Path in Axon Server used to retrieve information about other synapse instances

SYNAPSE_AXON_SERVER_HTTP_CLIENTS_FOR_COMPONENT_ENDPOINTS_PATH

v1/components/clients

synapse.client-id

Synapse instance identifier as seen by the Axon Server

SYNAPSE_CLIENT_ID

JVM process name

synapse.component-name

Synapse component name as seen by the Axon Server

SYNAPSE_COMPONENT_NAME

synapse

synapse.client-component-name

Synapse client component name as seen by the Axon Server

SYNAPSE_CLIENT_COMPONENT_NAME

synapse-client

synapse.connection-timeout

Duration of inactivity, after which Synapse closes the connection to the Axon Server

SYNAPSE_CONNECTION_TIMEOUT

30s

synapse.default-context

The name of the default Axon Server context. It’s applied when the environment doesn’t provide context listing, for example, AS SE or AxonIQ Cloud.

SYNAPSE_DEFAULT_CONTEXT

default

Security

synapse.http-endpoints

Comma-separated list of Axon Server’s REST endpoints for fallback (applies for AS before 2023.0.0)

SYNAPSE_HTTP_ENDPOINTS

Authentication and authorization

synapse.internal.context

Context this synapse instance connects to

SYNAPSE_INTERNAL_CONTEXT

_admin

synapse.internal.client-id

Client id used by this synapse instance. Important if using multiple synapse instances.

SYNAPSE_INTERNAL_CLIENT_ID

unspecifiedSynapseInstance

synapse.internal.component-name

Component name used when contacting Axon Server. Should be the same for all synapse instances.

SYNAPSE_INTERNAL_COMPONENT_NAME

synapse

synapse.auth.enabled

Whether Synapse configuration APIs expect clients to provide username/password combination or token

SYNAPSE_AUTH_ENABLED

false

synapse.auth.token

Axon Server access control token. Used by synapse to connect to AxonServer

SYNAPSE_AUTH_TOKEN

synapse.auth.sensitive-data-encryption-key

Encryption key for securing sensitive data. It’s not possible to change the key once set without recreating authentication objects.

SYNAPSE_AUTH_SENSITIVE_DATA_ENCRYPTION_KEY

TLS for outgoing connections to AxonServer

synapse.axon-server.tls-enabled

Whether to enable TLS for connections from synapse to Axon Server via gRPC

SYNAPSE_AXON_SERVER_TLS_ENABLED

false

synapse.axon-server.trust-manager-file

File containing a trust manager for specifying trust for certificates presented by Axon Server via gRPC

SYNAPSE_AXON_SERVER_TRUST_MANAGER_FILE

synapse.axon-server-http.tls-enabled

Whether to enable TLS for connections from synapse to Axon Server via http

SYNAPSE_AXON_SERVER_HTTP_TLS_ENABLED

false

synapse.axon-server-http.trust-manager-file

File containing a trust manager for specifying trust for certificates presented by Axon Server via http

SYNAPSE_AXON_SERVER_HTTP_TRUST_MANAGER_FILE

TLS for outgoing connections client applications

synapse.synapse-handlers-http.trust-manager-files

File containing a trust manager for specifying trust for certificates presented by client applications

SYNAPSE_SYNAPSE_HANDLERS_HTTP_TRUST_MANAGER_FILEs

TLS for incoming connections

synapse.server.tls-enabled

Whether to enable TLS for connections coming to synapse

SYNAPSE_SERVER_TLS_ENABLED

false

synapse.server.key-store-file

A file containing a key store. Synapse expects either PKCS12 or JKS as a file format

SYNAPSE_SERVER_KEY_STORE_FILE

synapse.server.key-store-password

The password for the selected key store

SYNAPSE_SERVER_KEY_STORE_PASSWORD

synapse.server.key-store-type

The type of the selected key store. Synapse expects either PKCS12 or JKS

SYNAPSE_SERVER_KEY_STORE_TYPE

Other security related settings for synapse

synapse.security.cors-allowed-origins

Allowed origins as defined in Cross-Origin Resource Sharing (CORS)

SYNAPSE_SECURITY_CORS_ALLOWED_ORIGINS

*

Events

synapse.event.streaming.buffer-size

The number of events the Synapse is pre-fetching

SYNAPSE_EVENT_STREAMING_BUFFER_SIZE

100

synapse.event-handler.subscription.retry-interval

Interval at which Synapse tries to reconnect to Axon Server for subscribing to streams to receive updates for event handlers.

SYNAPSE_EVENT_HANDLER_SUBSCRIPTION_RETRY_INTERVAL

2s

Storage

synapse.storage.type

Used storage backend. Valid values are axonserver and local. Refer to Storage.

SYNAPSE_STORAGE_TYPE

local

synapse.storage.context

Context to use when using axonserver as the storage backend

SYNAPSE_STORAGE_CONTEXT

synapse

synapse.storage.component-name

Component-name to use when using axonserver as the storage backend. Has to be the same on all Synapse instances.

SYNAPSE_STORAGE_COMPONENT_NAME

synapse-storage

synapse.storage.min-token-offset

Minimum amount of events an event-token (an event processor) needs to have progressed before it stores progress back to configuration.

SYNAPSE_STORAGE_MIN_TOKEN_OFFSET

100

synapse.storage.token

Authentication token used for the storage component to connect to Axon Server. This may be different from the system token used.

SYNAPSE_STORAGE_TOKEN

synapse.storage.initial-subscription.retry-interval

Interval at which Synapse retries to contact Axon Server for the first time to retrieve storage-related information.

SYNAPSE_STORAGE_INITIAL_SUBSCRIPTION_RETRY_INTERVAL

2s

synapse.storage.subscription.retry-interval

Interval at which Synapse retries to contact Axon Server to retrieve storage-related information.

SYNAPSE_STORAGE_SUBSCRIPTION_RETRY_INTERVAL

2s

High availability

Ensure these properties are the same on all Synapse instances except you have good reasons to do otherwise.

synapse.event-handler.balancing.enabled

Whether or not to enable balancing of event handlers between synapse instances. Refer to High Availability.

SYNAPSE_EVENT_HANDLER_BALANCING_ENABLED

false

synapse.event-handler.balancing.synapse-discovery.timeout

Timeout for contacting AS to discover synapse topology

SYNAPSE_EVENT_HANDLER_BALANCING_SYNAPSE_DISCOVERY_TIMEOUT

3s

synapse.event-handler.balancing.synapse-discovery.retry-interval

Interval for retrying to contact AS to discover synapse topology

SYNAPSE_EVENT_HANDLER_BALANCING_SYNAPSE_DISCOVERY_RETRY_INTERVAL

3s

synapse.event-handler.balancing.synapse-discovery.poll-interval

Interval for polling new synapse discovery from AS. If zero, Synapse relies on topology updates via WebSocket instead of polling

SYNAPSE_EVENT_HANDLER_BALANCING_SYNAPSE_DISCOVERY_POLL_INTERVAL

0s

synapse.event-handler.balancing.web-socket.platform-endpoint

Specifies the endpoint to use for the WS connection to detect topology updates

SYNAPSE_EVENT_HANDLER_BALANCING_WEB_SOCKET_PLATFORM_ENDPOINT

axonserver-platform-websocket

synapse.event-handler.balancing.web-socket.reconnect-interval

Interval of attempting reconnects of the WS connection

SYNAPSE_EVENT_HANDLER_BALANCING_WEB_SOCKET_RECONNECT_INTERVAL

3s

synapse.event-handler.balancing.handler-run-inertia

Inertia Synapse to changes in configuration. Synapse waits for at least the configured amount of time before applying a bunch of new changes. This allows Synapse to process multiple changes in one go

SYNAPSE_EVENT_HANDLER_BALANCING_HANDLER_RUN_INTERTIA

5s

synapse.event-handler.balancing.consistent-hashing-function

Name of the hashing function to use to decide which Synapse instance takes which handler. Valid values are MURMUR3_32, MURMUR3_128, SHA256, SHA512

SYNAPSE_EVENT_HANDLER_BALANCING_CONSISTENT_HASHING_FUNCTION

MURMUR3_32