API Aggregator metrics and alerts

Find the metrics APIA exposes and the alerts defined for APIA.

Related documentation:

• How Outbound works

Service	CRD or annotations?	Port	Endpoint/Selector	Metrics update interval
API Aggregator	ServiceMonitor	9102	/metrics	15 seconds

See details about:

• API Aggregator metrics
• API Aggregator alerts

Metrics

Add some introductory text... TBD.

Metric and description	Metric details	Indicator of
cxc_api_aggregator_schedules_created_total Total schedules created.	Unit: Type: Counter Label: "'ccid', 'tenant_name'" Sample value: 42
cxc_api_aggregator_schedules_removed_total Total schedules removed.	Unit: Type: Counter Label: "'ccid', 'tenant_name'" Sample value: 42
cxc_api_aggregator_campaign_template_created_total Total campaign templates created.	Unit: Type: Counter Label: "'ccid', 'tenant_name'" Sample value: 42
cxc_api_aggregator_campaign_template_removed_total Total campaign templates removed.	Unit: Type: Counter Label: Sample value: 42
cxc_api_aggregator_users_logged_in_total Total logged in users.	Unit: Type: Gauge Label: "'ccid', 'tenant_name'" Sample value: 4.2
cxc_api_aggregator_users_logged_out_total Total logged out users.	Unit: Type: Gauge Label: "'ccid', 'tenant_name', 'service_name'" Sample value: 4.2
cxc_api_aggregator_api_requests_total Total count of requests.	Unit: Type: Counter Label: "'ccid', 'tenant_name'" Sample value: 42
cxc_api_healthy_instance Healthy instance.	Unit: Type: Gauge Label: "'ccid', 'tenant_name'" Sample value: 4.2
cxc_api_aggregator_api_requests_processed_success Total count of success requests.	Unit: Type: Counter Label: "'ccid', 'tenant_name'" Sample value: 42
cxc_api_aggregator_top_api_requests Top api requests.	Unit: Type: Counter Label: "'path', 'method', 'id', 'name', 'ccid', 'tenant_name', 'code'" Sample value: 42
cxc_api_aggregator_redis_connection_failed Failed Redis connection.	Unit: Type: Gauge Label: "'ccid', 'tenant_name'" Sample value: 4.2
cxc_api_aggregator_request_count Total requests by verb and code.	Unit: Type: Counter Label: "'method', 'path', 'code'" Sample value: 42
cxc_api_aggregator_request_latencies_ms Request latencies histogram by verb, in milliseconds.	Unit: Type: Histogram Label: "'method', 'path', 'code'" Sample value: [1, 2, 3]
cxc_api_aggregator_request_out_count Total out requests by verb, destination and code.	Unit: Type: Counter Label: "'method', 'destination', 'code'" Sample value: 42
cxc_api_aggregator_request_out_latencies_ms Out Request latencies histogram by verb, destination and code, in milliseconds.	Unit: Type: Histogram Label: "'method', 'destination', 'code'" Sample value: [1, 2, 3]
cxc_api_aggregator_elasticsearch_service_latencies_ms Elasticsearch Request latencies histogram by verb, destination and code, in milliseconds.	Unit: Type: Histogram Label: "'method', 'destination', 'code'" Sample value: [1, 2, 3]

Alerts

No alerts are defined for API Aggregator.