Observable Property Files

To surface insights for an Aeron component, Aeron Insights must be configured with the paths to that component’s relevant files. Each monitored component uses a properties file that specifies its type (e.g., driver, archive, or cluster) and any additional details required for monitoring. The fields in the properties file depend on the component type. For example, to configure Insights to monitor an Archive, you would use a properties file like the following:

type=archive
version=0
directory=/aeron/data/archive
id=1

See Configuring Different Components below, for the fields for each type of component.

Property files are specified as a comma-delimited list using the aeron.observable.sources system property. Entries in this list may be paths to specific properties file, or to directories that contain properties files. If the observable source is a directory, Insights will attempt to load any file in that directory with a .properties extension. It will not recursively search for properties files. For example:

-Daeron.observable.sources=/aeron/config/
-Daeron.observable.sources=/aeron/config/driver.properties,/aeron/config/archive.properties,/aeron/config/cluster.properties

Configuring Different Components

Aeron Insights supports both the OSS components and premium components. More details about how to configure the OSS components can be found here, while each premium component has details in its respective documentation.

OSS Components Properties

Aeron Transport (Media Driver)

Key

Value

type

driver

directory

The Aeron directory

Aeron Archive

Key

Value

type

archive

id

The id of the archive instance.

directory

The archive’s markfile directory.

Aeron Cluster

Key

Value

type

cluster

id

The id of the cluster instance.

archiveId

The id of the cluster’s archive.

directory

The cluster’s markfile directory.

Operating System

Key

Value

type

driver