Configuring Runtime Observability

This topic guides you through the steps to configure observability for runtimes.

note

Cloud attachments can configure observability if enabled by the cloud owner. For Boomi-hosted cloud users, this feature is rolling out gradually, starting with MCS and DCS users. Observability is not available for PCS attachments this time. Attachment-level specific steps are further below.

Prerequisites

1. Have a locally installed Boomi runtime.
2. Have Runtime Management privileges.
3. Have cloud attachment (tenant) configuring observability: Your runtime cloud owner must first enable cloud attachment observability for your attachment. If you don't see the Observability option in Runtime Management, contact your cloud owner.

note

Not necessary to have both. You can either have your own hosted runtime, or you can attach to another cloud and that cloud owner can enable attachment observability.

Observability Tooling Prerequisites

1. Install or reference a third party application monitoring tool that supports OpenTelemetry (list of supported vendors).
2. Connectivity details for the monitoring tool, including:
   1. URL and port
   2. Authentication - If required, typically will be a user name and password, or API token.
3. Optional: Instead of connecting directly to the monitoring tool, you can install and configure a local collector.

Configuration

1. From the Runtime Management page, click Observability from the menu options, then toggle the Enable Observability switch to on.
2. Configure global endpoint information to where telemetry data should be sent. Note this can be overridden per signal type below.
   1. URL - Endpoint for monitoring application or collector. Must be accessible to the runtime.
   2. Authentication Type - If applicable, the authentication type and credentials required to access the monitoring application or collector.
   3. Custom Headers (optional) - Used to send additional information to monitoring tools, such as custom authentication (e.g. PAI tokens) or other metadata
      1. Headers are key:value values. Key is required. Example:
         1. Key: X-api-key
         2. Value: 5c7284a7-36e8-475e-a2d9-dfae124c0962
      2. Maximum of 20 headers.
3. Enter configuration details to customize your observability settings.
   1. Enable and configure metrics telemetry export
      1. Enable metrics to begin exporting runtime application metrics.
      2. Optional - Override metrics endpoint if need to send the metrics to a different monitoring endpoint.
      3. Optional - Configure advanced settings to optimize transmission as needed.
   2. Enable and configure logs telemetry export.
      1. Enable logs to begin exporting runtime and process execution logs.
      2. Optional - Override logs endpoint if need to send the logs to a different monitoring endpoint.
      3. Choose to export all logs or only selected logs. Log types differ by runtime type.
      4. Optional - Configure advanced settings to optimize transmission as needed.
   3. Enable and configure traces telemetry export.
      1. Enable traces to begin exporting process execution traces.
      2. Optional - Override traces endpoint if need the traces to send to a different monitoring endpoint.
      3. Choose to export traces for all processes or only selected processes.
      4. Optional - Configure advanced settings to optimize transmission as needed.
4. Save
   1. Optional - Select Yes, restart the plugin now.
      NOTE: When enabling observability, the observability plugin must be restarted. Keep in mind observability data is not generated nor exported while the runtime or plugin is restarting.
5. SUCCCESS! Your observability settings are now configured.

Enabling Attachment-level Observability for Runtime Clouds

For runtime clouds, cloud owners control whether their attachments can enable and export their own observability settings: either enabling the option for all attachments in the cloud or restricting it to specific ones.
The steps to enable are as follows.

Cloud Owner:

1. From Runtime Management > Properties > Advanced, add and enable the Enable Attachment Observability property for the cloud cluster. Save and restart the cloud cluster.
2. From Cloud Management > Attachment Quotas, enable the Observability quota for the cloud cluster and/or individual attachments. Save the quotas.

Attachment User:

1. Once the cloud owner has enabled observability for your attachment, from Runtime Management > Observability, enable and configure your observability settings as described above.

You can also configure observability via the RuntimeObservabilitySettings API.