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_.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 Data Type
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
api_name The name of the API string
Cause Reason for failure string
error Error message boolean
Host Host address IP address
HttpVersion Http protocol version. string
Port Port number Numeric
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
translationType Type of message translation performed String
translationStatus Status of translation (success/failure) String
NFType Network Function type String
NFServiceType Service type within the Network Function String
Scheme HTTP scheme used (http/https) String
Route_path API route path of the request String
InstanceIdentifier Unique identifier of service instance String
Proxy Proxy header or proxy identifier String
BlacklistedFqdn FQDN marked as blacklisted String
ErrorOriginator Component that originated the error String
content_available Indicates whether request contains payload/body Boolean
jetty_request_timeout Timeout value for request handling Numeric
quantile Quantile value for histogram metrics Numeric
Time Time duration or latency value Numeric
app_id Application ID used in telecom protocols Numeric
cmd_code Command code used in telecom protocols Numeric
type Type/category of request or message String

Note:

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

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

Egress 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
Proxy Value received for "x-custom-egress-proxy-header". Unknown or value of "x-custom-egress-proxy-header".
Port Destination port NA
BlacklistedFqdn Blacklisted Producer Fqdn Unknown or Blacklisted Producer Fqdn
releaseVersion This tag indicates the current release version of egress gateway Picked from helm chart{{ .Chart.Version }}
configVersion This tag indicates the configuration version that egress 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...)
updated This tag indicates whether the configuration was updated or not. true, false

SBIRouting Metrics common tags

The following table describes common tags used in SBI routing Metrics.

Tags Description Possible Values
Sbi_Fqdn SBI FQDN Not Applicable
Reroute_Path

Path that matched the request to over corresponding route

