1. Oracle Communications Network Analytics Data Director User Guide
  2. OCNADD Metrics

7 OCNADD Metrics

This chapter includes information about metrics for Oracle Communications Network Analytics Data Director (OCNADD) and the Dimensions and Common Attributes:

Dimension Description

Table 7-1 Dimensions

Dimension Values Notes
HttpVersion HTTP/2.0 Specifies Http protocol version.
Method GET, PUT, POST, DELETE, PATCH HTTP method
Scheme HTTP, HTTPS, UNKNOWN Specifies the Http protocol scheme.
route_path NA Path predicate that matched the current request
status NA HTTP response code
error_reason NA

Reason for failure response received. If message is sent in the response, then it is filled with the message otherwise exception class is filled. In case of successful response it is filled with "no-error"

Example:

error_reason="no_error" (In case successful response is received)

error_reason="java.nio.channels.ClosedChannelException"

error_reason="unable to find valid certification path to requested target"
quantile Integer values It captures the latency values with ranges as 10ms, 20ms, 40ms, 80ms, 100ms, 200ms, 500ms, 1000ms and 5000ms
instance_identifier Prefix configured in helm, UNKNOWN Prefix of the pod configured in helm when there are multiple instances in same deployment
3rd_party_consumer_name - Name of the 3rd party consumer application as configured from the UI
destination_endpoint IP/FQDN Destination IP address or FQDN
processor_node_id - Stream processor node id in aggregation service
serviceId serviceType-N It is the identifier for the service instance used for registration with health monitoring service
serviceType CONSUMER_ADAPTER, CONFIGURATION, ALARM, AGGREGATION-NRF, AGGREGATION-SCP, OCNADD-ADMIN-SVC The ocnadd service type.
The following table includes information about common attributes for OCNADD.

Table 7-2 Attributes

Attribute Description
application The name of the application that the microservice is a part of
microservice The name of the microservice.
namespace The Kubernetes namespace in which microservice is running.
node The name of the worker node that the microservice is running on.
pod The name of the Kubernetes POD.

OCNADD Metrics

The following table lists important metrics related to OCNADD:

Table 7-3 Metrics

Metric Name Description Dimensions
kafka_stream_processor_node_process_total

The total number of records processed by a source node. The metric will be pegged by the aggregation services (SCP and NRF) in the data director and denotes the total number of records consumed from the source topic.

Metric Type: Counter
  • application
  • container
  • service
  • namespace
  • processor_node_id
  • task_id
  • thread_id
  • name
  • microservice
kafka_stream_processor_node_process_rate The average number of records processed per second by a source node.

The metric will be pegged by the aggregation services (SCP and NRF) in the data director and denotes the records consumed per sec from the source topic.

Metric Type: Gauge
  • application
  • container
  • service
  • namespace
  • processor_node_id
  • task_id
  • thread_id
  • name
  • microservice
kafka_stream_task_dropped_records_total

The total number of records dropped within the stream processing task. The metric will be pegged by the aggregation services (SCP and NRF) in the data director.

Metric Type: Counter
  • application
  • container
  • service
  • namespace
  • processor_node_id
  • task_id
  • thread_id
  • name
  • microservice
kafka_stream_task_dropped_records_rate

The average number of records dropped within the stream processing task. The metric will be pegged by the aggregation services (SCP and NRF) in the data director.

Metric Type: Gauge
  • application
  • container
  • service
  • namespace
  • processor_node_id
  • task_id
  • thread_id
  • name
  • microservice
ocnadd_egressgateway_http_requests_total

This metric will be pegged as soon as the request reaches the ocnadd egress gateway.

Metric Type: Counter
  • method
  • httpVersion
  • scheme
  • instance_identifier
  • destination_endpoint
ocnadd_egressgateway_http_responses_total

This metric will be pegged on the Egress gateway while the response is being sent back to egress adapter. This metric is pegged by ocnadd egress gateway service

Metric Type: Counter
  • method
  • status
  • httpVersion
  • scheme
  • instance_identifier
  • destination_endpoint
  • error-reason
ocnadd_egressgateway_third_party_connection_failure_total

The metric is pegged on all the failure responses received from 3rd party application (timeouts/endpoint not available and so on) while forwarding the response to the adapter. This metric is pegged by ocnadd egress gateway service

Metric Type: Counter
  • method
  • destination_endpoint
  • 3rd_party_consumer_name
  • instance_identifier
  • error-reason
  • status
