OpenTelemetry Metrics

This topic shows the metrics supported in ActiveMatrix BusinessWorks.

Auto Configuration mode

It is the default mode in the ActiveMatrix BusinessWorks 5.x engine.

Add the following properties in the configuration file:

  • java.property.bw.engine.opentelemetry.metrics.enable=true

  • java.property.otel.exporter.otlp.metrics.protocol

    There are two types of protocol supported for the OpenTelemetry metrics - GRPC and HTTP. By default, GRPC is enabled. You can use any of the two protocols in the following ways:

    • java.property.otel.exporter.otlp.metrics.protocol=grpc

    • java.property.otel.exporter.otlp.metrics.protocol=http/protobuf

  • java.property.otel.exporter.otlp.metrics.endpoint

The endpoint is set according to the protocol. Default values are:

For GRPC: java.property.otel.exporter.otlp.metrics.endpoint=http://localhost:4317

For HTTP: java.property.otel.exporter.otlp.metrics.endpoint=http://localhost:4318/v1/metrics

To configure the Open Telemetry metric export interval, use the following property :

java.property.otel.metric.export.interval=<time_interval_in_milliseconds>=<time_interval_in_milliseconds>

Manual Configuration mode

If you want to disable the default auto-configured mode, add the following property in the configuration file:

java.property.bw.engine.opentelemetry.metrics.disableAutoConfiguration=true

There is no change for enabling the metrics in manual mode. Same property is used.

java.property.bw.engine.opentelemetry.metrics.enable=true

After disabling the auto configured mode to the manual mode, change the following other required properties:

For setting the protocol, use the following property with one of the values:

  • java.property.bw.engine.opentelemetry.metrics.exporter.protocol=grpc

  • java.property.bw.engine.opentelemetry.metrics.exporter.protocol=http/protobuf

By default, GRPC is enabled.

For setting the endpoint, use the following property:

java.property.bw.engine.opentelemetry.metrics.exporter.endpoint

Default values are the same as that of auto configuration.

Default values are:

For GRPC: java.property.bw.engine.opentelemetry.metrics.exporter.endpoint=http://localhost:4317

For HTTP: java.property.bw.engine.opentelemetry.metrics.exporter.endpoint=http://localhost:4318/v1/metrics

Configuration file option where changes can be applied

For already deployed applications, the required properties should be added in the TRA file located in the directory: <TIBCO_HOME>/tra/domain/<Domain_Name>/application/<Application_Name>/

Once the changes are made, restart the service instance. Redeployment is not required.

To apply the configuration to all the applications deployed and created from a specific TIBCO_HOME, add the properties to the bwengine.tra file.

This will be applied for newly deployed applications.

List of Metrics

The ActiveMatrix BusinessWorks 5.x engine currently exports the following metrics:

  • USED_CPU_PERCENT - CPU usage percentage by service instance.

  • USED_MEMORY_PERCENT - Memory usage percentage by service instance.

  • COMPLETED_JOB_COUNT - Success execution count by service instance.

  • FAULTED_JOB_COUNT - Failure execution count by service instance.

  • SERVICE_INSTANCE_STATE - Service instance details and its running state. A service instance can send other service instances' details and their state.

    Possible values seen for SERVICE INSTANCE STATE are:

    • EMPTY(0, "-"),

    • STOPPED(1, "Stopped"),

    • SHUTTING_DOWN(2, "Shutting down"),

    • UNKNOWN(3, "Unknown"),

    • ERROR(4, "Error"),

    • STANDBY(5, "Standby"),

    • STARTING_UP(6, "Starting up"),

    • RUNNING(7, "Running");

  • USED_MEMORY - Used memory by service instance in bytes.

  • FREE_MEMORY - Free memory in bytes.

The first four of these metrics are used in the ActiveMatrix BusinessWorks 5.x UI.