Metrics Reference

The following table provides information for Metrics for Service Communication Proxy.

Table 4-3 Metrics Reference

S.No Promotheus Stat Metric Name Metric Description Dimensions Example usage to filter metric by dimension on Grafana GUI Metric Group
1 ocscp_metric_total_http_rx_req The total number of incoming HTTP requests
ocscp_nf_type ( e.g., UDM, PCF, AMF, etc.) ocscp_nf_service_type( e.g., nudm-uecm, nudm-sdm, etc.) ocscp_req_msg_size( The request message size buckets. e.g., 1 ( size < 1k bytes), 2 ( 1k < size < 2k bytes), 4 ( 2k < size < 4k ), etc.) ocscp_locality( SCP site name e.g., Loc6, Loc7, etc.) 
ocscp_metric_total_http_rx_req{ocscp_nf_type="UDM"} ocscp_metric_total_http_rx_req{ocscp_nf_service_type="nudm-uecm"} ocscp_metric_total_http_rx_req{ocscp_req_msg_size="2"} ocscp_metric_total_http_rx_req{ocscp_locality="Loc7"} 
SCP Usage
2. ocscp_metric_total_http_tx_req Total number of HTTP requests forwarded by Service Communication Proxy to upstream cluster
ocscp_nf_type( e.g., UDM, PCF, AMF, etc.) ocscp_nf_service_type ( e.g., nudm-uecm, nudm-sdm, etc.) ocscp_nf_end_point( Default value = 0.0:00 ) ocscp_locality( SCP site name e.g., Loc6, Loc7, etc.) ocscp_nf_instance_id( e.g., 6faf1bbc-6e4a-4454-a507-a14ef8e1bc5c, etc. Default value = NA) ocscp_service_instance_id( e.g., fe137ab7-740a-46ee-aa5c-951806d77b02, etc. Default value = NA) 
ocscp_metric_total_http_tx_req{ocscp_nf_type="UDM"} ocscp_metric_total_http_tx_req{ocscp_nf_service_type="nudm-uecm"} ocscp_metric_total_http_tx_req{ocscp_nf_end_point="10.96.166.65:80"} ocscp_metric_total_http_tx_req{ocscp_locality="Loc7"} ocscp_metric_total_http_tx_req{ocscp_nf_instance_id="6faf1bbc-6e4a-4454-a507-a14ef8e1bc5c"} ocscp_metric_total_http_tx_req{ocscp_service_instance_id="fe137ab7-740a-46ee-aa5c-951806d77b02"}
SCP Usage
3 ocscp_metric_total_http_rx_res Total number of HTTP response received by SCP with specific HTTP response codes (e.g., 201, 503, etc.)
ocscp_response_code( e.g., 201, 503, 404, etc.) ocscp_nf_type( e.g., UDM, PCF, AMF, etc.) ocscp_nf_service_type (e.g., nudm-uecm, nudm-sdm, etc.) ocscp_nf_end_point( Default value = 0.0:00 ) ocscp_locality( SCP site name e.g., Loc6, Loc7, etc.) ocscp_nf_instance_id( e.g., 6faf1bbc-6e4a-4454-a507-a14ef8e1bc5c, etc. Default value = NA) ocscp_service_instance_id( e.g., fe137ab7-740a-46ee-aa5c-951806d77b02, etc. Default value = NA) ocscp_res_msg_size( The response message size buckets. e.g., 1 ( size < 1k bytes), 2 ( 1k < size < 2k bytes), 4 ( 2k < size < 4k ), etc.) 
ocscp_metric_total_http_rx_res{ocscp_response_code="201"} ocscp_metric_total_http_rx_res{ocscp_nf_type="UDM"} ocscp_metric_total_http_rx_res{ocscp_nf_service_type="nudm-uecm"} ocscp_metric_total_http_rx_res{ocscp_nf_end_point="10.96.166.65:80"} ocscp_metric_total_http_rx_res{ocscp_locality="Loc7"} ocscp_metric_total_http_rx_res{ocscp_nf_instance_id="6faf1bbc-6e4a-4454-a507-a14ef8e1bc5c"} ocscp_metric_total_http_rx_res{ocscp_service_instance_id="fe137ab7-740a-46ee-aa5c-951806d77b02"} ocscp_metric_total_http_rx_res{ocscp_res_msg_size="2"} 
SCP Usage
4 ocscp_metric_total_http_rx_res_xx Total number of HTTP response received by SCP with aggregated HTTP response codes (e.g., 2xx, 5xx, etc.)
ocscp_response_code_class(e.g., 2xx, 5xx, etc.) ocscp_nf_type( e.g., UDM, PCF, AMF, etc.) ocscp_nf_service_type(e.g., nudm-uecm, nudm-sdm, etc.) ocscp_nf_end_point( Default value = 0.0:00 ) ocscp_locality( SCP site name e.g., Loc6, Loc7, etc.) ocscp_nf_instance_id( e.g., 6faf1bbc-6e4a-4454-a507-a14ef8e1bc5c, etc. Default value = NA) ocscp_service_instance_id( e.g., fe137ab7-740a-46ee-aa5c-951806d77b02, etc. Default value = NA) 
ocscp_metric_total_http_rx_res_xx{ocscp_response_code_class="2"} ocscp_metric_total_http_rx_res_xx{ocscp_nf_type="UDM"} ocscp_metric_total_http_rx_res_xx{ocscp_nf_service_type="nudm-uecm"} ocscp_metric_total_http_rx_res_xx{ocscp_nf_end_point="10.96.166.65:80"} ocscp_metric_total_http_rx_res_xx{ocscp_locality="Loc7"} ocscp_metric_total_http_rx_res_xx{ocscp_nf_instance_id="6faf1bbc-6e4a-4454-a507-a14ef8e1bc5c"} ocscp_metric_total_http_rx_res_xx{ocscp_service_instance_id="fe137ab7-740a-46ee-aa5c-951806d77b02"} 
SCP Usage
5 ocscp_metric_total_http_tx_res Total number of HTTP response forwarded by SCP with specific HTTP response codes (e.g., 201, 503, etc.)
ocscp_response_code( e.g., 201, 503, 404, etc.) ocscp_nf_type( e.g., UDM, PCF, AMF, etc.) ocscp_nf_service_type (e.g., nudm-uecm, nudm-sdm, etc.) ocscp_locality( SCP site name e.g., Loc6, Loc7, etc.)
ocscp_metric_total_http_tx_res{ocspf_response_code="201"} ocscp_metric_total_http_tx_res{ocspf_nf_type="UDM"} ocscp_metric_total_http_tx_res{ocspf_nf_service_type="nudm-uecm"} ocscp_metric_total_http_tx_res{ocscp_locality="Loc7"} 
SCP Usage
6 ocscp_metric_total_http_tx_res_xx Total number of HTTP response forwarded by SCP with aggregated HTTP response codes (e.g., 2xx, 5xx, etc.)
ocscp_response_code_class(e.g., 2xx, 5xx, etc.) ocscp_nf_type( e.g., UDM, PCF, AMF, etc.) ocscp_nf_service_type(e.g., nudm-uecm, nudm-sdm, etc.) ocscp_locality( SCP site name e.g., Loc6, Loc7, etc.
)
ocscp_metric_total_http_tx_res_xx{ocscp_response_code_class="2"} ocscp_metric_total_http_tx_res_xx{ocscp_nf_type="UDM"} ocscp_metric_total_http_tx_res_xx{ocscp_nf_service_type="nudm-uecm"} ocscp_metric_total_http_tx_res_xx{ocscp_locality="Loc7"} 
SCP Usage
7 ocscp_metric_total_http_rx_messages Total incoming (rx ) messages to SCP. This includes requests and responses.
ocscp_nf_type ( e.g., UDM, PCF, AMF, etc.) ocscp_nf_service_type( e.g., nudm-uecm, nudm-sdm, etc.) ocscp_locality( SCP site name e.g., Loc6, Loc7, etc.) 
ocscp_metric_total_http_rx_messages{ocscp_nf_type="UDM"} ocscp_metric_total_http_rx_messages{ocscp_nf_service_type="nudm-uecm"} ocscp_metric_total_http_rx_messages{ocscp_locality="Loc7"} 
SCP Usage
8 ocscp_metric_total_http_tx_messages Total outgoing (tx) messages from SCP. This includes requests and responses.
ocscp_nf_type( e.g., UDM, PCF, AMF, etc.) ocscp_nf_service_type (e.g., nudm-uecm, nudm-sdm, etc.) ocscp_nf_end_point( Default value = 0.0:00 ) ocscp_locality( SCP site name e.g., Loc6, Loc7, etc.) ocscp_nf_instance_id( e.g., 6faf1bbc-6e4a-4454-a507-a14ef8e1bc5c, etc. Default value = NA) ocscp_service_instance_id( e.g., fe137ab7-740a-46ee-aa5c-951806d77b02, etc. Default value = NA) 
ocscp_metric_total_http_tx_messages{ocscp_nf_type="UDM"} ocscp_metric_total_http_tx_messages{ocscp_nf_service_type="nudm-uecm"} ocscp_metric_total_http_tx_messages{ocscp_nf_end_point="10.96.166.65:80"} ocscp_metric_total_http_tx_messages{ocscp_locality="Loc7"} ocscp_metric_total_http_tx_messages{ocscp_nf_instance_id="6faf1bbc-6e4a-4454-a507-a14ef8e1bc5c"} ocscp_metric_total_http_tx_messages{ocscp_service_instance_id="fe137ab7-740a-46ee-aa5c-951806d77b02"} 
SCP Usage
9 ocscp_metric_total_attempts_to_forward_route Total number of requests that matched the catch-all-route routing rule.
ocscp_nf_type( e.g., UDM, PCF, AMF, etc.) ocscp_nf_service_type (e.g., nudm-uecm, nudm-sdm, etc.) ocscp_nf_end_point( Default value = 0.0:00 ) ocscp_locality( SCP site name e.g., Loc6, Loc7, etc.) ocscp_nf_instance_id( e.g., 6faf1bbc-6e4a-4454-a507-a14ef8e1bc5c, etc. Default value = NA) ocscp_service_instance_id( e.g., fe137ab7-740a-46ee-aa5c-951806d77b02, etc. 
Default value = NA
ocscp_metric_total_attempts_to_forward_route{ocscp_nf_type="UDM"} ocscp_metric_total_attempts_to_forward_route{ocscp_nf_service_type="nudm-uecm"} ocscp_metric_total_attempts_to_forward_route{ocscp_nf_end_point="10.96.166.65:80"} ocscp_metric_total_attempts_to_forward_route{ocscp_locality="Loc7"} ocscp_metric_total_attempts_to_forward_route{ocscp_nf_instance_id="6faf1bbc-6e4a-4454-a507-a14ef8e1bc5c"} ocscp_metric_total_attempts_to_forward_route{ocscp_service_instance_id="fe137ab7-740a-46ee-aa5c-951806d77b02"} 
SCP Usage
10 ocscp_metric_total_upstream_send_fail Total number of request that SCP failed to send to the upstream cluster
ocscp_nf_type( e.g., UDM, PCF, AMF, etc.) ocscp_nf_service_type (e.g., nudm-uecm, nudm-sdm, etc.) ocscp_nf_end_point( Default value = 0.0:00 ) ocscp_locality( SCP site name e.g., Loc6, Loc7, etc.) ocscp_nf_instance_id( e.g., 6faf1bbc-6e4a-4454-a507-a14ef8e1bc5c, etc. Default value = NA) ocscp_service_instance_id( e.g., fe137ab7-740a-46ee-aa5c-951806d77b02, etc. Default value = NA) 
ocscp_metric_total_upstream_send_fail{ocscp_nf_type="UDM"} ocscp_metric_total_upstream_send_fail{ocscp_nf_service_type="nudm-uecm"} ocscp_metric_total_upstream_send_fail{ocscp_nf_end_point="10.96.166.65:80"} ocscp_metric_total_upstream_send_fail{ocscp_locality="Loc7"} ocscp_metric_total_upstream_send_fail{ocscp_nf_instance_id="6faf1bbc-6e4a-4454-a507-a14ef8e1bc5c"} ocscp_metric_total_upstream_send_fail{ocscp_service_instance_id="fe137ab7-740a-46ee-aa5c-951806d77b02"}
SCP Usage
11 ocscp_metric_total_routing_send_fail Total number of request that SCP failed to route due to any reason
ocscp_nf_type( e.g., UDM, PCF, AMF, etc.) ocscp_nf_service_type (e.g., nudm-uecm, nudm-sdm, etc.) ocscp_nf_end_point( Default value = 0.0:00 ) ocscp_locality( SCP site name e.g., Loc6, Loc7, etc.) ocscp_nf_instance_id( e.g., 6faf1bbc-6e4a-4454-a507-a14ef8e1bc5c, etc. Default value = NA) ocscp_service_instance_id( e.g., fe137ab7-740a-46ee-aa5c-951806d77b02, etc. Default value = NA)
ocscp_metric_total_routing_send_fail{ocscp_nf_type="UDM"} ocscp_metric_total_routing_send_fail{ocscp_nf_service_type="nudm-uecm"} ocscp_metric_total_routing_send_fail{ocscp_nf_end_point="10.96.166.65:80"} ocscp_metric_total_routing_send_fail{ocscp_locality="Loc7"} ocscp_metric_total_routing_send_fail{ocscp_nf_instance_id="6faf1bbc-6e4a-4454-a507-a14ef8e1bc5c"} ocscp_metric_total_routing_send_fail{ocscp_service_instance_id="fe137ab7-740a-46ee-aa5c-951806d77b02"}
SCP Usage
12 ocscp_metric_request_processing_time This metric captures the processing time by SCP for ingress requests into the time buckets(e.g., 1ms, 2ms, 4ms, 8ms and so on)
ocscp_nf_type( e.g., UDM, PCF, AMF, etc.) ocscp_nf_service_type (e.g., nudm-uecm, nudm-sdm, etc.) ocscp_nf_end_point( Default value = 0.0:00 ) ocscp_locality( SCP site name e.g., Loc6, Loc7, etc.) ocscp_nf_instance_id( e.g., 6faf1bbc-6e4a-4454-a507-a14ef8e1bc5c, etc. Default value = NA) ocscp_service_instance_id( e.g., fe137ab7-740a-46ee-aa5c-951806d77b02, etc. Default value = NA) ocscp_processing_time(e.g., 1ms, 2ms, 4ms, 8ms, etc.)
ocscp_metric_request_processing_time{ocscp_nf_type="UDM"} ocscp_metric_request_processing_time{ocscp_nf_service_type="nudm-uecm"} ocscp_metric_request_processing_time{ocscp_nf_end_point="10.96.166.65:80"} ocscp_metric_request_processing_time{ocscp_locality="Loc7"} ocscp_metric_request_processing_time{ocscp_nf_instance_id="6faf1bbc-6e4a-4454-a507-a14ef8e1bc5c"} ocscp_metric_request_processing_time{ocscp_service_instance_id="fe137ab7-740a-46ee-aa5c-951806d77b02"} ocscp_metric_request_processing_time{ocscp_processing_time="1ms"} 
SCP Usage
13 ocscp_metric_response_processing_time This metric captures the processing time by SCP for ingress responses into the time buckets(e.g., 1ms, 2ms, 4ms, 8ms and so on)
ocscp_nf_type( e.g., UDM, PCF, AMF, etc.) ocscp_nf_service_type (e.g., nudm-uecm, nudm-sdm, etc.) ocscp_nf_end_point( Default value = 0.0:00 ) ocscp_locality( SCP site name e.g., Loc6, Loc7, etc.) ocscp_nf_instance_id( e.g., 6faf1bbc-6e4a-4454-a507-a14ef8e1bc5c, etc. Default value = NA) ocscp_service_instance_id( e.g., fe137ab7-740a-46ee-aa5c-951806d77b02, etc. Default value = NA) ocscp_processing_time(e.g., 1ms, 2ms, 4ms, 8ms, etc.) 
ocscp_metric_response_processing_time{ocscp_nf_type="UDM"} ocscp_metric_response_processing_time{ocscp_nf_service_type="nudm-uecm"} ocscp_metric_response_processing_time{ocscp_nf_end_point="10.96.166.65:80"} ocscp_metric_response_processing_time{ocscp_locality="Loc7"} ocscp_metric_response_processing_time{ocscp_nf_instance_id="6faf1bbc-6e4a-4454-a507-a14ef8e1bc5c"} ocscp_metric_response_processing_time{ocscp_service_instance_id="fe137ab7-740a-46ee-aa5c-951806d77b02"} ocscp_metric_response_processing_time{ocscp_processing_time="1ms"} 
14 ocscp_metric_request_per_try_timeout This metric captures the number of incoming request whose per try timeout expired
ocscp_nf_type( e.g., UDM, PCF, AMF, etc.)
				ocscp_nf_service_type (e.g., nudm-uecm, nudm-sdm, etc.) ocscp_nf_end_point(
				Default value = 0.0:00 ) ocscp_locality( SCP site name e.g., Loc6, Loc7, etc.)
				ocscp_nf_instance_id( e.g., 6faf1bbc-6e4a-4454-a507-a14ef8e1bc5c, etc. Default
				value = NA) ocscp_service_instance_id( e.g.,
				fe137ab7-740a-46ee-aa5c-951806d77b02, etc. Default value = NA) 
			 
ocscp_metric_request_per_try_timeout{ocscp_nf_type="UDM"}
				ocscp_metric_request_per_try_timeout{ocscp_nf_service_type="nudm-uecm"}
				ocscp_metric_request_per_try_timeout{ocscp_nf_end_point="10.96.166.65:80"}
				ocscp_metric_request_per_try_timeout{ocscp_locality="Loc7"}
				ocscp_metric_request_per_try_timeout{ocscp_nf_instance_id="6faf1bbc-6e4a-4454-a507-a14ef8e1bc5c"}
				ocscp_metric_request_per_try_timeout{ocscp_service_instance_id="fe137ab7-740a-46ee-aa5c-951806d77b02"}
15 ocscp_metric_total_transaction_timeout This metric captures the total number of request whose transaction timed out
ocscp_nf_type( e.g., UDM, PCF, AMF, etc.)
				  ocscp_nf_service_type (e.g., nudm-uecm, nudm-sdm, etc.) ocscp_nf_end_point(
				  Default value = 0.0:00 ) ocscp_locality( SCP site name e.g., Loc6, Loc7, etc.)
				  ocscp_nf_instance_id( e.g., 6faf1bbc-6e4a-4454-a507-a14ef8e1bc5c, etc. Default
				  value = NA) ocscp_service_instance_id( e.g.,
				  fe137ab7-740a-46ee-aa5c-951806d77b02, etc. Default value = NA) 
				
ocscp_metric_total_transaction_timeout{ocscp_nf_type="UDM"}
				  ocscp_metric_total_transaction_timeout{ocscp_nf_service_type="nudm-uecm"}
				  ocscp_metric_total_transaction_timeout{ocscp_nf_end_point="10.96.166.65:80"}
				  ocscp_metric_total_transaction_timeout{ocscp_locality="Loc7"}
				  ocscp_metric_total_transaction_timeout{ocscp_nf_instance_id="6faf1bbc-6e4a-4454-a507-a14ef8e1bc5c"}
				  ocscp_metric_total_transaction_timeout{ocscp_service_instance_id="fe137ab7-740a-46ee-aa5c-951806d77b02"}
16 ocscp_metric_max_routing_attempts_exhausted This metric captures the total number of requests whose maximum routing attempts expired during alternate routing
ocscp_nf_type( e.g., UDM, PCF, AMF, etc.)
				  ocscp_nf_service_type (e.g., nudm-uecm, nudm-sdm, etc.) ocscp_nf_end_point(
				  Default value = 0.0:00 ) ocscp_locality( SCP site name e.g., Loc6, Loc7, etc.)
				  ocscp_nf_instance_id( e.g., 6faf1bbc-6e4a-4454-a507-a14ef8e1bc5c, etc. Default
				  value = NA) ocscp_service_instance_id( e.g.,
				  fe137ab7-740a-46ee-aa5c-951806d77b02, etc. Default value = NA) 
				
ocscp_metric_max_routing_attempts_exhausted{ocscp_nf_type="UDM"}
				  ocscp_metric_max_routing_attempts_exhausted{ocscp_nf_service_type="nudm-uecm"}
				  ocscp_metric_max_routing_attempts_exhausted{ocscp_nf_end_point="10.96.166.65:80"}
				  ocscp_metric_max_routing_attempts_exhausted{ocscp_locality="Loc7"}
				  ocscp_metric_max_routing_attempts_exhausted{ocscp_nf_instance_id="6faf1bbc-6e4a-4454-a507-a14ef8e1bc5c"}
				  ocscp_metric_max_routing_attempts_exhausted{ocscp_service_instance_id="fe137ab7-740a-46ee-aa5c-951806d77b02"}