OpenTelemetry metrics

Find out more about the OpenTelemetry metrics emitted by the Event Manager, the Event Gateway, and IBM API Connect Developer Portal.

Event Manager

Metric Type Description
api_okay LongCounter Number of successful API calls handled by the Event Manager.
api_bad_request LongCounter Number of failed API calls because the request is badly formed.
api_unauthz LongCounter Number of failed API calls because the user is not known.
api_forbidden LongCounter Number of failed API calls because the user is not authorized.
api_not_found LongCounter Number of failed API calls because a referenced resource cannot not be found.
api_conflict LongCounter Number of failed API calls because the requested change conflicts with the current state.
api_unsupported_media LongCounter Number of failed API calls because the content format of the request is not acceptable for the server.
api_internal_server_error LongCounter Number of failed API calls because the server had an internal error occur.
api_service_unavailable LongCounter Number of failed API calls because the service that is required for the request is unavailable.
api_nine_one_one LongCounter Number of failed API calls for API Connect integration errors.
api_responses LongCounter Number of API calls handled by the Event Manager.
api_response_latency LongHistogram Distribution of API responses by response time (ms) into buckets from 0 to 10000 in steps of 500.
options LongUpDownCounter Number of virtual topics and their associated subscriptions at a specific point in time.
successful_gateway_registration LongCounter Number of successful gateway registrations.
failed_gateway_registration LongCounter Number of failed gateway registrations.
services_not_ready LongGauge Number of Event Endpoint Management services that are not yet ready.
services_ready LongGauge Number of Event Endpoint Management services that are ready.
resource_count LongGauge Number of resources created. The resources that are included in this count are: Virtual topics and Event Gateways.
resource_limit LongGauge Number of resources within that can be created. Not present if no resource limit is set.
(deprecated) successfulGatewayRegistration LongCounter Number of successful gateway registrations. Use successful_gateway_registration instead.
(deprecated) failedGatewayRegistration LongCounter Number of failed gateway registrations. Use failed_gateway_registration instead.
(deprecated) storageNotReady LongCounter Number of times the storage ready check failed.
(deprecated) keyManagerNotReady LongCounter Number of times the key manager ready check failed.

Note: Metrics that are marked as deprecated will be removed in a future release.

Event Gateway

Metric Type Description
login_success LongCounter Number of successful client logins to the Event Gateway.
login_failed LongCounter Number of failed client logins to the Event Gateway.
topic_authz_failed LongCounter Number of topic authorization failures that are caused by clients that use the Event Gateway.
connected_clients LongUpDownCounter Number of clients that are connected to this gateway at a specific point in time.
client_api_versions_gauge LongGauge Gauge that contains the API versions used per client ID for each Kafka API.
consumers_msgs LongCounter Number of messages that clients consume through the Event Gateway.
consumers_bytes LongCounter Number of bytes that clients consume through the Event Gateway.
producers_bytes LongCounter Number of bytes that clients produce through the Event Gateway.
producers_msgs LongCounter Number of messages that clients produce through the Event Gateway.
quota_delay LongUpDownCounter Available if the quota enforcement control is enabled. It provides the delays that are applied to ensure that quota limitations are maintained per client by using metadata attributes.

IBM API Connect Developer Portal

Metric Type Description
apic_dp_api_error_count LongCounter Number of failed API requests (with HTTP status code greater or equal to 400) to the Developer Portal.
apic_dp_desync_count LongGauge Number of ‘assets’ which are currently out of sync between Developer Portal and the Event Endpoint Management instance from which those assets were deployed to. An ‘asset’ can be a Developer Portal provider or an AsyncAPI.