ocnadd_egressgateway_e2e_request_processing_latency_seconds_bucket

The metric is pegged on the egress gateway service. It is the latency between packet timestamp provided by producer NF and egress gateway when the request packet is sent out to the 3rd party application. This latency is calculated for the batch of messages, therefore it is advisable to use the configured batch size of messages for each bucket of processing time for example, the bucket sizes are 5ms, 10ms, 20ms, 40ms, 60ms and so on and configured batch size is 100 messages, then the count of 5ms bucket should be interpreted as (count_5ms * batch size )

Metric Type: Histogram
  • method
  • instance_identifier
  • quantile(or le)
ocnadd_egressgateway_e2e_request_processing_latency_seconds_sum

This is the sum of e2e request processing time for all the requests processed in the batch of messages. It is the latency between packet timestamp provided by producer NF and egress gateway when the packet is sent out. It is the sum of processing time for all the messages in the batch.

Metric Type: Counter
  • method
  • instance_identifier
ocnadd_egressgateway_e2e_request_processing_latency_seconds_count

This is the count of batches of messages for which the processing time is summed up. It is the latency between packet timestamp provided by producer NF and egress gateway when the packet is sent out.

Metric Type: Counter
  • method
  • instance_identifier
ocnadd_egressgateway_service_request_processing_latency_seconds_bucket

The metric is pegged on the egress gateway service. It is the egress gateway service processing latency and pegged when a request is sent out from egress gateway to the 3rd party application. This latency is calculated for the batch of messages, therefore it is advisable to use the configured batch size of messages for each bucket of processing time for example, the bucket sizes are 5ms, 10ms, 20ms, 40ms, 60ms and so on and configured batch size is 100 messages, then the count of 5ms bucket should be interpreted as (count_5ms * batch size )

Metric Type: Histogram
  • method
  • instance_identifier
  • quantile(or le)
ocnadd_egressgateway_service_request_processing_latency_seconds_sum

The metric is pegged on the egress gateway service. It is the sum of egress gateway service processing latency for the batch of messages and pegged when a request is sent out from egress gateway towards the 3rd party application.

Metric Type: Counter
  • method
  • instance_identifier
ocnadd_egressgateway_service_request_processing_latency_seconds_count

The metric is pegged on the egress gateway service. It is the batch count and pegged when a request is sent out from egress gateway towards 3rd party application.

Metric Type: Counter
  • method
  • instance_identifier
ocnadd_egressgateway_request_latency_seconds_bucket

The metric is pegged on the egress gateway service. It is the egress gateway processing latency and pegged when a response is sent out from egress gateway to the egress adapter. This latency is calculated for the batch of messages, therefore it is advisable to use the configured batch size of messages for each bucket of processing time for example, the bucket sizes are 5ms, 10ms, 20ms, 40ms, 60ms and so on and configured batch size is 100 messages, then the count of 5ms bucket should be interpreted as (count_5ms * batch size )

Metric Type: Histogram
  • method
  • instance_identifier
  • quantile(or le)
ocnadd_egressgateway_request_latency_seconds_sum

The metric is pegged on the egress gateway service. It is the sum of egress gateway request processing latency for the batch of messages and pegged when a response is sent out from egress gateway towards the egress adapter.

Metric Type: Counter
  • method
  • instance_identifier
ocnadd_egressgateway_request_latency_seconds_count

The metric is pegged on the egress gateway service. It is the batch count and pegged when a response is sent out from egress gateway towards egress adapter.

Metric Type: Counter
  • method
  • instance_identifier
ocnadd_health_total_registered_instance_total

This metric will be pegged whenever a new registration/deregistration request will be received in Health Monitoring service from ocnadd services.

Metric Type: Counter
  • serviceId
  • serviceType
ocnadd_health_total_alarm_raised_total

This metric will be pegged whenever a new alarm is raised to alarm service from Health Monitoring service.

Metric Type: Counter
  • serviceId
  • serviceType
ocnadd_health_total_alarm_cleared_total

This metric will be pegged whenever a clear alarm is invoked from Health Monitoring service.

Metric Type: Counter
  • serviceId
  • serviceType
ocnadd_health_total_active_number_of_alarm_raised_total

This metric will be pegged whenever a raise/clear alarm is raised to alarm service from Health Monitoring service. This denotes the active alarms raised by health monitoring service.

Metric Type: Counter
  • serviceId
  • serviceType