OCNRF Metrics
This section includes information about Metrics for Oracle Communications Network Repository Function.
Note:
Sample OCNRF dashboard for Grafana is delivered to the customer through OCNRF Custom Templates. Metrics and functions used to achieve KPI are already covered in OCNRF Custom Templates. Please view the Oracle Help Center site for the information about OCNRF Custom Templates.Dimensions Legend for the Metrics:
The following table includes the details about the metrics dimensions:
| Dimension | Details |
|---|---|
| NrfLevel |
OCNRF Deployment Name by which OCNRF can be identified nrfName can be configured during helm install using command line. |
| NfType | Types of Network Functions (NF) |
| NfInstanceId | Unique identity of the NF Instance |
| OriginatorNfType | NF which originating the request |
| HttpStatusCode | HTTP Status Code |
| ServiceName | Name of the service instance (e.g. "nudm-sdm") |
| ServiceInstanceId | Unique ID of the service instance within a given NF Instance |
| UpdateType(Partial/Complete) | NF Update with Put (Complete) or Patch (Partial) methods |
| OperationType | This dimension is for NFSubscribe Service operation to tell if the request is to create or update the subscription |
| NotificationEventType | This dimension will indicate subscription request is for which event types. For example:- NF_REGISTERED, NF_DEREGISTERED and NF_PROFILE_CHANGED |
| TargetNfType | This dimension will indicate request is for which target NF type |
| RequesterNfType | This dimension will indicate the NF type which originated the request |
| BucketSize |
This dimension will indicate how many profiles are returned in the response of Discovery request. Range is not configurable. Possible values are 0-10, +Inf. According to NF profiles returned, corresponding bucket will be incremented by one. For example, if 2 NF profiles are returned, then bucket 2 will be incremented by one. Profiles getting returned more than 10 will fall in +Inf bucket. |
Table 6-1 NRF Common Metrics
| Metric | Metric Details | Dimensions | Notes |
|---|---|---|---|
| envoy_http_ingress_http_rq_total | No of Requests | ||
| envoy_cluster_cluster_ocnrf_nfregistration_8080_upstream_rq_201 |
No of Registration Requests which results in success CREATED response. (NfRegister) |
||
| envoy_cluster_cluster_ocnrf_nfregistration_8080_upstream_rq_200 |
No of Registration Requests which results in success OK response. (NfUpdate/NfProfileRetrieval/NfListRetrieval/NfHeartbeat) |
||
| envoy_cluster_cluster_ocnrf_nfregistration_8080_upstream_rq_204 |
No of Registration Requests which results in success NO CONTENT response. (NfDelete/NfHeartbeat) |
NFDeregister and NFUpdate (heartbeat) are counted together | |
| envoy_cluster_cluster_ocnrf_nfsubscription_8080_upstream_rq_201 |
No of Subscription Requests which results in success CREATED response. (NfSubscribe) |
||
| envoy_cluster_cluster_ocnrf_nfsubscription_8080_upstream_rq_204 |
No of Subscription Requests which results in success NO CONTENT response. (NfUnsubscribe) |
||
| envoy_cluster_cluster_ocnrf_nfdiscovery_8080_upstream_rq_200 |
No of Discovery Requests which results in success OK response. (NfDiscover) |
||
| envoy_cluster_cluster_ocnrf_nfregistration_8080_upstream_rq_4xx |
No of Registration Requests which results in Error Response of category 4xx. (NfRegister/NfUpdate/NfDelete/NfProfileRetrieval/NfListRetrieval) |
||
| envoy_cluster_cluster_ocnrf_nfsubscription_8080_upstream_rq_4xx |
No of Subscription Requests which results in Error Response of category 4xx. (NfSubscribe/NfUnsubscribe) |
||
| envoy_cluster_cluster_ocnrf_nfdiscovery_8080_upstream_rq_4xx |
No of Discovery Requests which results in Error Response of category 4xx. (NfDiscover) |
||
| envoy_cluster_cluster_ocnrf_nfregistration_8080_upstream_rq_5xx |
No of Registration Requests which results in Error Response of category 5xx. (NfRegister/NfUpdate/NfDelete/NfProfileRetrieval/NfListRetrieval) |
||
| envoy_cluster_cluster_ocnrf_nfsubscription_8080_upstream_rq_5xx |
No of Subscription Requests which results in Error Response of category 5xx. (NfSubscribe/NfUnsubscribe) |
||
| envoy_cluster_cluster_ocnrf_nfdiscovery_8080_upstream_rq_5xx |
No of Discovery Requests which results in Error Response of category 5xx. (NfDiscover) |
||
| ocnrf_nfRegister_rx_requests_total | Number of Registration Requests received. |
NrfLevel NfInstanceId OriginatorNfType |
|
| ocnrf_nfRegister_tx_responses_total | Number of Registration Responses sent. |
NrfLevel NfInstanceId OriginatorNfType HttpStatusCode |
|
| ocnrf_nfRegister_rx_requests_success_perService_total |
Number of Registrations received and processed successfully per Service. |
NrfLevel NfInstanceId ServiceName ServiceInstanceId |
|
| ocnrf_nfUpdate_rx_requests_total | Number of Update Requests received. |
NrfLevel NfInstanceId OriginatorNfType UpdateType(Partial/Complete) |
|
| ocnrf_nfUpdate_tx_responses_total | Number of Update Responses sent. |
NrfLevel NfInstanceId OriginatorNfType UpdateType(Partial/Complete) HttpStatusCode |
|
| ocnrf_nfUpdate_rx_requests_success_perService_total | Number of NfUpdates received and processed successfully per Service. |
NrfLevel, Updatetype =(Partial/Complete), NfInstanceId, ServiceName, ServiceInstanceId |
|
| ocnrf_nfHeartbeat_rx_requests_total | Number of Heartbeat Requests received |
NrfLevel NfInstanceId OriginatorNfType |
|
| ocnrf_nfHeartbeat_tx_responses_total | Number of Heartbeat Responses sent |
Nrflevel, NfInstanceId, OriginatorNfType, HttpStatusCode |
|
| ocnrf_nfDeregister_rx_requests_total | Number of Deregistration requests received |
NrfLevel, NfInstanceId, OriginatorNfType |
|
| ocnrf_nfDeregister_tx_responses_total | Number of Deregistration responses sent |
NrfLevel, NfInstanceId, OriginatorNfType, HttpStatusCode |
|
| ocnrf_nfDeregister_rx_requests_success_perService_total | Number of Deregistrations requests received and process successfully per Service |
NrfLevel, ServiceName, ServiceInstanceId, NfInstanceId |
|
| ocnrf_nfListRetrieval_rx_requests_total | Number of nfListRetrieval requests received |
NrfLevel, OriginatorNfType |
|
| ocnrf_nfListRetrieval_tx_responses_total | Number of nfListRetrieval responses sent |
NrfLevel, OriginatorNfType, HttpStatusCode |
|
| ocnrf_nfProfileRetrieval_rx_requests_total | Number of nfProfileRetrieval requests received |
NrfLevel, NfInstanceId |
|
| ocnrf_nfProfileRetrieval_tx_responses_total | Number of nfProfileRetrieval responses sent |
NrfLevel, NfInstanceId, HttpStatusCode |
|
| ocnrf_heartbeat_missed_total | Number of heartbeats missed. |
NrfLevel, NfType, NfInstanceId |
|
| ocnrf_nfStatusSubscribe_rx_requests_total |
Number of NStatusfSubscribe requests received ocnrf_nfStatusSubscribe_rx_requests_total |
NrfLevel, OriginatorNfType |
|
| ocnrf_nfStatusSubscribe_tx_responses_total | Number of NfStatusSubscribe responses sent |
NrfLevel, OriginatorNfType, HttpStatusCode |
|
| ocnrf_nfStatusUnsubscribe_rx_requests_total | Number of NfStatusUnsubscribe requests received |
NrfLevel, OriginatorNfType |
|
| ocnrf_nfStatusUnsubscribe_tx_responses_total | Number of NfStatusUnsubscribe responses sent |
NrfLevel, OriginatorNfType, HttpStatusCode |
|
| ocnrf_nfStatusNotify_tx_requests_total | Number of NfStatusNotify requests sent |
NrfLevel, NotificationEventType, TargetNfType |
|
| ocnrf_nfStatusNotify_rx_responses_total | Number of NfStatusNotify responses received |
NrfLevel, NotificationEventType, TargetNfType, HttpStatusCode |
|
| ocnrf_nfDiscover_rx_requests_total | Number of NfDiscover Requests received |
NrfLevel, TargetNfType, RequesterNfType |
|
| ocnrf_nfDiscover_tx_responses_total | Number of NfDiscover responses sent |
NrfLevel, TargetNfType, RequesterNfType, HttpResponseCode |
|
| ocnrf_nfDiscover_rx_requests_success_perService_total | Number of NfDiscover requests received and processed successfully per Service |
NrfLevel, RequesterNfType, ServiceName |
|
| ocnrf_nfDiscover_profiles_discovered_count_total | Number of Profiles returned in discovery response |
NrfLevel, TargetNfType, BucketSize |
|
| ocnrf_active_registrations_count | Number of active registered NFs at any point of time |
NfType, NrfLevel |
|
| ocnrf_message_processing_time_seconds |
Time taken by NRF to process messages (NfRegister/NfUpdate/NfDelete/fProfileRetrieval/NfListRetrieval/NfHeartbeat/NfDiscover/NfSubscribe/NfUnsubscribe) |
NrfLevel, OriginatorNfType, ServiceOperation |
Latency calculated by this metric doesn't include time taken by OCNRF API gateway |
In the above NRF Metrics table, 4xx and 5xx are the error codes in REST API. For the details about the error codes, refer to 4xx and 5xx Error Codes
Table 6-2 NF Screening specific metrics
| Metric | Metric Details | Service Operation | Dimensions |
|---|---|---|---|
| ocnrf_nfScreening_callbackUri_requestFailed_total | The total number of requests for which screening failed against Callback URI screening list. | NFRegister, NFUpdate |
NRF level NF type |
| ocnrf_nfScreening_callbackUri_requestRejected_total | The total number of requests rejected because screening failed against Callback URI screening list. | NFRegister, NFUpdate |
NRF level NF type |
| ocnrf_nfScreening_nfFqdn_requestFailed_total | The total number of requests for which screening failed against NF FQDN screening list. | NFRegister, NFUpdate |
NRF level NF type |
| ocnrf_nfScreening_nfFqdn_requestRejected_total | The total number of requests rejected because screening failed against NF FQDN screening list. | NFRegister, NFUpdate |
NRF level NF type |
| ocnrf_nfScreening_nfIpEndPoint_requestFailed_total | The total number of requests for which screening failed against NF IP endpoint screening list. | NFRegister, NFUpdate, NFSubscribe |
NRF level NF type |
| ocnrf_nfScreening_nfIpEndPoint_requestRejected_total | The total number of requests rejected because screening failed against NF IP endpoint screening list. | NFRegister, NFUpdate, NFSubscribe |
NRF level NF type |
| ocnrf_nfScreening_nfTypeRegister_requestFailed_total | The total number of NFRegister requests rejected as NF type was not allowed to register with NRF. | NFRegister, NFUpdate |
NRF level NF type |
| ocnrf_nfScreening_nfTypeRegister_requestRejected_total | The total number of NFRegister requests for which screening failed against NF type screening list. | NFRegister, NFUpdate |
NRF level NF type |
| ocnrf_nfScreening_notApplied_InternalError_total | The total number of times screening not applied due to internal error. | NFRegister |
NRF level NF type |
| ocnrf_nfScreening_plmnId_requestFailed_total | The total number of requests for which screening failed against PLMN id screening list. | NFRegister |
NRF level NF type |
| ocnrf_nfScreening_plmnId_requestRejected_total | The total number of requests rejected because screening failed against PLMN id screening list. | NFRegister, NFUpdate, NFSubscribe |
NRF level NF type |
Note:
In the above NF Screening metrics table, the dimension NF Type is a requester NF Type.
