6 NEF Metrics

This chapter includes information about Metrics for Oracle Communications Cloud Native Core, Network Exposure Function (NEF).

6.1 NEF OCI Metrics Dashboard

To upload the ocnef_oci_metric_dashboard_24.2.2.zip file on OCI Logging Analytics Dashboard Service, see Oracle Communications Cloud Native Core, OCI Adaptor Deployment Guide. OCI does not support Grafana, OCI uses the Logging Analytics Dashboard Service for visualizing the metrics and logs.

6.2 Dimension Description

The following table provides information on Dimension of Metrics.

Table 6-1 NEF Dimension Description

Dimension Description Values
Method Type of security method string
Status Status string
Service Name The complete name of current service string
query_type Type of query string
Svc_Type Type of the service enum
ApiName The name of the API string
Cause Reason for failure string
error Error message boolean
Host Host address IP address
Port Port number port
Direction Direction of the service request string
Event The event that occurred on request completion string
Client_type HTTP client type

The possible value is h2c.

 string
DestinationHost The request destination host address IP address

Note:

If any specific KPI is required, then create this KPI on grafana dashboard as per requirement from this metrices mentioned.

6.3 NEF Metrics

This section provides all the NEF metrics and respective dimensions.

Note:

For more information about Dimensions, see NEF Metrics.

Examples

The following are some of the examples of NEF metrics:

CCF Client Metrics
ocnef_ccf_client_publish_total{Method="POST", ServiceName="ocnef-monitoringevents", app_kubernetes_io_instance="ocnef",
app_kubernetes_io_name="ocnef-ccfclient", container="ocnef-ccfclient", endpoint="cnc-metrics", instance="10.233.69.246:9090",
job="occne-infra/occne-nf-cnc-podmonitor", namespace="nef-perf", pod="ocnef-ocnef-ccfclient-6cc95c69dd-mjb74", pod_template_hash="6cc95c69dd"}

ocnef_ccf_client_registration{Success="No", app_kubernetes_io_instance="ocnef", app_kubernetes_io_name="ocnef-ccfclient", 
container="ocnef-ccfclient", endpoint="cnc-metrics", instance="10.233.69.246:9090", job="occne-infra/occne-nf-cnc-podmonitor", 
namespace="nef-perf", pod="ocnef-ocnef-ccfclient-6cc95c69dd-mjb74", pod_template_hash="6cc95c69dd"}
ME Service Metrics
  
ocnef_me_5g_req_total{method="POST"} 1.0

ocnef_me_db_query_seconds_max{app="monitoringevents",method="POST"} 1.0

ocnef_5gc_agent_req_total{method="POST",from="5G_NF"} 1.0

