Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - RuntimeObservabilitySettings

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

Run In Postman

For more information about Postman collections, forking, and making your first API call, refer to the Working with Boomi APIs on Postman page.

RuntimeObservabilitySettings

Manages observability settings for runtimes, including logs, metrics, and traces configuration.

Retrieves a RuntimeObservabilitySettings object by identifier

Initiates async operation and returns token for retrieving observability settings.

Authorizations:
basicAuth
path Parameters
id
required
string

Responses

Response Schema:
required
object (AsyncToken)
responseStatusCode
required
integer <int32>

Response samples

Content type
{
  • "@type": "AsyncOperationTokenResult",
  • "asyncToken": {
    • "@type": "AsyncToken",
    • "token": "RuntimeObservabilitySettings-2a16ed42-a32a-4114-85ab-44eb2c60303c"
    },
  • "responseStatusCode": 202
}

Retrieves a RuntimeObservabilitySettings object by token

Retrieves observability settings using the token.

Authorizations:
basicAuth
path Parameters
token
required
string

Takes in the token from a previous call to return a result.

Responses

Response Schema:
responseStatusCode
required
integer <int32>
numberOfResults
integer <int32>
Array of objects (RuntimeObservabilitySettings)

Response samples

Content type
{
  • "@type": "AsyncOperationResult",
  • "result": [
    • {
      }
    ],
  • "responseStatusCode": 200
}

Modifies or updates a RuntimeObservabilitySettings object

Updates observability settings for a runtime

Authorizations:
basicAuth
path Parameters
id
required
string
Request Body schema:
optional
runtimeId
required
string

Unique identifier of the runtime. Must be a valid runtime belonging to the account, where the runtime should be online and active. Cloud attachments are not supported.

object (GeneralSettings)
object (LogSettings)
object (MetricSettings)
shouldRestartPlugin
boolean

Restart observability plugin after update. If false, observability setting changes will not be used until the plugin is restarted. Only applicable for update operations.

object (TraceSettings)

Responses

Response Schema:
runtimeId
required
string

Unique identifier of the runtime. Must be a valid runtime belonging to the account, where the runtime should be online and active. Cloud attachments are not supported.

object (GeneralSettings)
object (LogSettings)
object (MetricSettings)
shouldRestartPlugin
boolean

Restart observability plugin after update. If false, observability setting changes will not be used until the plugin is restarted. Only applicable for update operations.

object (TraceSettings)

Request samples

Content type
{
  • "runtimeId": "a0c49871-212b-4ece-9b29-fafd80ca0136",
  • "generalSettings": {
    • "@type": "GeneralSettings",
    • "enabled": true,
    • "observabilityEndpoint": {
      }
    },
  • "logSettings": {
    • "@type": "LogSettings",
    • "enabled": true,
    • "overrideGeneralObservabilityEndpoint": false,
    • "observabilityEndpoint": {
      },
    • "logTimeoutSeconds": 30,
    • "logBatchSize": 512,
    • "logFlushInterval": 1000,
    • "logMaxQueueSize": 2048,
    • "logFilterEnabled": true,
    • "logFilterTypes": [
      ]
    },
  • "metricSettings": {
    • "@type": "MetricSettings",
    • "enabled": true,
    • "overrideGeneralObservabilityEndpoint": false,
    • "observabilityEndpoint": {
      },
    • "metricTimeoutSeconds": 30,
    • "metricIntervalSeconds": 30
    },
  • "traceSettings": {
    • "@type": "TraceSettings",
    • "enabled": true,
    • "overrideGeneralObservabilityEndpoint": false,
    • "observabilityEndpoint": {
      },
    • "traceBatchSize": 0,
    • "traceFlushInterval": 100,
    • "traceTimeoutSeconds": 0,
    • "traceMaxQueueSize": 0,
    • "processFilterEnabled": true,
    • "processFilterIds": [
      ]
    },
  • "shouldRestartPlugin": true
}

Response samples

Content type
{
  • "@type": "RuntimeObservabilitySettings",
  • "runtimeId": "a0c49871-212b-4ece-9b29-fafd80ca0136",
  • "generalSettings": {
    • "@type": "GeneralSettings",
    • "enabled": true,
    • "observabilityEndpoint": {
      }
    },
  • "logSettings": {
    • "@type": "LogSettings",
    • "enabled": true,
    • "overrideGeneralObservabilityEndpoint": false,
    • "observabilityEndpoint": {
      },
    • "logFilterEnabled": true,
    • "logFilterTypes": [
      ],
    • "logTimeoutSeconds": [
      ],
    • "logBatchSize": [
      ],
    • "logFlushInterval": [
      ],
    • "logMaxQueueSize": [
      ]
    },
  • "metricSettings": {
    • "@type": "MetricSettings",
    • "enabled": true,
    • "overrideGeneralObservabilityEndpoint": false,
    • "observabilityEndpoint": {
      },
    • "metricTimeoutSeconds": [
      ],
    • "metricIntervalSeconds": [
      ]
    },
  • "traceSettings": {
    • "@type": "TraceSettings",
    • "enabled": true,
    • "overrideGeneralObservabilityEndpoint": false,
    • "observabilityEndpoint": {
      },
    • "traceTimeoutSeconds": [
      ],
    • "traceBatchSize": [
      ],
    • "traceFlushInterval": [
      ],
    • "traceMaxQueueSize": [
      ],
    • "processFilterEnabled": true,
    • "processFilterIds": [
      ]
    }
}