Example: /nef/**

 Not Applicable
Response_Code

It is populated as blank for request metrics.

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

Example: ERROR, OK

 ERROR, NOT ACCEPTABLE, OK
Attempt

Attempt number for scp re-route.

Example: 1, 2 etc.

 Not Applicable
HttpVersion Http protocol version.
  • HTTP/1.1
  • HTTP/2.0
Scheme Http protocol scheme. HTTP, HTTPS, UNKNOWN
InstanceIdentifier Prefix of the pod configured in helm when there are multiple instances in same deployment Prefix configured in helm otherwise UNKNOWN

6.3 NEF Metrics

This section provides all the NEF metrics and respective dimensions.

Note:

For more information about Dimensions, see NEF Metrics.

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_svc_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_total

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

Table 6-3 ocnef_aef_apirouter_resp_total

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

Table 6-4 ocnef_aef_apirouter_latency_seconds

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

Table 6-5 OCNEF_AEF_APIROUTER_BACKEND_CONNECTION_FAILURE_total

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

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

Table 6-7 OCNEF_AEF_APIROUTER_BACKEND_JETTY_REQUEST_STAT_total

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

Table 6-8 OCNEF_AEF_APIROUTER_BACKEND_JETTY_RESPONSE_STAT_total

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

Table 6-9 ocnef_aef_apirouter_backend_latency_seconds

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

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

Table 6-11 ocnef_ccf_client_registration

Field Details
Description CCF client registration status
Type Gauge
Dimension Success

Table 6-12 ocnef_ccf_client_service_failure

Field Details
Description CCF client service failure count
Type Gauge
Dimension
  • ServiceName
  • Status

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

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

Table 6-15 ocnef_me_5g_req_total

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

Table 6-16 ocnef_me_5g_resp_total

Field Details
Description Count of notification responses sent by the ME service.
Type Counter
Dimension
  • monitoring_type
  • status

Table 6-17 ocnef_me_5g_ue_r_ignored_req_total

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

Table 6-18 ocnef_me_af_latency_seconds

Field Details
Description Latency for processing subscriptions at the ME service.
Type Timer
Dimension
  • method
  • status

Table 6-19 ocnef_me_5g_latency_seconds

Field Details
Description Latency for processing notifications at the ME service.
Type Timer
Dimension
  • status

Table 6-20 ocnef_svc_me_db_latency_seconds

Field Details
Description Time duration in seconds to process dbQuery.
Type Counter
Dimension
  • exception
  • method
  • state

Table 6-21 ocnef_svc_me_db_query_seconds_count

Field Details
Description Count of number of dbQuery.
Type Counter
Dimension
  • exception
  • method
  • state

Table 6-22 ocnef_svc_me_db_query_seconds_max

Field Details
Description Maximum duration of time in seconds allowed to process dbQuery.
Type Gauge
Dimension
  • exception
  • method
  • state

Table 6-23 ocnef_me_srv_req_total

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

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

Table 6-24 ocnef_me_srv_resp_total

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

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

Table 6-25 ocnef_me_srv_latency_seconds

Field Details
Description Latency for message received at the ME service.
Type Timer
Dimension
  • method
  • destination

Table 6-26 ocnef_me_svc_gmlc_to_udm_switchover_count

Field Details
Description The number of requests sent to UDM on GMLC failure.
Type Counter
Dimension No dimensions

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.

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.

Table 6-29 ocnef_all_site_status

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

Table 6-30 ocnef_db_replication_status

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

6.3.4 QoS Service Metrics

The following metrics are applicable to QoS Service metrics.

Table 6-31 ocnef_qos_af_req_total

Field Details
Description Count of QoS messages received from AF in NEF
Type Counter
Dimension
  • method

Table 6-32 ocnef_qos_af_resp_total

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

Table 6-33 ocnef_qos_5g_req_total

Field Details
Description Count of notification requests received from Fivegc Agent
Type Counter
Dimension
  • method
  • from
  • type

Table 6-34 ocnef_qos_5g_resp_total

Field Details
Description Count of responses sent to Fivegc Agent
Type Counter
Dimension
  • method
  • status
  • type

Table 6-35 ocnef_qos_af_latency_seconds

Field Details
Description Latency for processing the messages received from AF
Type Timer
Dimension
  • method
  • status
  • type

Table 6-36 ocnef_qos_5g_latency_seconds

Field Details
Description Latency for processing messages received from Fivegc Agent.
Type Timer
Dimension
  • type
  • from
  • status

Table 6-37 ocnef_qos_srv_req_total

Field Details
Description Count of QoS requests sent from QoS service towards Fivegc Agent / AF
Type Counter
Dimension
  • destination
  • to
  • event

Table 6-38 ocnef_qos_srv_resp_total

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

Table 6-39 ocnef_qos_srv_latency_seconds

Field Details
Description Latency duration of a request and response
Type Timer
Dimension
  • method
  • destination

Table 6-40 ocnef_qos_db_latency_seconds

Field Details
Description Latency duration for a DB Query
Type Timer
Dimension
  • query

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.

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.

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

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

Table 6-45 ocnef_chf_qos_latency_seconds

Field Details
Description Latency for processing the messages received from AF.
Type Timer
Dimensions
  • method
  • direction
  • status

6.3.5 5GC Agent Service Metrics

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

Table 6-46 ocnef_5gc_agent_req_total

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

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

Table 6-47 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.

Table 6-48 ocnef_5gc_agent_latency_seconds

Field Details
Description Latency for processing messages at the Fivegc Agent service.
Type Timer
Dimension
  • method
  • status
  • from
  • to

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

Table 6-49 ocnef_5gc_agent_srv_req_total

Field Details
Description Count of messages transmitted by the Fivegc Agent service.
Type Counter
Dimension
  • commModel
  • to
  • destination

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

Table 6-50 ocnef_5gc_agent_srv_resp_total

Field Details
Description Count of responses received by the Fivegc Agent service.
Type Counter
Dimension
  • commModel
  • from
  • event

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

Table 6-51 ocnef_5gc_agent_srv_latency_seconds

Field Details
Description Latency for message received at the Fivegc Agent service.
Type Timer
Dimension
  • method
  • commModel
  • destination

Table 6-52 ocnef_translation_count_total

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

Table 6-53 ocnef_translation_failure_count_total

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

Table 6-54 ocnef_5gc_invalid_config

Field Details
Description The number of invalid configurations on 5GCAgent service.
Type gauge
Dimension message

6.3.6 Expiry Auditor Service Metrics

The following metrics are applicable to Expiry Auditor Service metrics.

Table 6-55 ocnef_exp_audit_expired_records_total

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

Note: The value of serviceId can be MonitoringEventSvc.

Table 6-56 ocnef_exp_audit_request_records_total

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

Note: The value of serviceId can be MonitoringEventSvc.

Table 6-57 ocnef_exp_audit_response_records_total

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

Note: The value of serviceId can be MonitoringEventSvc.

6.3.7 Traffic Influence Metrics

The following metrics are applicable to Traffic Influence metrics.

Table 6-58 ocnef_ti_af_req_total

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

Table 6-59 ocnef_ti_af_resp_total

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

Table 6-60 ocnef_ti_5g_req_total

Field Details
Description Count of notification requests received from Fivegc Agent.
Type Counter
Dimension
  • method
  • from
  • type

Table 6-61 ocnef_ti_5g_resp_total

Field Details
Description Count of responses sent to Fivegc Agent.
Type Counter
Dimension
  • method
  • status
  • type

Table 6-62 ocnef_ti_af_latency_seconds

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

Table 6-63 ocnef_ti_5g_latency_seconds

Field Details
Description Latency for processing messages received from Fivegc Agent.
Type Timer
Dimension
  • type
  • status
  • from

Table 6-64 ocnef_ti_srv_req_total

Field Details
Description Count of traffic influence requests sent from traffic_influence service towards Fivegc Agent / AF.
Type Counter
Dimension
  • event
  • to
  • destination

Table 6-65 ocnef_ti_srv_resp_total

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

Table 6-66 ocnef_ti_srv_latency_seconds

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

Table 6-67 ocnef_ti_db_latency_seconds

Field Details
Description Latency duration for a DB Query.
Type Timer
Dimension
  • query

6.3.8 Converged SCEF-NEF Metrics

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

Table 6-68 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-69 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-70 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-71 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-72 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-73 ocnef_dt_af_req_total

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

Table 6-74 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

Table 6-75 ocnef_dt_af_latency_seconds

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

Table 6-76 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

Table 6-77 ocnef_dt_srv_resp_total

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

Table 6-78 ocnef_dt_srv_latency_seconds

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

Table 6-79 ocnef_svc_dt_db_latency_seconds

Field Details
Description Latency duration for a DB Query.
Type Timer
Dimension query

Table 6-80 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
  • from

Table 6-81 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 status

Table 6-82 ocnef_dt_diamgw_notify_latency_seconds

Field Details
Description Latency duration of a request and response.
Type Timer
Dimension
  • type
  • from

6.3.10 MSISDNless MO SMS Metrics

The following metrics are applicable to MSISDNless MO SMS metrics.

Table 6-83 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

Table 6-84 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

Table 6-85 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

Table 6-86 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

Table 6-87 ocnef_msisdnless_mo_sms_srv_latency_seconds

Field Details
Description Latency duration of request and response. It typically generates a max gauge, and some counters (_sum, _count and the buckets).
Type Timer
Dimension
  • method
  • destination

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-88 occapif_apimgr_req_total

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

Table 6-89 occapif_apimgr_resp_total

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

6.4.2 AF Manager Metrics

The following metrics are applicable to AF Manager metrics.

Table 6-90 occapif_afmgr_req_total

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-91 occapif_afmgr_resp_total

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-92 occapif_eventmgr_subscription_req_total

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

Table 6-93 occapif_eventmgr_subscription_resp_total

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

Table 6-94 occapif_eventmgr_publish_req_total

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

Table 6-95 occapif_eventmgr_publish_resp_total

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

Table 6-96 occapif_eventmgr_notification_req_total

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

Table 6-97 occapif_eventmgr_notification_resp_total

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

6.5 Ingress Gateway Metrics

Ingress Gateway Metrics

Table 6-98 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-99 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
  • ClientCertIdentity

Table 6-100 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
  • Route_path
  • Method

Table 6-101 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
  • ErrorOriginator

Table 6-102 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
  • ErrorDetail
  • ErrorOriginator

Table 6-103 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
  • ErrorOriginator

Table 6-104 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
  • Route_Path
  • Method

Table 6-105 oc_ingressgateway_jetty_response_stat_metrics_total

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

Table 6-106 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
  • ServiceType
  • ErrorDetail

Table 6-107 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
  • ServiceType
  • ErrorDetail

Table 6-108 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
  • releaseVersion
  • configVersion

Table 6-109 oc_configclient_response_total

Field Details
Description This metrics is pegged whenever config client receives response from common configuration server.
Type Counter
Dimension
  • releaseVersion
  • configVersion
  • updated

Oauth Metrics

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

Table 6-110 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-111 oc_oauth_validation_failure _total

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

6.6 Egress Gateway Metrics

Egress Gateway Metrics

The following table describes the Egress Gateway Metrics.

Table 6-112 oc_egressgateway_http_requests_total

Field Details
Description This metric will be pegged as soon as the request reaches the Egress gateway in the first custom filter of the application with direction as egress.

This will also be pegged when the request goes out of egress in Jetty Request Listener with direction as egressOut.
Type Counter
Dimension
  • Method
  • NFType
  • NFServiceType
  • Host
  • HttpVersion
  • Scheme
  • Proxy
  • InstanceIdentifier
  • Direction
  • DestinationHost

Table 6-113 oc_egressgateway_http_responses_total

Field Details
Description

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.
Type Counter
Dimension
  • Status
  • Method
  • NFType
  • NFServiceType
  • Host
  • HttpVersion
  • Scheme
  • InstanceIdentifier
  • Direction
  • BlacklistedFqdn
  • DestinationHost
  • ErrorOriginator
  • jetty_request_timeout
  • error-reason

Table 6-114 oc_egressgateway_request_latency_seconds

Field Details
Description This metric will be 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 received back from the producer NF until first custom filter of the application during response processing.
Type Timer
Dimension
  • InstanceIdentifier
  • Route_path
  • Method

Table 6-115 oc_egressgateway_connection_failure_total

Field Details
Description This metric will be pegged by jetty client when the destination is not reachable by egress gateway. Here the destination is producer NF.
Type Counter
Dimension
  • Host
  • Port
  • InstanceIdentifier
  • Direction
  • error_reason
  • ErrorOriginator

Table 6-116 oc_egressgateway_notification_ratelimit_total

Field Details
Description This metric is pegged in the custom filter implemented to check the notification rate limit conditions.
Type Counter
Dimension
  • Method
  • Status
  • Scheme
  • ErrorDetail
  • InstanceIdentifier
  • ErrorOriginator

Table 6-117 oc_egressgateway_request_processing_latency_seconds

Field Details
Description This metric will be pegged in the last custom filter of the Egress gateway while the response is being 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 the request reaches the first custom filter of the application and lasts till the request is forwarded to the destination.
Type Timer
Dimension
  • InstanceIdentifier
  • Route_path
  • Method

Table 6-118 oc_egressgateway_jetty_request_stat_metrics_total

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

Table 6-119 oc_egressgateway_jetty_response_stat_metrics_total

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

Table 6-120 oc_egressgateway_server_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
  • Host
  • Method

Table 6-121 oc_egressgateway_roundtrip_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
  • Host
  • Method

Table 6-122 oc_egressgateway_request_content_metrics_total

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

Table 6-123 oc_egressgateway_blacklisted_producer_total

Field Details
Description This metric is a counter. Track number of times producer is blacklisted.
Type Counter
Dimension
  • NFType
  • NFServiceType
  • InstanceIdentifier
  • Host
  • Route_path

Table 6-124 oc_configclient_request_total

Field Details
Description This metric will be pegged whenever config client is polling for configuration update from common configuration server
Type Counter
Dimension
  • configVersion
  • releaseVersion

Table 6-125 oc_configclient_response_total

Field Details
Description This metric will be pegged whenever config client receives response from common configuration server
Type Counter
Dimension
  • configVersion
  • releaseVersion
  • updated

SBIRouting Metrics

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

Table 6-126 oc_egressgateway_sbiRouting_http_requests_total

Field Details
Description This metric is pegged in the ScpFilter only when SCP Integration is enabled.
Type Counter
Dimension
  • Sbi_Fqdn
  • Reroute_Path
  • Attempt
  • HttpVersion
  • Scheme
  • InstanceIdentifier

Table 6-127 oc_egressgateway_sbiRouting_http_responses_total

Field Details
Description 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.
Type Counter
Dimension
  • Sbi_Fqdn
  • Reroute_Path
  • Attempt
  • HttpVersion
  • Scheme
  • InstanceIdentifier
  • Status
  • ErrorOriginator