ocnef_5gc_agent_resp_total{method="POST",status="200",to="5G_NF} 1.0

6.3.1 API Router Metrics

The following metrics are applicable to API router metrics.

Table 6-2 ocnef_aef_apirouter_req

Field Details
Description Count of request messages received by the API Router service.
Type Counter
Dimension
  • Method
  • API Name
Example  

Table 6-3 ocnef_apirouter_resp

Field Details
Description Count of response messages sent back by the API Router service.
Type Counter
Dimension
  • Method
  • Status
  • API Name
Example  

Table 6-4 ocnef.aef.apirouter.latency

Field Details
Description The amount of time taken for processing of the request at the API Router service.
Type Histogram
Dimension
  • API Name
  • Method
  • error(boolean)
Example  

Table 6-5 ocnef.aef.apirouter.backend.connection.failure

Field Details
Description The number of connection creation failure with the backend NEF microservice.
Type Counter
Dimension
  • Host
  • Port
Example  

Table 6-6 ocnef.aef.apirouter.backend.outgoing.connections

Field Details
Description The number of active connections with backend NEF microservice.
Type Gauge
Dimension
  • Host
  • Direction
Example  

Table 6-7 ocnef.aef.apirouter.backend.request.stat

Field Details
Description The number of events occurred when a request is sent to backend NEF micoservices.
Type Counter
Dimension
  • event
  • client_type
  • DestinationHost
Example  

Table 6-8 ocnef.aef.apirouter.backend.response.stat

Field Details
Description The number of events occurred when a response is received at backend NEF micoservices.
Type Counter
Dimension
  • event
  • client_type
  • DestinationHost
Example  

Table 6-9 ocnef.aef.apirouter.backend.latency

Field Details
Description The amount of time taken in processing of the request at backend nef micoservices.
Type Histogram
Dimension
  • Host
  • Method
Example  

6.3.2 CCF Client Metrics

The following metrics are applicable to CCF client metrics.

Table 6-10 ocnef_ccf_client_publish_total

Field Details
Description Number of CCF client requests published.
Type Counter
Dimension
  • Method
  • ServiceName
Example ocnef_ccf_client_publish_total{Method="POST", ServiceName="nefsiteone-devicetrigger"}

Table 6-11 ocnef_ccf_client_registration

Field Details
Description CCF client registration status
Type Gauge
Dimension Success
Example ocnef_ccf_client_registration{Success="Yes"}

Table 6-12 ocnef.ccf.client.service.failure

Field Details
Description CCF client service failure count
Type Counter
Dimension
  • ServiceName
  • Status
Example ocnef_ccf_client_service_failure{ServiceName="nefsitetwo-msisdnlessmosms", Status="Down"}

6.3.3 ME Service Metrics

The following metrics are applicable to ME service metrics.

Table 6-13 ocnef_me_af_req_total

Field Details
Description Count of subscriptions received at the ME service.
Type Counter
Dimension Method
Example  

Table 6-14 ocnef_me_af_resp_total

Field Details
Description Count of subscription responses sent by the ME service.
Type Counter
Dimension
  • Method
  • Status
Example  

Table 6-15 ocnef_me_5g_req

Field Details
Description Count of notifications received from 5G core at the ME service.
Type Counter
Dimension Method
Example  

Table 6-16 ocnef_me_5g_resp

Field Details
Description Count of notification responses sent by the ME service.
Type Counter
Dimension
  • Method
  • Status
Example  

Table 6-17 ocnef_me_5g_ue_r_ignored_req

Field Details
Description Notifications of UNREACHABLE and REGULATORY_ONLY, which are ignored at NEF and forwarded to AF.
Type Counter
Dimension
  • Method
  • Status
Example  

Table 6-18 ocnef_me_af_latency

Field Details
Description Latency for processing subscriptions at the ME service.
Type Counter
Dimension
  • Method
  • Status
Example  

Table 6-19 ocnef_me_5g_latency

Field Details
Description Latency for processing notifications at the ME service.
Type Counter
Dimension
  • Method
  • Status
Example  

Table 6-20 ocnef_me_db_query_duration_seconds_sum

Field Details
Description Time duration in seconds to process dbQuery.
Type Counter
Dimension query_type
Example  

Table 6-21 ocnef_me_db_query_duration_seconds_count

Field Details
Description Count of number of dbQuery.
Type Counter
Dimension query_type
Example  

Table 6-22 ocnef_me_db_query_duration_seconds_max

Field Details
Description Maximum duration of time in seconds allowed to process dbQuery.
Type Counter
Dimension query_type
Example  

Table 6-23 ocnef_me_srv_req_total

Field Details
Description Count of messages transmitted by the ME services.
Type Counter
Dimension
  • Method
  • to

Note: The value of to can be 5G_NF or AF.

Example  

Table 6-24 ocnef_me_srv_resp_total

Field Details
Description Count of responses received by the ME service.
Type Counter
Dimension
  • Method
  • Status
  • from

Note: The value of from can be 5G_NF or AF.

Example  

Table 6-25 ocnef_me_srv_latency_seconds

Field Details
Description Latency for message received at the ME service.
Type Counter
Dimension
  • Method
  • Status
  • from

Note: The value of from can be 5G_NF or AF.

Example  

Table 6-26 ocnef_me_svc_gmlc_to_udm_switchover_count

Field Details
Description Ther number of requests sent to UDM on GMLC failure.
Type Counter
Dimension  
Example  

Table 6-27 ocnef_me_af_surviving_site_total

Field Details
Description The number of AF requests handled by non owner site in georedundant deployment.
Type Counter
Dimension
  • method
  • owner_site_id
  • status
  • failure_reason

Note: The value of method can be POST.

Example  

Table 6-28 ocnef_me_5g_surviving_site_total

Field Details
Description The number of notifications handled by non owner site in georedundant deployment.
Type Counter
Dimension
  • method
  • owner_site_id
  • status
  • failure_reason

Note: The value of method can be POST.

Example  

Table 6-29 ocnef_all_site_status

Field Details
Description The status of the NEF sites in georedundant deployment.
Type Gauge
Dimension site_id
Example  

Table 6-30 ocnef_db_replication_status

Field Details
Description The DB replication status of the NEF sites in georedundant deployment.
Type Gauge
Dimension status
Example  

6.3.4 QoS Service Metrics

The following metrics are applicable to QoS Service metrics.

Table 6-31 ocnef_qos_af_req

Field Details
Description Count of QoS messages received from AF in NEF
Type Counter
Dimension Method
Example  

Table 6-32 ocnef_qos_af_resp

Field Details
Description Count of response sent from NEF for the received QoS session messages
Type Counter
Dimension
  • Method
  • Status
Example  

Table 6-33 ocnef_qos_5g_req

Field Details
Description Count of notification requests received from Fivegc Agent
Type Counter
Dimension
  • Method
  • From
Example  

Table 6-34 ocnef_qos_5g_resp

Field Details
Description Count of responses sent to Fivegc Agent
Type Counter
Dimension
  • Method
  • Status
Example  

Table 6-35 ocnef_qos_af_latency

Field Details
Description Latency for processing the messages received from AF
Type Counter
Dimension
  • Method
  • Type
Example  

Table 6-36 ocnef_qos_5g_latency

Field Details
Description Latency for processing messages received from Fivegc Agent
Type Counter
Dimension
  • Method
  • Type
Example  

Table 6-37 ocnef_qos_srv_req

Field Details
Description Count of QoS requests sent from QoS service towards Fivegc Agent / AF
Type Counter
Dimension
  • Event
  • To
  • Destination
Example  

Table 6-38 ocnef_qos_srv_resp

Field Details
Description Count of response received in QoS service
Type Counter
Dimension
  • Event
  • From
  • Destination
Example  

Table 6-39 ocnef_qos_srv_latency

Field Details
Description Latency duration of a request and response
Type Counter
Dimension
  • Method
  • Destination
  • Time
Example  

Table 6-40 ocnef_qos_db_latency

Field Details
Description Latency duration for a DB Query
Type Counter
Dimension
  • Query_type
  • Time
Example  

Table 6-41 ocnef_qos_af_surviving_site_total

Field Details
Description The number notifications handled by the non owner site in georedundant deployment
Type Counter
Dimension
  • method
  • owner_site_id
  • status
  • failure_reason

Note: The value of method can be POST.

Example  

Table 6-42 ocnef_qos_5g_surviving_site_total

Field Details
Description The number of notifications handled by non owner site in georedundant deployment
Type Counter
Dimension
  • method
  • owner_site_id
  • status
  • failure_reason

Note: The value of method can be POST.

Example  

Table 6-43 ocnef_chf_qos_req_total

Field Details
Description Count of the requests to CHF for QOS invocation or notification
Type Counter
Dimensions
  • method
  • direction
Examples ocnef_chf_qos_req_total{application="ocnef",direction="INVOCATION"}

Table 6-44 ocnef_chf_qos_resp_total

Field Details
Description Count of the response to CHF for QOS invocation or notification
Type Counter
Dimensions
  • method
  • direction
  • status
Examples ocnef_chf_qos_resp_total{application="ocnef",direction="NOTIFICATION"}

Table 6-45 ocnef_chf_qos_latency

Field Details
Description Latency for processing the messages received from AF.
Type Histogram
Dimensions
  • method
  • direction
Examples ocnef_chf_qos_latency_seconds{application="ocnef",direction="INVOCATION",eng_version="",method="DELETE"}

Table 6-46 ocnef_qos_srv_req_total

Field Details
Description Count of QoS requests sent from QoS service towards Fivegc Agent or AF
Type Counter
Dimensions
  • event
  • to
  • destination
Examples ocnef_qos_srv_req{to="5G_NF_CHF"}

Table 6-47 ocnef_qos_srv_resp_total

Field Details
Description Count of response received in QoS service.
Type Counter
Dimensions
  • event
  • from
  • destination
Examples ocnef_qos_srv_resp{to="5G_NF_CHF"}

6.3.5 5GC Agent Service Metrics

The following metrics are applicable to 5GC Agent Service metrics.

Table 6-48 ocnef_5gc_agent_req_total

Field Details
Description Count of messages received at Fivegc Agent service.
Type Counter
Dimension
  • Method
  • from

Note: The value of from can be 5G_NF or NEF_SVC.

Example  

Table 6-49 ocnef_5gc_agent_resp_total

Field Details
Description Count of message responses sent by the Fivegc Agent service.
Type Counter
Dimension
  • Method
  • Status
  • to

Note: The value of to can be 5G_NF or NEF_SVC.

Example  

Table 6-50 ocnef_5gc_agent_latency_seconds

Field Details
Description Latency for processing messages at the Fivegc Agent service.
Type Counter
Dimension
  • Method
  • Status
  • from

Note: The value of from can be 5G_NF or NEF_SVC.

Example  

Table 6-51 ocnef_5gc_agent_srv_req_total

Field Details
Description Count of messages transmitted by the Fivegc Agent service.
Type Counter
Dimension
  • Method
  • to
  • Communication Model

Note: The value of to can be 5G_NF or NEF_SVC.

Example  

Table 6-52 ocnef_5gc_agent_srv_resp_total

Field Details
Description Count of responses received by the Fivegc Agent service.
Type Counter
Dimension
  • Method
  • Status
  • from
  • Communication Model

Note: The value of from can be 5G_NF or NEF_SVC.

Example  

Table 6-53 ocnef_5gc_agent_srv_latency_seconds

Field Details
Description Latency for message received at the Fivegc Agent service.
Type Counter
Dimension
  • Method
  • Status
  • from
  • Communication Model

Note: The value of from can be 5G_NF or NEF_SVC.

Example  

Table 6-54 ocnef_translation_count

Field Details
Description Count of NF message translation done by Fivegc Agent.
Type Counter
Dimension
  • translationType
  • Communication Model
Example  

Table 6-55 ocnef_translation_failure_count

Field Details
Description Count of failed NF message translation done by Fivegc Agent.
Type Counter
Dimension
  • translationType
  • Communication Model
Example  

Table 6-56 ocnef_5gc_invalid_config

Field Details
Description The number of invalid configurations on 5GCAgent service.
Type Counter
Dimension  
Example  

6.3.6 Expiry Auditor Service Metrics

The following metrics are applicable to Expiry Auditor Service metrics.

Table 6-57 ocnef_exp_audit_expired_records

Field Details
Description The number of records expired and deleted.
Type Counter
Dimension
  • serviceId

Note: The value of serviceId can be MonitoringEventSvc.

Example  

Table 6-58 ocnef_exp_audit_request_records

Field Details
Description The number of requests for addition and deletion of records.
Type Counter
Dimension
  • serviceId

Note: The value of serviceId can be MonitoringEventSvc.

Example  

Table 6-59 ocnef_exp_audit_response_records

Field Details
Description The number of records added or deleted.
Type Counter
Dimension
  • serviceId

Note: The value of serviceId can be MonitoringEventSvc.

Example  

6.3.7 Traffic Influence Metrics

The following metrics are applicable to Traffic Influence metrics.

Table 6-60 ocnef_traffic_influence_af_req

Field Details
Description Count of traffic_influence messages received from AF in NEF.
Type  
Dimension
  • Method
Example  

Table 6-61 ocnef_traffic_influence_af_resp

Field Details
Description Count of response sent from NEF for the received traffic_influence session messages.
Type  
Dimension
  • Method
  • Status
Example  

Table 6-62 ocnef_traffic_influence_5g_req

Field Details
Description Count of notification requests received from Fivegc Agent.
Type  
Dimension
  • Method
  • from
Example  

Table 6-63 ocnef_traffic_influence_5g_resp

Field Details
Description Count of responses sent to Fivegc Agent.
Type  
Dimension
  • Method
  • Status
Example  

Table 6-64 ocnef_traffic_influence_af_latency

Field Details
Description Latency for processing the messages received from AF.
Type  
Dimension
  • Method
  • Type
Example  

Table 6-65 ocnef_traffic_influence_5g_latency

Field Details
Description Latency for processing messages received from Fivegc Agent.
Type  
Dimension
  • Method
  • Type
Example  

Table 6-66 ocnef_traffic_influence_srv_req

Field Details
Description Count of traffic influence requests sent from traffic_influence service towards Fivegc Agent / AF.
Type  
Dimension
  • Event
  • To
  • Destination
Example  

Table 6-67 ocnef_traffic_influence_srv_resp

Field Details
Description Count of response received in traffic_influence service.
Type  
Dimension
  • Event
  • From
  • Destination
Example  

Table 6-68 ocnef_traffic_influence_srv_latency

Field Details
Description Latency duration of a request and response.
Type  
Dimension
  • Method
  • Time
  • Destination
Example  

Table 6-69 ocnef_traffic_influence_db_latency

Field Details
Description Latency duration for a DB Query.
Type  
Dimension
  • query_type
  • Time
Example  

6.3.8 Converged SCEF-NEF Metrics

The following metrics are applicable to Converged SCEF-NEF metrics.

Table 6-70 ocnef_diamgw_diam_req_total

Field Details
Description This metric records the total number of diameter inbound and outbound requests to and from the diameter gateway.
Type Counter
Dimension
  • app_id
  • cmd_code
  • message_direction
Example ocnef_diamgw_diam_req_total{app_id="16777313"}

Table 6-71 ocnef_diamgw_diam_resp_total

Field Details
Description This metric records the total number of diameter response received for the inbound and outbound requests sent to and from the diameter gateway.
Type Counter
Dimension
  • app_id
  • cmd_code
  • status
  • message_direction
Example ocnef_diamgw_diam_resp_total{app_id="16777313"}

Table 6-72 ocnef_diamgw_http_req_total

Field Details
Description This metric records the total number of inbound and outbound requests to and from the diameter gateway to NEF microservices.
Type Counter
Dimension
  • app_id
  • cmd_code
  • message_direction
Example ocnef_diamgw_http_req_total{app_id="16777313"}

Table 6-73 ocnef_diamgw_http_resp_total

Field Details
Description This metric records the total inbound and outbound responses to and from the NEF microservices to diameter gateway.
Type Counter
Dimension
  • app_id
  • cmd_code
  • status
  • message_direction
Example ocnef_diamgw_http_resp_total{app_id="16777313"}

Table 6-74 ocnef_diamgw_translator_request_total

Field Details
Description This metric captures total requests translated, translation status from diameter to http.
Type Counter
Dimension
  • app_id
  • cmd_code
  • translatorType
  • translationStatus
  • errorReason
Example  

6.3.9 Device Trigger Metrics

The following metrics are applicable to Device Trigger metrics.

Table 6-75 ocnef_dt_af_req_total

Field Details
Description Count of device_trigger messages received from AF in NEF.
Type Counter
Dimension method
Example  

Table 6-76 ocnef_dt_af_resp_total

Field Details
Description Count of response sent from NEF for the received device_trigger session messages.
Type Counter
Dimension
  • method
  • status
Example  

Table 6-77 ocnef_dt_af_latency_seconds

Field Details
Description Latency for processing the messages received from AF.
Type Histogram
Dimension
  • method
  • type
Example  

Table 6-78 ocnef_dt_srv_req_total

Field Details
Description Count of device trigger requests sent from device_trigger service towards Fivegc Agent / AF.
Type Counter
Dimension
  • event
  • to
  • destination
Example  

Table 6-79 ocnef_dt_srv_resp_total

Field Details
Description Count of response received in device_trigger service.
Type Counter
Dimension
  • event
  • from
  • destination
Example  

Table 6-80 ocnef_dt_srv_latency_seconds

Field Details
Description Latency duration of a request and response.
Type Histogram
Dimension
  • method
  • destination
  • time
Example  

Table 6-81 ocnef_svc_dt_db_latency_seconds

Field Details
Description Latency duration for a DB Query.
Type Histogram
Dimension
  • query_type
  • time
Example  

Table 6-82 ocnef_dt_diamgw_notify_req_total

Field Details
Description Total number of delivery report notifications requests that was received from diameter gateway.
Type Counter
Dimension
  • method
  • type
Example  

Table 6-83 ocnef_dt_diamgw_notify_resp_total

Field Details
Description Total number of delivery report notifications responses that was sent to diameter gateway.
Type Counter
Dimension
  • method
  • status
Example  

Table 6-84 ocnef_dt_diamgw_notify_latency_seconds

Field Details
Description Latency duration of a request and response.
Type Histogram
Dimension
  • method
  • destination
  • time
Example  

Table 6-85 ocnef_diamgw_diam_req_total

Field Details
Description This metric captures total diameter outbound or inbound requests from/to diameter gateway.
Type Counter
Dimension
  • app_id
  • cmd_code
  • direction
Example  

Table 6-86 ocnef_diamgw_diam_resp_total

Field Details
Description This metric captures total diameter response received for the outbound or inbound requests sent from/to diameter gateway.
Type Counter
Dimension
  • app_id
  • cmd_code
  • direction
  • status
Example  

Table 6-87 ocnef_diamgw_http_req_total

Field Details
Description This metric captures total inbound/outbound requests to/from diameter gateway to NEF microservices.
Type Counter
Dimension
  • app_id
  • cmd_code
  • api_name
  • direction
Example  

Table 6-88 ocnef_diamgw_http_resp_total

Field Details
Description This metric captures total incoming or outgoing responses to/from NEF microservices to diameter gateway.
Type Counter
Dimension
  • app_id
  • cmd_code
  • api_name
  • status
  • direction
Example  

Table 6-89 ocnef_diamgw_translator_request_total

Field Details
Description This metric captures total requests translated and the translation status from diameter to http.
Type Counter
Dimension
  • app_id
  • cmd_code
  • translatorType
  • translationStatus
  • errorReason
Example  

6.3.10 Diameter Gateway Metrics

The following metrics are applicable to Diameter Gateway metrics.

Table 6-90 ocnef_diamgw_diam_req_total

Field Details
Description This metric records the total number of diameter inbound and outbound requests to and from the diameter gateway.
Type Counter
Dimension
  • app_id
  • cmd_code
  • message_direction
Example ocnef_diamgw_diam_req_total{app_id="16777313"}

Table 6-91 ocnef_diamgw_diam_resp_total

Field Details
Description This metric records the total number of diameter response received for the inbound and outbound requests sent to and from the diameter gateway.
Type Counter
Dimension
  • app_id
  • cmd_code
  • status
  • message_direction
Example ocnef_diamgw_diam_resp_total{app_id="16777313"}

Table 6-92 ocnef_diamgw_http_req_total

Field Details
Description This metric records the total number of inbound and outbound requests to and from the diameter gateway to NEF microservices.
Type Counter
Dimension
  • app_id
  • cmd_code
  • message_direction
Example ocnef_diamgw_http_req_total{app_id="16777313"}

Table 6-93 ocnef_diamgw_http_resp_total

Field Details
Description This metric records the total inbound and outbound responses to and from the NEF microservices to diameter gateway.
Type Counter
Dimension
  • app_id
  • cmd_code
  • status
  • message_direction
Example ocnef_diamgw_http_resp_total{app_id="16777313"}

Table 6-94 ocnef_diamgw_translator_request_total

Field Details
Description This metric captures total requests translated, translation status from diameter to http.
Type Counter
Dimension
  • app_id
  • cmd_code
  • translatorType
  • translationStatus
  • errorReason
Example ocnef_diamgw_translator_request_total{app_id="16777313"}

6.3.11 MSISDNless MO SMS Metrics

The following metrics are applicable to MSISDNless MO SMS metrics.

Table 6-95 ocnef_msisdnless_mo_sms_diamgw_notify_req_total

Field Details
Description Count of (Msisdnless MO SMS notification flow) requests received from DiamGW.
Type Counter
Dimension
  • method
  • type
Example ocnef_msisdnless_mo_sms_diamgw_notify_req_total{method="POST"}

Table 6-96 ocnef_msisdnless_mo_sms_diamgw_notify_resp_total

Field Details
Description Count of (Msisdnless MO SMS notification flow) responses sent to DiamGW.
Type Counter
Dimension
  • method
  • status
Example ocnef_msisdnless_mo_sms_diamgw_notify_resp_total{method="POST"}

Table 6-97 ocnef_msisdnless_mo_sms_srv_req_total

Field Details
Description Count of (Msisdnless MO SMS notification flow) requests sent towards Fivegc Agent or AF.
Type Counter
Dimension
  • event
  • to
  • destination
Example ocnef_msisdnless_mo_sms_srv_req_total{event="onFailure"}

Table 6-98 ocnef_msisdnless_mo_sms_srv_resp_total

Field Details
Description Count of (Msisdnless MO SMS notification flow) responses received from Fivegc Agent or AF.
Type Counter
Dimension
  • event
  • from
  • destination
Example ocnef_msisdnless_mo_sms_srv_resp_total{event="onFailure"}

Table 6-99 ocnef_msisdnless_mo_sms_srv_latency

Field Details
Description Latency duration of request and response. It typically generates a max gauge, and some counters (_sum, _count and the buckets).
Type Histogram
Dimension
  • method
  • destination
Example ocnef_msisdnless_mo_sms_srv_latency_seconds_bucket[2m]

6.4 CAPIF Metrics

This section describes the CAPIF metrics and respective dimensions.

Note:

For more information about Dimensions, see NEF Metrics.

Examples

The following is a sample example of EG service metrics: 

occapifapimgr_req{Method="DELETE",Svc_Type="DiscoveryGroupService"} 1.0

occapif_apimgr_resp{Cause="NONE",Method="DELETE",Status="204",Svc_Type="DiscoveryGroupService"} 1.0

occapif_afmgr_req{Method="DELETE",Svc_Type="PreProv"} 1.0

occapif_afmgr_resp{Cause="NONE",Method="DELETE",Status="204",Svc_Type="PreProv"} 1.0

occapif_eventmgr_subscription_req{Events="SERVICE_API_AVAILABLE",Method="POST"} 1.0

occapif_eventmgr_subscription_resp{Cause="NONE",Events="SERVICE_API_AVAILABLE",Method="POST",Status="201"} 1.0

occapif_eventmgr_subscription_req{Events="SERVICE_API_AVAILABLE",Method="DELETE"} 1.0

occapif_eventmgr_subscription_resp{Cause="NONE",Events="SERVICE_API_AVAILABLE",Method="DELETE",Status="204"} 1.0

occapif_eventmgr_publish_req{Events="SERVICE_API_AVAILABLE",Method="POST"} 1.0

occapif_eventmgr_publish_resp{Cause="NONE",Events="SERVICE_API_AVAILABLE",Method="POST",Status="204"} 1.0

occapif_eventmgr_notification_req{Events="SERVICE_API_AVAILABLE",Method="POST"} 3.0

occapif_eventmgr_notification_resp_total{Cause="NONE",Events="SERVICE_API_AVAILABLE",Method="POST",Status="204"} 3.0

6.4.1 API Manager Metrics

The following metrics are applicable to API Manager metrics.

Table 6-100 occapif_apimgr_req

Field Details
Description Count of request messages received by the API Manager service.
Type Counter
Dimension
  • Method
  • Svc_Type
Note: The Svc_Type contains the following details:
  • RegistrationService
  • PublishService
  • DiscoveryService
  • DiscoveryGroupService
Example  

Table 6-101 occapif_apimgr_resp

Field Details
Description Count of response messages sent back by the API Manager service.
Type Counter
Dimension
  • Method
  • Status
  • Cause
  • Svc_Type
Example  

6.4.2 AF Manager Metrics

The following metrics are applicable to AF Manager metrics.

Table 6-102 occapif_afmgr_req

Field Details
Description Count of request messages received by the AF Manager service.
Type Counter
Dimension
  • Method
  • Svc_Type
Note: The Svc_Type contains the following details:
  • PreProv
  • Onboarding
  • ObtainAuth
  • SecurityContext
Example  

Table 6-103 occapif_afmgr_resp

Field Details
Description Count of response messages sent back by the AF Manager service.
Type Counter
Dimension
  • Method
  • Status
  • Cause
  • Svc_Type
Example  

6.4.3 Event Manager Metrics

The following metrics are applicable to Event Manager metrics.

Table 6-104 occapif_eventmgr_subscription_req

Field Details
Description The number of EG event subscription requests received.
Type Counter
Dimension
  • Method
  • Event
Example  

Table 6-105 occapif_eventmgr_subscription_resp

Field Details
Description The number of EG event subscription responses sent.
Type Counter
Dimension
  • Method
  • Event
  • Status
  • Cause
Example  

Table 6-106 occapif_eventmgr_publish_req

Field Details
Description The number of EG event publish requests received.
Type Counter
Dimension
  • Method
  • Event
Example  

Table 6-107 occapif_eventmgr_publish_resp

Field Details
Description The number of EG event publish response received.
Type Counter
Dimension
  • Method
  • Event
  • Status
  • Cause
Example  

Table 6-108 occapif_eventmgr_notification_req

Field Details
Description The number of CAPIF event notification requests sent.
Type Counter
Dimension
  • Method
  • Event
Example  

Table 6-109 occapif_eventmgr_notification_resp_total

Field Details
Description The number of CAPIF event notifications responses received.
Type Counter
Dimension
  • Method
  • Event
  • Status
  • Cause
Example  

6.5 Ingress Gateway Metrics

Ingress Gateway Metrics

Ingress Metrics Common Tags

Tags Description Possible Values
Method Http method.
  • GET
  • PUT
  • POST
  • DELETE
  • PATCH
NFType Name of the NF Type.

For Eg: Path is /nxxx-yyy/vz/.......

Where XXX(Upper Case) is NFType

UNKNOWN if unable to extract NFType from the path
NFServiceType Name of the Service with in the NF.

For Eg: Path is /nxxx-yyy/vz/.......

Where nxxx-yyy is NFServiceType

UNKNOWN if unable to extract NFServiceType from the path
Host Port of ingress gateway (Ip or fqdn). NA
HttpVersion Http protocol version.
  • HTTP/1.1
  • HTTP/2.0
Scheme Http protocol scheme. HTTP, HTTPS, UNKNOWN
ClientCertIdentity Cerificate Identity of the client. SAN=127.0.0.1,localhost CN=localhost, N/A if data is not available
Route_Path Path predicate/Header predicate that matched the current request. NA
InstanceIdentifier Prefix of the pod configured in helm when there are multiple instances in same deployment. Prefix configured in helm otherwise UNKNOWN
ErrorOriginator This tag captures the ErrorOriginator. ServiceProducer, Nrf, IngresGW, None

oc_ingressgateway_route_ratelimit_Status

oc_ingressgateway_global_ratelimit_Status

 Request accepted or dropped. accepted, dropped
oc_ingressgateway_connection_failure_Host Destination ip/fqdn. NA
oc_ingressgateway_connection_failure_Port Destination port. NA
oc_ingressgateway_xfcc_header_validate_Status Https Status value after performing xfccHeaderValidation at Ingress Gateway. 200 (OK), 400 (BAD_REQUEST)
oc_ingressgateway_xfcc_header_validate_Cause This tag determines the validation cause for the xfcc header validation metric being pegged. VALIDATION_FAILURE, VALIDATION_SUCCESS, HEADER_NOT_FOUND
oc_ingressgateway_xfcc_header_validate_CertsCompared This tag captures the total number of certificates compared in XFCC header at ingress gateway during the header validation. Count of the certificates compared (0,1,2..)
oc_configclient_request_total_releaseVersion This tag indicates the current release version of ingress gateway. Picked from helm chart{{ .Chart.Version }}
oc_configclient_request_total_configVersion This tag indicates the configuration version that ingress gateway is currently maintaining. Initial value is 0. Incremental value received from config server whenever there is an update from config server (0, 1, 2...)
oc_configclient_response_total_releaseVersion This tag indicates the current release version of ingress gateway.

Picked from helm chart

{{ .Chart.Version }}
oc_configclient_response_total_configVersion This tag indicates the configuration version that ingress gateway is currently maintaining. Value received from config server (1, 2...)
oc_configclient_response_total_updated This tag indicates whether the configuration was updated or not. true/false

Ingress Gateway Metrics

Table 6-110 oc_ingressgateway_http_requests_total

Field Details
Description This metric is pegged as soon as the request reaches the Ingress gateway in the first custom filter of the application.
Type Counter
Dimension
  • NFType
  • NFServiceType
  • Host
  • HttpVersion
  • Scheme
  • Route_path
  • InstanceIdentifier
  • ClientCertIdentity

Table 6-111 oc_ingressgateway_http_responses_total

Field Details
Description This metric is pegged in the last custom filter of the Ingress gateway while the response is being sent back to the consumer NF.
Type Counter
Dimension
  • Status
  • Method
  • Route_path
  • NFType
  • NFServiceType
  • Host
  • HttpVersion
  • Scheme
  • Identifier
  • ClientCertIdentity

Table 6-112 oc_ingressgateway_request_latency_seconds

Field Details
Description This metric is pegged in the last custom filter of the Ingress gateway while the response is being sent back to the consumer NF. This metric tracks the amount of time taken for processing the request. It starts as soon the request reaches the first custom filter of the application and lasts till the response is sent back to the consumer NF from the last custom filter of the application.
Type Timer
Dimension
  • quantile
  • InstanceIdentifier

Table 6-113 oc_ingressgateway_connection_failure_total

Field Details
Description This metric is pegged in the customized Jetty Client as soon as it fails to connect to the destination service with direction as ingressOut. Here in case of Ingress gateway, the destination service is a backend microservice of the NF.

And TLS connection failure metrics when connecting to ingress with direction as ingress.
Type Counter
Dimension
  • Host
  • Port
  • Direction
  • InstanceIdentifier
  • error_reason

Table 6-114 oc_ingressgateway_global_ratelimit_total

Field Details
Description This metric is pegged in the custom filter implemented to check the global rate limit conditions.
Type Counter
Dimension
  • Method
  • Route_path
  • Scheme
  • InstanceIdentifier
  • Status (Rate limit Status field is different here )

Table 6-115 oc_ingressgateway_route_ratelimit_total

Field Details
Description This metric is pegged in the custom filter implemented to check the route level rate limit conditions.
Type Counter
Dimension
  • Method
  • Route_path
  • Scheme
  • InstanceIdentifier
  • Status (Rate limit Status field is different here )

Table 6-116 oc_ingressgateway_request_processing_latency_seconds

Field Details
Description This metric is pegged in the last custom filter of the Ingress gateway while the response is being sent back to the consumer NF. This metric captures the amount of time taken for processing of the request only within Ingress gateway. It starts as soon the request reaches the first custom filter of the application and lasts till the request is forwarded to the destination.
Type Timer
Dimension
  • quantile
  • InstanceIdentifier

Table 6-117 oc_ingressgateway_jetty_request_stat_metrics_total

Field Details
Description This metric is pegged for every event occurred when a request is sent to IGW.
Type Counter
Dimension
  • event
  • client_type
  • InstanceIdentifier

Table 6-118 oc_ingressgateway_jetty_response_stat_metrics_total

Field Details
Description This metric is pegged for every event occurred when a response is received by IGW
Type Counter
Dimension
  • event
  • client_type
  • InstanceIdentifier

Table 6-119 oc_ingressgateway_jetty_latency_seconds

Field Details
Description This metric is pegged in Jetty response listener that captures the amount of time taken for processing of the request by jetty client.
Type Timer
Dimension
  • quantile
  • InstanceIdentifier

Table 6-120 oc_ingressgateway_netty_latency_seconds

Field Details
Description This metric is pegged in Netty outbound handler that captures the amount of time taken for processing of the request by netty server.
Type Timer
Dimension
  • quantile
  • InstanceIdentifier

Table 6-121 oc_ingressgateway_request_content_metrics_total

Field Details
Description This metric is pegged by default filter RequestContentMetrics. It pegs whether request has request body or not.
Type Counter
Dimension
  • method
  • content_available
  • InstanceIdentifier

Table 6-122 oc_ingressgateway_xfcc_header_validate_total

Field Details
Description This metric is pegged when xfccHeaderValidation is enabled in XfccHeaderValidationFilter. This metric along with the specified dimension captures the successful/ un-successful validation of XFCC header in the incoming request.
Type Counter
Dimension
  • Route_path
  • Status
  • Cause
  • CertsCompared
  • InstanceIdentifier
  • ErrorOriginator

Table 6-123 oc_configclient_request_total

Field Details
Description This metric is pegged whenever config client is polling for configuration update from common configuration server.
Type Counter
Dimension
  • Release version
  • Config version

Table 6-124 oc_configclient_response_total

Field Details
Description This metrics is pegged whenever config client receives response from common configuration server.
Type Counter
Dimension
  • Release version
  • Config version
  • Updated

Oauth Metrics

OAuth Metrics Common Tags

Tags Description Possible Values
scope NF service name(s) of the NF service producer(s), separated by white spaces. NA
issuer NF instance id of NRF. NA
subject NF instance id of service consumer. NA
reason reason contains the human readable message for oauth validation failure. NA

Below are the metrics and their respective tags that are available in Oauth:

Table 6-125 oc_oauth_validation_successful _total

Field Details
Description This metric is pegged in the OAuth validator implementation if the received OAuth token is validated successfully. The implementation of OAuth validator is used in Ingress Gateway.
Type Counter
Dimension
  • issuer
  • subject
  • scope

Table 6-126 oc_oauth_validation_failure _total

Field Details
Description This metric is pegged in the implementation of OAuth validator if the validation of the the received OAuth token fails. The implementation of OAuth validator is used in Ingress G;ateway.
Type Counter
Dimension
  • issuer
  • subject
  • scope
  • reason

6.6 Egress Gateway Metrics

Egress Gateway Metrics

The following table describes the Egress Gateway Metrics.

Table 6-127 oc_egressgateway_http_requests_total

Field Details
Available Tags
  • Method
  • NFType
  • NFServiceType
  • Host
  • HttpVersion
  • Scheme
  • Proxy
  • InstanceIdentifier
Pegging Instance This metric is pegged as soon as the request reaches the Egress Gateway in the first custom filter of the application.

Table 6-128 oc_egressgateway_http_responses_total

Field Details
Available Tags
  • Status
  • Method
  • NFType
  • NFServiceType
  • Host
  • HttpVersion
  • Scheme
  • InstanceIdentifier
  • Direction
  • BlacklistedFqdn
Pegging Instance

This metric will be pegged in the last custom filter of the Egress gateway while the response is being sent back to backend NF microservice with direction as egress.

This will also be pegged when the response is fetched in Jetty responseListener with direction as egressOut.

BlacklistedFqdn tag will be filled with BlacklistedFqdn when request is sent with blacklisted producer.

Table 6-129 oc_egressgateway_request_latency_seconds

Field Details
Available Tags
  • quantile
  • InstanceIdentifier
Pegging Instance This metric is pegged in the last custom filter of the Ingress Gateway while the response is being sent back to the consumer NF. This metric tracks the amount of time taken for processing the request. It starts as soon as the request reaches the first custom filter of the application and lasts till, the response is sent back to the the consumer NF from the last custom filter of the application.

Table 6-130 oc_egressgateway_connection_failure_total

Field Details
Available Tags
  • Host
  • Port
  • InstanceIdentifier
  • Direction
  • error_reason
Pegging Instance

This metric will be pegged in the customized Jetty Client as soon as it fails to connect to the destination service. Here in case of Egress gateway, the destination service will be Producer NF.

This will also be pegged when the request to Producer NF fails in Jetty request Listener with direction as egressOut

Table 6-131 oc_egressgateway_notification_ratelimit_total

Field Details
Available Tags
  • Method
  • Scheme
  • InstanceIdentifier
Pegging Instance This metric is pegged in the custom filter implemented to check the notification rate limit conditions.

Table 6-132 oc_egressgateway_request_processing_latency_seconds

Field Details
Available Tags
  • quantile
  • InstanceIdentifier
Pegging Instance This metric is pegged in the last custom filter of the Egress Gateway while the response is sent back to the consumer NF. This metric tracks the amount of time taken for processing the request only within Egress Gateway. It starts as soon as the request reaches the first custom filter of the application and lasts till the request is forwarded to the destination.

Table 6-133 oc_egressgateway_jetty_request_stat_metrics_total

Field Details
Available Tags
  • event
  • client_type
  • InstanceIdentifier
Pegging Instance This metric is pegged for every event occurred when a request is sent to EGW

Table 6-134 oc_egressgateway_jetty_response_stat_metrics_total

Field Details
Available Tags
  • event
  • client_type
  • InstanceIdentifier
Pegging Instance This metric is pegged for every event occurred when a response is received by EGW

Table 6-135 oc_egressgateway_jetty_response_stat_metrics_total

Field Details
Available Tags
  • event
  • client_type
  • InstanceIdentifier
Pegging Instance This metric is pegged for every event occurred when a response is received by EGW

Table 6-136 oc_egressgateway_jetty_latency_seconds

Field Details
Available Tags
  • quantile
  • InstanceIdentifier
Pegging Instance This metric is pegged in Jetty response listener that captures the amount of time taken for processing of the request by jetty client

Table 6-137 oc_egressgateway_jetty_latency_seconds

Field Details
Available Tags
  • quantile
  • InstanceIdentifier
Pegging Instance This metric is pegged in Jetty response listener that captures the amount of time taken for processing of the request by jetty client

Table 6-138 oc_egressgateway_netty_latency_seconds

Field Details
Available Tags
  • quantile
  • InstanceIdentifier
Pegging Instance This metric is pegged in Netty outbound handler that captures the amount of time taken for processing of the request by netty server

Table 6-139 oc_egressgateway_request_content_metrics_total

Field Details
Available Tags
  • method
  • content_available
  • InstanceIdentifier
Pegging Instance This metric is pegged by default filter RequestContentMetrics. It pegs whether request has request body or not and the method.

Table 6-140 oc_egressgateway_blacklisted_producer_total

Field Details
Available Tags
  • NFType
  • NFServiceType
  • InstanceIdentifier
  • Host
  • Route_path
Pegging Instance This metric is a counter. Track number of times producer is blacklisted.

Table 6-141 oc_configclient_request_total

Field Details
Available Tags
  • Release version
  • Config version
Pegging Instance This metric will be pegged whenever config client is polling for configuration update from common configuration server

Table 6-142 oc_configclient_response_total

Field Details
Available Tags
  • Release version
  • Config version
  • Updated
Pegging Instance This metrics will be pegged whenever config client receives response from common configuration server

Egress Gateway Metrics Common Tags

The following table describes the common tags used in Egress Gateway Metrics.

Table 6-143 Method

Field Details
Available Tags Http method
Pegging Instance GET, PUT, POST, DELETE, PATCH

Table 6-144 NFType

Field Details
Available Tags Name of the NF Type
Pegging Instance "UNKNOWN" (Updates are available when Ingress is 5G aware)

Table 6-145 NFServiceType

Field Details
Available Tags Name of the Service within the NF
Pegging Instance "UNKNOWN" (Updates are available when Ingress is 5G aware)

Table 6-146 Host

Field Details
Available Tags (IP or fqdn): port of ingress gateway
Pegging Instance Not Applicable

Table 6-147 HttpVersion

Field Details
Available Tags Http protocol version (http1.1/ http2)
Pegging Instance HTTP1.1, HTTP2.0

Table 6-148 Scheme

Field Details
Available Tags Http protocol scheme (http/https)
Pegging Instance HTTP, HTTPS, UNKNOWN

Table 6-149 Proxy

Field Details
Available Tags Value received for "x-custom-egress-proxy-header".
Pegging Instance Unknown or value of "x-custom-egress-proxy-header".

Table 6-150 oc_egressgateway_connection_failure_Host

Field Details
Available Tags destination ip/fqdn
Pegging Instance Not Applicable

Table 6-151 oc_egressgateway_connection_failure_Port

Field Details
Available Tags destination port
Pegging Instance Not Applicable

Table 6-152 BlacklistedFqdn

Field Details
Available Tags Blacklisted Producer Fqdn
Pegging Instance Unknown or Blacklisted Producer Fqdn

Table 6-153 oc_configclient_request_total_releaseVersion

Field Details
Available Tags This tag indicates the current release version of egress gateway
Pegging Instance Picked from helm chart{{ .Chart.Version }}

Table 6-154 oc_configclient_request_total_configVersion

Field Details
Available Tags This tag indicates the configuration version that egress gateway is currently maintaining
Pegging Instance Initial value is 0. Incremental value received from config server whenever there is an update from config server (0, 1, 2...)

Table 6-155 oc_configclient_response_total_releaseVersion

Field Details
Available Tags This tag indicates the current release version of egress gateway
Pegging Instance Picked from helm chart{{ .Chart.Version }}

Table 6-156 oc_configclient_response_total_configVersion

Field Details
Available Tags This tag indicates the configuration version that egress gateway is currently maintaining
Pegging Instance Value received from config server (1, 2...)

Table 6-157 oc_configclient_response_total_updated

Field Details
Available Tags This tag indicates whether the configuration was updated or not
Pegging Instance true/false

SCP Metrics

The following table describes the different metrics and their respective tags that are available in the SCP Module:

Table 6-158 oc_egressgateway_scp_http_requests_total

Field Details
Available Tags
  • Scp_Fqdn
  • Reroute_Path
  • Response_Code (This would be populated as blank for requests)
  • Attempt
  • HttpVersion
  • Scheme
  • InstanceIdentifier
Pegging Instance This metric is pegged in the ScpFilter only when SCP Integration is enabled.

Table 6-159 oc_egressgateway_scp_http_responses_total

Field Details
Available Tags
  • Scp_Fqdn
  • Reroute_Path
  • Response_Code
  • Attempt
  • HttpVersion
  • Scheme
  • InstanceIdentifier
Pegging Instance This metric is pegged in the ScpFilter only when Scp Integration is enabled. It is also being pegged in the Scp Retry Filter when Scp re-route feature is enabled.

SCP Metrics common tags

The following table describes common tags used in SCP Metrics.

Table 6-160 Scp_Fqdn

Field Details
Description SCP Fqdn
Possible Values Not Applicable

Table 6-161 Reroute_Path

Field Details
Description

Path that matched the request to over corresponding route

Example: /nef/**
Possible Values Not Applicable

Table 6-162 Response_Code

Field Details
Description

It is populated as blank for request metrics.

During failure scenario's, it is populated with "ERROR" for response metrics.

Example: ERROR, OK
Possible Values ERROR, NOT ACCEPTABLE, OK

Table 6-163 Attempt

Field Details
Description

Attempt number for scp re-route.

Example: 1, 2 etc.
Possible Values Not Applicable

Table 6-164 HttpVersion

Field Details
Description Http protocol version (http1.1/ http2)
Possible Values HTTP/1.1, HTTP/2.0

Table 6-165 Scheme

Field Details
Description Http protocol scheme (http/https)
Possible Values HTTP, HTTPS, UNKNOWN

Table 6-166 InstanceIdentifier

Field Details
Description Prefix of the pod configured in helm when there are multiple instances in same deployment
Possible Values Prefix configured in helm otherwise UNKNOWN

Oauth Metrics

The following table includes metrics and their respective tags that are available in the Oauth Module:

Table 6-167 oc_oauth_nrf_request_total

Field Details
Available Tags
  • ConsumerNFInstanceId
  • ConsumerNFType
  • TargetNFType
  • TargetNFInstanceId
  • scope
  • NrfFqdn
Pegging Instance This metric is pegged in the OAuth client implementation if the request is sent to NRF for requesting the OAuth token. OAuth client implementation will be used in Egress gateway.

Table 6-168 oc_oauth_nrf_response_success_total

Field Details
Available Tags
  • ConsumerNFInstanceId
  • ConsumerNFType
  • TargetNFType
  • TargetNFInstanceId
  • scope
  • StatusCode
  • NrfFqdn
Pegging Instance This metric is pegged in the OAuth client implementation if an OAuth token is successfully received from the NRF. OAuth client implementation is used in the Egress Gateway.

Table 6-169 oc_oauth_nrf_response_failure_total

Field Details
Available Tags
  • ConsumerNFInstanceId
  • ConsumerNFType
  • TargetNFType
  • TargetNFInstanceId
  • scope
  • StatusCode
  • ErrorOriginator
  • NrfFqdn
Pegging Instance This metric is pegged in the OAuthClientFilter in Egress Gateway whenever GetAccessTokenFailedException is caught.

Table 6-170 oc_oauth_request_failed_internal_total

Field Details
Available Tags
  • ConsumerNFInstanceId
  • ConsumerNFType
  • TargetNFType
  • TargetNFInstanceId
  • scope
  • StatusCode
  • ErrorOriginator
  • NrfFqdn
Pegging Instance This metric is pegged in the OAuthClientFilter in Egress Gateway whenever InternalServerErrorException is caught.

Table 6-171 oc_oauth_token_cache_total

Field Details
Available Tags
  • ConsumerNFInstanceId
  • ConsumerNFType
  • TargetNFType
  • TargetNFInstanceId
  • scope
Pegging Instance This metric is pegged in the OAuth Client Implementation if the OAuth token is found in the cache.

Table 6-172 oc_oauth_request_invalid_total

Field Details
Available Tags
  • ConsumerNFInstanceId
  • ConsumerNFType
  • TargetNFType
  • TargetNFInstanceId
  • scope
  • StatusCode
  • ErrorOriginator
Pegging Instance This metric is pegged in the OAuthClientFilter in Egress Gateway whenever a BadAccessTokenRequestException/JsonProcessingException is caught.

Table 6-173 oc_egressgateway_ouath_access_token_request_header_missing

Field Details
Available Tags NA
Pegging Instance This metric is pegged in the OAuthClientFilter in Egress Gateway whenever oc-access-token-request-info header is missing in the request.

Table 6-174 oc_oauth_cert_expiryStatus

Field Details
Available Tags
  • id
  • certificateName
  • secretName
Pegging Instance This Gauge metric is used to peg expiry date of the certificate. This metric is further used for raising alarms if certificate expires within 30 days or 7 days.

Table 6-175 oc_oauth_cert_loadStatus

Field Details
Available Tags
  • id
  • certificateName
  • secretName
Pegging Instance This gauge metric is used to peg expiry date of the certificate. This metric is further used for raising alarms if certificate expires within 30 days or 7 days.

Table 6-176 oc_oauth_request_failed_cert_expiry

Field Details
Available Tags
  • target nf type
  • target nf instance id
  • consumer nf instance id
  • nrf instance id
  • service name of nf producer service
  • key id
Pegging Instance This counter metric is used to keep track of number of requests with keyId in token that failed due to certificate expiry. It is pegged whenever oAuth Validator module throws oauth custom exception due to certificate expiry for an incoming request.

Table 6-177 oc_oauth_keyid_count

Field Details
Available Tags
  • target nf type
  • target nf instance id
  • consumer nf instance id
  • nrf instance id
  • service name of nf producer service
  • key id
Pegging Instance This counter metric used to keep track of number of requests received with keyId in token. It is pegged whenever a request with an access token containing keyid in header comes to oAuth Validator.

Table 6-178 oc_oauth_nrf_token_retrieval_failure_total

Field Details
Available Tags
  • ConsumerNFInstanceId
  • ConsumerNFType
  • TargetNFType
  • TargetNFInstanceId
  • scope
  • StatusCode
  • ErrorOriginator
  • ErrorDetail
  • NrfFqdn
Pegging Instance This metric is pegged to track requests discarded due to oAuth token retrieval failure from NRF.

OAuth Metrics (NRF-Client Mgmt Service Call-Flow)

Table 6-179 oc_oauth_nrf_client_subscription_request_total

Field Details
Available Tags
  • NrfClientUrl
  • EgwNotificationUrl
When it is pegged

This metric will be pegged in the OAuth client implementation module

when a subscription request is sent from EGW to NRF-Client Mgmt Svc

with request-URL (NrfClientUrl) and request body containing notification-URL of EGW (EgwNotificationUrl) for Oauth Client notification requests generated from NRF-Client Mgmt Svc to EGW. OAuth client implementation will be used in Egress gateway.

Table 6-180 oc_oauth_nrf_client_notification_request_total

Field Details
Available Tags None
When it is pegged This metric will be pegged in the OAuth client implementation module when a notification request is sent from NRF-Client Mgmt Svc to EGW.OAuth client implementation will be used in Egress gateway.

Table 6-181 oc_oauth_nrf_client_subscription_response_total

Field Details
Available Tags
  • NrfClientUrl
  • EgwNotificationUrl
  • StatusCode
When it is pegged

This metric will be pegged in the OAuth client implementation module

when a subscription response is sent from NRF-Client Mgmt Svc having

URL (NrfClientUrl) to EGW having URL (EgwNotificationUrl). StatusCode

tag will capture the corresponding response status obtained from

NRF-Client. OAuth client implementation will be used in Egress gateway.

Table 6-182 oc_oauth_nrf_client_notification_response_total

Field Details
Available Tags
  • StatusCode
When it is pegged This metric will be pegged in the OAuth client implementation modulewhen a notification response is sent from EGW to NRF-Client Mgmt Svc.StatusCode tag will capture the corresponding response status sent fromEGW. OAuth client implementation will be used in Egress gateway.

Table 6-183 oc_oauth_nrf_client_active_nrf_instances

Field Details
Available Tags
  • NrfFqdn
When it is pegged This is a GAUGE metric which keeps track of healthy NRF Fqdns recievedfrom NRF-Client Mgmt Svc as part of subscription response/ notificationrequest to EGW.

OAuth Metrics common tags

The following table describes common tags used in the OAuth Module.

Table 6-184 ConsumerNFInstanceId

Field Details
Description NF instance id of the NF service consumer
Possible Values Not Applicable

Table 6-185 ConsumerNFType

Field Details
Description The NF type of the NF service consumer
Possible Values NRF, UDM, AMF, SMF, AUSF, NEF, PCF, SMSF, NSSF, UDR, LMF, GMLC,5G_EIR, SEPP, UPF, N3IWF, AF, UDSF, BSF, CHF, NWDAF

Table 6-186 TargetNFType

Field Details
Description The NF type of the NF service producer
Possible Values NRF, UDM, AMF, SMF, AUSF, NEF, PCF, SMSF, NSSF, UDR, LMF, GMLC,5G_EIR, SEPP, UPF, N3IWF, AF, UDSF, BSF, CHF, NWDAF

Table 6-187 TargetNFInstanceId

Field Details
Description NF instance id of the NF service producer
Possible Values Not Applicable

Table 6-188 scope

Field Details
Description NF service name(s) of the NF service producer(s), separated by whitespaces
Possible Values Not Applicable

Table 6-189 StatusCode

Field Details
Description Status code of NRF access token request
Possible Values Bad Request, Internal Server Error etc. (HttpStatus.*)

Table 6-190 ErrorOriginator

Field Details
Description from where error is originated (nrf or egress)
Possible Values Nrf, EgressGW

Table 6-191 issuer

Field Details
Description NF instance id of NRF
Possible Values Not Applicable

Table 6-192 subject

Field Details
Description NF instance id of service consumer
Possible Values Not Applicable

Table 6-193 reason

Field Details
Description reason contains the human readable msg for oauth validation failure
Possible Values Not Applicable

Table 6-194 NrfFqdn

Field Details
Description NrfFqdn tag determines the corresponding fqdn of NRF where the request has been forwarded to.
Possible Values Nrf-Fqdn (dynamic value based on Fqdn), NA

Table 6-195 NrfClientUrl

Field Details
Description This tag determines the url of NRF-Client Mgmt Svc where subscription requests are sent from OAuth Client module in EGW.
Possible Values URL of NRF-Client Mgmt Svc (Dynamic value)

Table 6-196 EgwNotificationUrl

Field Details
Description This tag determines the notification URL mapped in OAuth Client module of EGW where NRF-Client Mgmt Svc will send notifications requests.
Possible Values Notification URL (Dynamic value)

Table 6-197 ConfigurationType

Field Details
Description This tag determines the type of configuration in place for OAuth Client in Egress Gateway. If nrfClientQueryEnabled Helm parameter in oauthClient Helm configurations at Egress Gateway is false then the ConfigurationType is STATIC, else DYNAMIC.
Possible Values STATIC, DYNAMIC

Table 6-198 oc_egressgateway_msgcopy_requests_total

Field Details
Description This is incremented whenever egress request message is sent or acknowledged from Kafka.
Type Counter
Dimension  
Example  

Table 6-199 oc_egressgateway_msgcopy_responses_total

Field Details
Description This is incremented whenever egress response message is sent or acknowledged from Kafka.
Type Counter
Dimension  
Example