6 Metrics
This section provides information about the Metrics for Oracle Communications Unified Data Repository (OCUDR).
Note:
- A sample Grafana json is available in the UDR Customer Documentation on Oracle Help Center. You can download and import the file to your repository. http://docs.oracle.com/en/industries/communications/cloud-native-core/release21.html
Table 6-1 Metric Type
| Metric Type | Description |
|---|---|
| Counter | Represents the total number of occurrences of an event or traffic, such as
measuring the total amount of traffic received and transmitted by UDR.
Prometheus automatically appends the words, such as total to all the counter type metrics that are displayed on the Prometheus dashboard. |
| Gauge | Represents a single numerical value that changes randomly. This metric type is used to measure various parameters, such as UDR load values, memory usage, and so on. |
| Histogram | Represents the number of occurrences that fall into predefined intervals,
or buckets, such as those used for measuring response times.
Prometheus automatically appends the words, such as bucket, count, and sum to all the histogram metrics that are displayed on the Prometheus dashboard. |
6.1 Common Metrics
Table 6-2 security_cert_x509_expiration_seconds
| Field | Details |
|---|---|
| Metric Name | security_cert_x509_expiration_seconds |
| Description | Indicates the time to certificate expiry in epoch seconds. |
| Type | Histogram |
| Dimensions | serialNumber |
Table 6-3 oc_certificatemanagement_tls_certificate_info
| Field | Details |
|---|---|
| Metric Name | oc_certificatemanagement_tls_certificate_info |
| Description | The gauge metric sets the status to 1 if any of the configured files fail to load. The file name and reason are listed in the metric dimensions. When the secret is loaded successfully, the status changes to 0. If a certificate loads without issues, Prometheus does not create an entry, or the previous entry value changes to 0. |
| Type | GAUGE |
| Dimensions |
|
Table 6-4 oc_certificatemanagement_tls_secret_status
| Field | Details |
|---|---|
| Metric Name | oc_certificatemanagement_tls_secret_status |
| Description | The gauge metric shows whether the configured secret is available in the namespace. If the secret is available, the metric value is 0. If the secret is not available, the metric value is 1. |
| Type | GAUGE |
| Dimensions |
|
Table 6-5 oc_certificatemanagement_tls_certs_reload_failure
| Field | Details |
|---|---|
| Metric Name | oc_certificatemanagement_tls_certs_reload_failure |
| Description | The gauge metric indicates if an exception occurs during certificate reload, such as a failure to create a keystore. If there is an error, the metric value is 1. If the reload is successful, the metric value is 0. |
| Type | GAUGE |
| Dimensions | NA |
Table 6-6 cgiu_jetty_ip_address_fetch_failure
| Field | Details |
|---|---|
| Metric Name | cgiu_jetty_ip_address_fetch_failure |
| Description | This metric reports when an exception occurs while fetching service IP addresses from the Kubernetes API server. |
| Type | COUNTER |
| Dimensions | NA |
Table 6-7 udr_service_congestion_system_state
| Field | Details |
|---|---|
| Metric Name | udr_service_congestion_system_state |
| Type | Gauge |
| Description | This metric provides the information of congestion level per pod. |
| Dimensions | NA |
Table 6-8 udr_service_congestion_cpu_state
| Field | Details |
|---|---|
| Metric Name | udr_service_congestion_cpu_state |
| Type | Gauge |
| Description | This metric records the CPU levels of the congestion state. |
| Dimensions | NA |
Table 6-9 udr_service_http_request_ratelimit_values_total
| Field | Details |
|---|---|
| Metric Name | udr_service_http_request_ratelimit_values_total |
| Type | Counter |
| Description | This metric counts the allowed or rejected messages
based on rate limiting configuration.
If there is no route configuration for the dropped message, the id attribute contains "NA". The "id" is set to "nomatch" for routes that do not match any routes. |
| Dimensions |
|
Table 6-10 udr_service_http_request_ratelimit_exceed_count_total
| Field | Details |
|---|---|
| Metric Name | udr_service_http_request_ratelimit_exceed_count_total |
| Type | Counter |
| Description | This metric records the details of the denied request. |
| Dimensions |
|
Table 6-11 udr_service_system_state_duration_percentage
| Field | Details |
|---|---|
| Metric Name | udr_service_system_state_duration_percentage |
| Type | Gauge |
| Description | This metric records the percentage of time the system was in a particular congestion level. |
| Dimensions | NA |
Table 6-12 udr_service_congestion_level_total
| Field | Details |
|---|---|
| Metric Name | udr_service_congestion_level_total |
| Type | Counter |
| Description | Counts the number of times a congestion level was identified. This congestion level value varies between 0-10. |
| Dimensions | NA |
Table 6-13 udr_service_congestion_level_bucket_total
| Field | Details |
|---|---|
| Metric Name | udr_service_congestion_level_bucket_total |
| Type | Histogram |
| Description | Identifies the number of times the congestion level was observed. |
| Dimensions | NA |
Table 6-14 udr_service_congestion_cpu_percentage_bucket
| Field | Details |
|---|---|
| Metric Name | udr_service_congestion_cpu_percentage_bucket |
| Type | Histogram |
| Description | This metric records the CPU percentage. |
| Dimensions | NA |
6.2 UDR Gateways Metrics
This section provides details about the Gateway metrics of UDR.
6.2.1 Ingress Gateway Metrics
The following metrics are applicable to Ingress API Gateway.
Table 6-15 Total Ingress Requests
| Field | Details |
|---|---|
| Metric Name | oc_ingressgateway_http_requests_total{Method="POST/PUT/GET/DELETE/PATCH", Scheme="HTTP/HTTPS",container="ingressgateway-sig"} |
| Description | This metric is pegged as soon as the request reaches the Ingress gateway in the first custom filter of the application. |
| Type | Counter |
| Dimensions |
Method NFType NFServiceType Host HttpVersion Scheme |
Table 6-16 Total Ingress Responses
| Field | Details |
|---|---|
| Metric Name | oc_ingressgateway_http_responses_total{Method="POST/PUT/GET/DELETE/PATCH", Status=~"2.*/4.*/5.*",container="ingressgateway-sig"} |
| Description | Total number of HTTP responses sent from Ingress Gateway. |
| Type | Counter |
| Dimensions |
Status Method NFType NFServiceType Host HttpVersion Scheme |
Table 6-17 Avg Latency
| Field | Details |
|---|---|
| Metric Name | oc_ingressgateway_request_latency_seconds{container="ingressgateway-sig"} |
| Description | Time (in microseconds) to process an ingress request. Measured when the request is received and the response is sent. |
| Type | Timer |
| Dimensions |
quantile InstanceIdentifier |
Table 6-18 Connection Failures Ingress Gateway
| Field | Details |
|---|---|
| Metric Name | oc_ingressgateway_connection_failure_total{container="ingressgateway-sig"} |
| Description | Metric to capture the connection failures when connect
to the destination service fails. 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. |
| Type | Counter |
| Dimensions |
Host Port InstanceIdentifier error_reason |
Table 6-19 Ingress Gateway Request Processing Latency
| Field | Details |
|---|---|
| Metric Name | oc_ingressgateway_request_processing_latency_seconds{container="ingressgateway-sig"} |
| Description | Metric to capture the amount of time taken for processing of the request only within Ingress Gateway. |
| Type | Timer |
| Dimensions |
quantile InstanceIdentifier |
Table 6-20 User-Agent Successful validation
| Field | Details |
|---|---|
| Metric Name | oc_ingressgateway_user_agent_consumerNfType_success_count |
| Description | This metric is pegged for every incoming request when the feature is enabled and validation is successful. |
| Type | Counter |
| Dimensions |
id - id of the route consumerNfType - consumer NF type obtained from the User-Agent header in the incoming request |
Table 6-21 User-Agent Failure validation
| Field | Details |
|---|---|
| Metric Name | oc_ingressgateway_user_agent_consumerNfType_failure_count |
| Description | For every incoming request when the feature is enabled and user agent validation fails because of mismatch in the value configured and the value present in the incoming request. |
| Type | Counter |
| Dimensions |
id - id of the route consumerNfType - consumer NF Type obtained from the User-Agent header in the incoming request. |
Table 6-22 User-Agent Invalid Config
| Field | Details |
|---|---|
| Metric Name | oc_ingressgateway_useragent_invalid_config |
| Description | If the user agent configuration is invalid that is if the consumerNFType list is empty, then it is applicable only for HELM based configuration. |
| Type | Gauge |
| Dimensions | NA |
Table 6-23 User-Agent Invalid Config
| Field | Details |
|---|---|
| Metric Name | oc_ingressgateway_sbitimer_timezone_mismatch |
| Description | This metric is pegged when sbiTimerTimezone is set to ANY and the timezone is not specified in the header, then the above metric is pegged in ingress and egress gateway. |
| Type | Gauge |
| Dimensions | NA |
Table 6-24 Ingress Gateway Pod Congestion State
| Field | Details |
|---|---|
| Metric Name | oc_ingressgateway_pod_congestion_state{namespace='$namespace'} |
| Description | Tracks the overall congestion state per ingress gateway pod. |
| Type | Counter |
| Dimensions | NA |
Table 6-25 Ingress Gateway Pod Resource State
| Field | Details |
|---|---|
| Metric Name | oc_ingressgateway_pod_resource_state{type="CPU/PENDING_REQUEST",namespace='$namespace'} |
| Description | Tracks the resource congestion state per ingress gateway pod. |
| Type | Counter |
| Dimensions | NA |
Table 6-26 Ingress Gateway Pod Connections Rejected
| Field | Details |
|---|---|
| Metric Name | oc_ingressgateway_incoming_pod_connections_rejected_total{namespace="$namespace"} |
| Description | Tracks the resource usage per Ingress Gateway pod. |
| Type | Counter |
| Dimensions | NA |
Table 6-27 Ingress Gateway Pod Incoming Connection Rejections
| Field | Details |
|---|---|
| Metric Name | oc_ingressgateway_incoming_pod_connections_rejected_total{namespace="$namespace"} |
| Description | Tracks the incoming rejected connections. |
| Type | Counter |
| Dimensions | NA |
Table 6-28 Total Ingress Requests
| Field | Details |
|---|---|
| Metric Name | oc_ingressgateway_http_requests_total{Method="POST/PUT/GET/DELETE/PATCH", Scheme="HTTP/HTTPS",container="ingressgateway-prov"} |
| Description | Total number of requests received by ingress gateway. |
| Type | Counter |
| Dimensions |
Method NFType NFServiceType Host HttpVersion Scheme |
Table 6-29 Total Ingress Responses
| Field | Details |
|---|---|
| Metric Name | oc_ingressgateway_http_responses_total{Method="POST/PUT/GET/DELETE/PATCH", Status=~"2.*/4.*/5.*",container="ingressgateway-prov"} |
| Description | Total number of requests received by ingress gateway. |
| Type | Counter |
| Dimensions |
Status Method NFType NFServiceType Host HttpVersion Scheme |
Table 6-30 Avg Latency
| Field | Details |
|---|---|
| Metric Name | oc_ingressgateway_request_latency_seconds{container="ingressgateway-prov"} |
| Description | Time (in microseconds) to process an ingress request. Measured when the request is received and the response is sent |
| Type | Timer |
| Dimensions |
quantile InstanceIdentifier |
Table 6-31 Connection Failures Ingress Gateway
| Field | Details |
|---|---|
| Metric Name | oc_ingressgateway_connection_failure_total{container="ingressgateway-prov"} |
| Description | Metric to capture the connection failures when the
connect to the destination service fails. In case of Ingress Gateway,
the destination service is a backend microservice of the NF.
TLS connection failure metrics when connecting to ingress. |
| Type | Counter |
| Dimensions |
Host Port InstanceIdentifier error_reason |
Table 6-32 Ingress Gateway Request Processing Latency
| Field | Details |
|---|---|
| Metric Name | oc_ingressgateway_request_processing_latency_seconds{container="ingressgateway-prov"} |
| Description | Metric to capture the amount of time taken for processing the request only within Ingress Gateway |
| Type | Timer |
| Dimensions |
quantile InstanceIdentifier |
Table 6-33 Ingress Gateway Pod Resource Stress
| Field | Details |
|---|---|
| Metric Name | oc_ingressgateway_pod_resource_stress{type="CPU/PENDING_REQUEST",namespace='$namespace'} |
| Description | Tracks the resource usage per Ingress Gateway pod. |
| Type | Counter |
| Dimensions | NA |
Table 6-34 oc_ingressgateway_incoming_tls_connections
| Field | Details |
|---|---|
| Metric Name | oc_ingressgateway_incoming_pod_connections_rejected_total{namespace="$namespace"} |
| Description | Number of TLS connections received on the Ingress Gateway and their negotiated TLS versions. The versions can be TLSv1.3 or TLSv1.2 |
| Type | Gauge |
| Dimensions | NegotiatedTLSVersion, Host, Direction, InstanceIdentifier |
Table 6-35 oc_ingressgateway_backend_invocation_latency_seconds
| Field | Details |
|---|---|
| Metric Name | oc_ingressgateway_backend_invocation_latency_seconds |
| Description | This metric captures the amount of time taken by the backend in providing response to the gateway. It starts when the request leaves the last custom filter of the application and lasts till the response reaches the custom filter of the application. |
| Dimensions |
|
Table 6-36 oc_ingressgateway_response_processing_latency_seconds
| Field | Details |
|---|---|
| Metric Name | oc_ingressgateway_response_processing_latency_seconds |
| Description | This metric captures the amount of time taken for processing of the response only within Ingress gateway. It starts when the response reaches the custom filter of the application and lasts till the response is sent back to the customer. |
| Dimensions |
|
Table 6-37 oc_ingressgateway_request_processing_latency_seconds
| Field | Details |
|---|---|
| Metric Name | oc_ingressgateway_request_processing_latency_seconds |
| Description | This metric tracks time between request received at first filter of SCG to request sent out from last filter of SCG. |
| Dimensions |
|
Table 6-38 oc_ingressgateway_congestion_system_state
| Field | Details |
|---|---|
| Metric Name | oc_ingressgateway_congestion_system_state |
| Type | Gauge |
| Description | This metric provides the information of congestion level per pod. |
| Dimensions | NA |
Table 6-39 oc_ingressgateway_congestion_cpu_state
| Field | Details |
|---|---|
| Metric Name | oc_ingressgateway_congestion_cpu_state |
| Type | Gauge |
| Description | Records the CPU levels of the congestion state. |
| Dimensions | NA |
Table 6-40 oc_ingressgateway_http_request_ratelimit_values_total
| Field | Details |
|---|---|
| Metric Name | oc_ingressgateway_http_request_ratelimit_values_total |
| Type | Counter |
| Description | This metric counts the dropped messages based on rate
limiting configuration.
If there is no route configuration for the dropped message, the id attribute contains "NA". The "id" is set to "nomatch" for routes that do not match any routes. |
| Dimensions |
|
Table 6-41 oc_ingressgateway_http_request_ratelimit_reject_chain_duration_histogram
| Field | Details |
|---|---|
| Metric Name | oc_ingressgateway_http_request_ratelimit_reject_chain_duration_histogram |
| Type | Histogram |
| Description | Records the reject chain duration. |
| Dimensions | NA |
Table 6-42 oc_ingressgateway_http_request_ratelimit_reject_chain_length_histogram
| Field | Details |
|---|---|
| Metric Name | oc_ingressgateway_http_request_ratelimit_reject_chain_length_histogram |
| Type | Histogram |
| Description | This metric records the number of consecutive requests rejected before a successful acceptance and adds it to the corresponding bucket. This metric provides the number of failed requests due to bursty traffic. |
| Dimensions | NA |
Table 6-43 oc_ingressgateway_http_request_ratelimit_denied_count_total
| Field | Details |
|---|---|
| Metric Name | oc_ingressgateway_http_request_ratelimit_denied_count |
| Type | Counter |
| Description | Records the details of the denied request. |
| Dimensions |
|
Table 6-44 oc_ingressgateway_system_state_duration_percentage
| Field | Details |
|---|---|
| Metric Name | oc_ingressgateway_system_state_duration_percentage |
| Type | Gauge |
| Description | Records the percentage of time the system was in a particular congestion level. |
| Dimensions | NA |
Table 6-45 oc_ingressgateway_congestion_level_total
| Field | Details |
|---|---|
| Metric Name | oc_ingressgateway_congestion_level_total |
| Type | Counter |
| Description | Counts the number of times a congestion level was identified. This congestion level value varies between 0-10. |
| Dimensions | NA |
Table 6-46 oc_ingressgateway_congestion_level_bucket_total
| Field | Details |
|---|---|
| Metric Name | oc_ingressgateway_congestion_level_bucket_total |
| Type | Histogram |
| Description | Identifies the number of times the congestion level was observed. |
| Dimensions | NA |
Table 6-47 oc_ingressgateway_congestion_cpu_percentage_bucket
| Field | Details |
|---|---|
| Metric Name | oc_ingressgateway_congestion_cpu_percentage_bucket |
| Type | Histogram |
| Description | Records the CPU percentage. |
| Dimensions | NA |
Table 6-48 oc_oauth_validation_successful_total
| Field | Details |
|---|---|
| Metric Name | oc_oauth_validation_successful_total |
| Type | Counter |
| Description | This metric is pegged in the OAuth validator in the Ingress Gateway if the received OAuth token is validated successfully. |
| Dimensions |
|
Table 6-49 oc_oauth_validation_failure_total
| Field | Details |
|---|---|
| Metric Name | oc_oauth_validation_failure_total |
| Type | Counter |
| Description | This metric will be pegged in the OAuth validator in Ingress Gateway if the validation of the received OAuth token is failed. |
| Dimensions |
|
Table 6-50 oc_oauth_certificate_expiryStatus
| Field | Details |
|---|---|
| Metric Name | oc_oauth_certificate_expiryStatus |
| Type | Gauge |
| Description | This metric is used to peg expiry date of the certificate and for raising alarms if the certificate expires within 7 or 30 days. |
| Dimensions |
|
Table 6-51 oc_oauth_certificate_loadStatus
| Field | Details |
|---|---|
| Metric Name | oc_oauth_certificate_loadStatus |
| Type | Gauge |
| Description | This metric is used to peg whether the given certificate can be loaded from secret or not. If the certificate can be loaded then 0 is pegged otherwise 1 is pegged. This metric is also used for raising alarms when certificate cannot be loaded. |
| Dimensions |
|
Table 6-52 oc_oauth_request_failed_cert_expiry
| Field | Details |
|---|---|
| Metric Name | oc_oauth_request_failed_cert_expiry |
| Type | Counter |
| Description | This metric is used to keep track of the number of
requests with keyId in the token that failed due to
certificate expiry. It is pegged when OAuth validator module throws an
OAuth custom exception due to certificate expiry for an incoming
request.
|
| Dimensions |
|
Table 6-53 oc_oauth_keyid_count
| Field | Details |
|---|---|
| Metric Name | oc_oauth_keyid_count |
| Type | Counter |
| Description | This metric is used to keep track of the number of
requests received with keyId in the token. This metric
is pegged when a request with an access token containing
keyId in the header comes to OAuth validator and
the validation is successful.
|
| Dimensions |
|
Table 6-54 oc_ingressgateway_ip_addresses_fetch_failure
| Field | Details |
|---|---|
| Metric Name | oc_ingressgateway_ip_addresses_fetch_failure |
| Type | Counter |
| Description | This metric counts the number of failures that occur when retrieving service IP addresses from the Kubernetes API server in the Ingress Gateway microservice. |
| Dimensions | NA |
6.2.2 Egress API Gateway Metrics
The following metrics are applicable to Egress API Gateway.
Table 6-55 Total Egress Requests
| Field | Details |
|---|---|
| Metric Name | oc_ingressgateway_http_requests_total{Method="POST/PUT/GET/DELETE/PATCH", Scheme="HTTP/HTTPS",container="ingressgateway-sig"} |
| Description | oc_egressgateway_http_requests_total
Metric to capture the request count reaches the Egress gateway from the application microservice and pegs with Direction as egress. Also, when the request goes out of egress gateway and pegs with Direction as egressOut. |
| Type | Counter |
| Dimensions |
Method NFType NFServiceType Host HttpVersion Scheme |
Table 6-56 Total Egress Responses
| Field | Details |
|---|---|
| Metric Name | oc_egressgateway_http_responses_total{Method="POST/PUT/GET/DELETE",Status=~"2.*/4.*"} |
| Description | Metric to capture when Egress Gateway sends response
back to backend NF microservice and pegs with Direction as egress.
Also, when the response is received Egress Gateway and pegs with Direction as egressOut. |
| Type | Counter |
| Dimensions |
Status Method NFType NFServiceType Host HttpVersion Scheme |
Table 6-57 Connection Failures Egress Gateway
| Field | Details |
|---|---|
| Metric Name | oc_egressgateway_connection_failure_total |
| Description | Metric to capture failure when the destination is not reachable by Egress Gateway. Here, the destination is producer NF. |
| Type | Counter |
| Dimensions |
Host Port InstanceIdentifier Direction error_reason |
Table 6-58 Egress Gateway Request Processing Latency
| Field | Details |
|---|---|
| Metric Name | oc_egressgateway_request_processing_latency_seconds |
| Description | Metric to capture the amount of time taken for processing of the request only within Egress gateway |
| Type | Timer |
| Dimensions |
quantile InstanceIdentifier |
Table 6-59 Egress Gateway Request Processing Latency
| Field | Details |
|---|---|
| Metric Name | oc_egressgateway_routing_invalid_config_detected |
| Description | Metric to indicate whether the filter configuration done for a specific route is valid or not. This covers all filters including SBI filter and increments if any misconfiguration is found related to any configured filter. |
| Type | Timer |
| Dimensions | Not Applicable |
Table 6-60 oc_egressgateway_outgoing_tls_connections
| Field | Details |
|---|---|
| Description | Number of TLS connections received on the Egress Gateway and their negotiated TLS versions. The versions can be TLSv1.3 or TLSv1.2 |
| Type | Gauge |
| Dimensions | NegotiatedTLSVersion, Host, Direction, InstanceIdentifier |
Table 6-61 oc_egressgateway_ip_addresses_fetch_failure
| Field | Details |
|---|---|
| Metric Name | oc_egressgateway_ip_addresses_fetch_failure |
| Type | Counter |
| Description | This metric counts the number of failures that occur when retrieving service IP addresses from the Kubernetes API server in the Egress Gateway microservice. |
| Dimensions | NA |
6.3 nudr-dr-service Metrics
The following metrics are applicable to the nudr-dr service of UDR.
Table 6-62 SLF default GroupId
| Field | Details |
|---|---|
| Metric Name | slf_sucess_txn_default_grp_id |
| Description | The number of requests for which the SLF reponds with default GroupId for Lookup |
| Type | Counter |
| Dimensions | Not Applicable |
Table 6-63 EIR Default Response
| Field | Details |
|---|---|
| Metric Name | eir_txn_default_response_sent |
| Description | The number of EIR EIC responses using default response |
| Type | Counter |
| Dimensions | Interface |
Table 6-64 UDR Total Requests
| Field | Details |
|---|---|
| Metric Name | udr_rest_all_requests_total |
| Description | Total number of requests received by nudr-drservice (All UDR operations). |
| Type | Counter |
| Dimensions | sbi_correlation_header(yes/no) key(imsi/msisdn/nai/extid/accountid) |
Table 6-65 UDR Total Responses
| Field | Details |
|---|---|
| Metric Name | udr_rest_all_response_total |
| Description | Total number of responses sent by nudr-drservice (All UDR operations). |
| Type | Counter |
| Dimensions | sbi_correlation_header(yes/no) key(imsi/msisdn/nai/extid/accountid) status(failure/success) |
Table 6-66 UDR Total Success Responses
| Field | Details |
|---|---|
| Metric Name | udr_rest_success_response_total |
| Description | Total number of success responses sent by nudr-drservice (All UDR operations). |
| Type | Counter |
| Dimensions | Not Applicable |
Table 6-67 UDR Total Failure Responses
| Field | Details |
|---|---|
| Metric Name | udr_rest_failure_response_total |
| Description | Total number of failure responses sent by nudr-drservice (All UDR operations). |
| Type | Counter |
| Dimensions | Not Applicable |
Table 6-68 UDR Put Requests
| Field | Details |
|---|---|
| Metric Name | udr_rest_request_total{Method="PUT/PATCH/GET/DELETE/POST"} |
| Description | Total number of PUT requests received by nudr-drservice (UDR related). |
| Type | Counter |
| Dimensions |
Method sbi_correlation_header key status |
Table 6-69 UDR Put Success Responses
| Field | Details |
|---|---|
| Metric Name | udr_rest_response_success_total{Method="PUT"} |
| Description | Total number of PUT success responses sent by nudr-drservice (UDR related). |
| Type | Counter |
| Dimensions |
Method |
Table 6-70 UDR Patch Success Responses
| Field | Details |
|---|---|
| Metric Name | udr_rest_response_success_total{Method="PATCH/GET/DELETE/POST"} |
| Description | Total number of PATCH success responses sent by nudr-drservice (UDR related). |
| Type | Counter |
| Dimensions |
Method |
Table 6-71 UDR Patch Failure Responses
| Field | Details |
|---|---|
| Metric Name | udr_rest_response_failure_total{Method="PATCH/GET/DELETE/POST"} |
| Description | Total number of PATCH failure responses sent by nudr-drservice (UDR related). |
| Type | Counter |
| Dimensions |
Method |
Table 6-72 UDR Schema Validation Success
| Field | Details |
|---|---|
| Metric Name | udr_schema_validation_success_total |
| Description | Total success count of schema validations done for all operations with body. |
| Type | Counter |
| Dimensions |
Not Applicable |
Table 6-73 UDR Schema Validation Failure
| Field | Details |
|---|---|
| Metric Name | udr_schema_validation_failure_total |
| Description | Total failure count of schema validations done for all operations with body. |
| Type | Counter |
| Dimensions |
Not Applicable |
Table 6-74 Db Operations Total
| Field | Details |
|---|---|
| Metric Name | udr_db_operations_total{Method="READ/UPDATE"} |
| Description | Total number of database reads and writes performed by nudr-dr-provservice on the back end NDB Cluster. |
| Type | Counter |
| Dimensions |
Method |
Table 6-75 Db Operations Success
| Field | Details |
|---|---|
| Metric Name | udr_db_operations_success_total{Method="READ/UPDATE"} |
| Description | Total number of successful DB reads performed by nudr-drservice on the back end NDB Cluster. |
| Type | Counter |
| Dimensions |
Method |
Table 6-76 Db Operations Failure
| Field | Details |
|---|---|
| Metric Name | udr_db_operations_failure_total{Method="READ/UPDATE"} |
| Description | Total number of failed DB reads performed by nudr-drservice on the back end NDB Cluster. |
| Type | Counter |
| Dimensions |
Method |
Table 6-77 Db Total Txn Attempted
| Field | Details |
|---|---|
| Metric Name | udr_total_transactions_total |
| Description | Total number of successful DB transactions (includes all DB operations) performed by nudr-drservice on the back end NDB Cluster. |
| Type | Counter |
| Dimensions |
Not Applicable |
Table 6-78 DB Txn Success
| Field | Details |
|---|---|
| Metric Name | udr_successful_transactions_total |
| Description | Total number of failed DB transactions (includes all DB operations) performed by nudr-drservice on the back end NDB Cluster. |
| Type | Counter |
| Dimensions |
Not Applicable |
Table 6-79 UDSF Total Requests
| Field | Details |
|---|---|
| Metric Name | udsf_rest_all_requests_total |
| Description | Total number of requests received by nudr-drservice (All UDSF operations). |
| Type | Counter |
| Dimensions |
Not Applicable |
Table 6-80 UDSF Total Response
| Field | Details |
|---|---|
| Metric Name | udsf_rest_allresponse_total |
| Description | Total number of responses sent by nudr-drservice (All UDSF operations). |
| Type | Counter |
| Dimensions |
Not Applicable |
Table 6-81 UDSF Total Success Responses
| Field | Details |
|---|---|
| Metric Name | udsf_rest_success_response_total |
| Description | Total number of success responses sent by nudr-drservice (All UDSF operations). |
| Type | Counter |
| Dimensions |
Not Applicable |
Table 6-82 UDSF Total Failure Responses
| Field | Details |
|---|---|
| Metric Name | UDSF Total Failure Responses |
| Description | Total number of failure responses sent by nudr-drservice (All UDSF operations). |
| Type | Counter |
| Dimensions |
Not Applicable |
Table 6-83 UDSF Put Requests
| Field | Details |
|---|---|
| Metric Name | udsf_rest_request_total{Method="PUT/GET/DELETE"} |
| Description | Total number of PUT requests received by nudr-drservice (UDSF related). |
| Type | Counter |
| Dimensions |
Method |
Table 6-84 UDSF Put Success Responses
| Field | Details |
|---|---|
| Metric Name | udsf_rest_response_success_total{Method="PUT/GET/DELETE"} |
| Description | Total number of PUT success responses sent by nudr-drservice (UDSF related). |
| Type | Counter |
| Dimensions |
Method |
Table 6-85 UDSF Put Failure Responses
| Field | Details |
|---|---|
| Metric Name | udsf_rest_response_failure_total{Method="PUT/GET/DELETE"} |
| Description | Total number of PUT failure responses sent by nudr-drservice (UDSF related). |
| Type | Counter |
| Dimensions |
Method |
Table 6-86 UDR Subscription Requests
| Field | Details |
|---|---|
| Metric Name | nudr_dr_all_subscription_requests_total |
| Description | Total number of subscription requests received by nudr-drservice (All operations). |
| Type | Counter |
| Dimensions |
Not Applicable |
Table 6-87 UDR Subscription Request Successful
| Field | Details |
|---|---|
| Metric Name | nudr_dr_all_subscription_responses_total |
| Description | Total number of successful subscription request processed successfully by nudr-drservice (All operations). |
| Type | Counter |
| Dimensions |
Not Applicable |
Table 6-88 UDR Subscription Response Successful
| Field | Details |
|---|---|
| Metric Name | nudr_dr_all_subscription_successful_responses_total |
| Description | Total number of successful subscription response sent by nudr-drservice (All operations). |
| Type | Counter |
| Dimensions |
Not Applicable |
Table 6-89 UDR Subscription Response Failure
| Field | Details |
|---|---|
| Metric Name | nudr_dr_all_subscription_failed_responses_total |
| Description | Total number of successful subscription response sent by nudr-drservice (All operations). |
| Type | Counter |
| Dimensions |
Not Applicable |
Table 6-90 UDR Post Subscription Requests
| Field | Details |
|---|---|
| Metric Name | nudr_dr_subscription_request_total{Method="POST/PUT/GET/DELETE"} |
| Description | Total number of POST subscription requests received by nudr-drservice. |
| Type | Counter |
| Dimensions |
Method |
Table 6-91 UDR Post Subscription Response Success
| Field | Details |
|---|---|
| Metric Name | nudr_dr_subscription_successful_response_total{Method="POST/PUT/GET/DELETE"} |
| Description | Total number of successful POST subscription response sent by nudr-drservice |
| Type | Counter |
| Dimensions |
Method |
Table 6-92 UDR Post Subscription Response Failure
| Field | Details |
|---|---|
| Metric Name | nudr_dr_subscription_failed_response_total{Method="POST/PUT/GET/DELETE"} |
| Description | Total number of failed POST Subscription response sent by nudr-drservice |
| Type | Counter |
| Dimensions |
Method |
Table 6-93 UDR Notification Requests
| Field | Details |
|---|---|
| Metric Name | nudr_dr_notif_signal_sent_total |
| Description | Total notification sent successfully by nudr-drservice to nudr-notify-service. |
| Type | Counter |
| Dimensions |
Not Applicable |
Table 6-94 UDR Notification Failure
| Field | Details |
|---|---|
| Metric Name | nudr_dr_notif_signal_failed_notifications_total |
| Description | Total notification failed to send to nudr-notify-service. |
| Type | Counter |
| Dimensions |
Not Applicable |
Table 6-95 UDR Update Notification Success
| Field | Details |
|---|---|
| Metric Name | nudr_dr_notif_signal_notification_update_success_total |
| Description | Total update notifications sent successfully to nudr-notify-service. |
| Type | Counter |
| Dimensions |
Method |
Table 6-96 UDR Update Notification Failure
| Field | Details |
|---|---|
| Metric Name | nudr_dr_notif_signal_notification_update_failed_total |
| Description | Total update notifications failed to send to nudr-notify-service. |
| Type | Counter |
| Dimensions |
Method |
Table 6-97 UDR Delete Notification Success
| Field | Details |
|---|---|
| Metric Name | nudr_dr_notif_signal_notification_delete_success_total |
| Description | Total delete notifications sent successfully to nudr-notify-service |
| Type | Counter |
| Dimensions |
Method |
Table 6-98 UDR Delete Notification Failure
| Field | Details |
|---|---|
| Metric Name | nudr_dr_notif_signal_notification_delete_failed_total |
| Description | Total delete notifications failed to send to nudr-notify-service |
| Type | Counter |
| Dimensions |
Method |
Table 6-99 UDR NF Type Specific Metrics - Method wise
| Field | Details |
|---|---|
| Metric Name | udr_nftype_specific_requests{NFType="PCF/UDM/SLF/NEF/EIR",Method="GET/POST/PUT/DELETE/PATCH", ProvRequest="N", subtype="SLFGroupName/NFGroupIdMap/ExposureAMData/ExposurePSMData/subs-to-notify/EquipmentStatus"} |
| Description | Total number of requests that UDR receives from different NF types along with method types. |
| Type | Counter |
| Dimensions |
Method NFType ProvRequest subtype |
Table 6-100 UDR NF Type Specific Metrics - Method wise
| Field | Details |
|---|---|
| Metric Name | udr_nftype_specific_requests_status{NFType="PCF/UDM/SLF/NEF/EIR",Method="GET/POST/PUT/DELETE/PATCH", ProvRequest="N", subtype="SLFGroupName/NFGroupIdMap/ExposureAMData/ExposurePSMData/subs-to-notify/EquipmentStatus"} |
| Description | Total number of success responses that UDR sends to different NFs along with method types |
| Type | Counter |
| Dimensions |
Method NFType ProvRequest subtype |
Table 6-101 UDR NF Type Subscription Metrics - Method Wise
| Field | Details |
|---|---|
| Metric Name | nudr_dr_nf_type_subscription_request{NFType="PCF/UDM/NEF",Method="POST/PUT/DELETE/GET"} |
| Description | Total number of subscription requests for each NF type as well as each method type. |
| Type | Counter |
| Dimensions |
Method NFType |
Table 6-102 UDR NF Type Subscription Metrics - Success Response
| Field | Details |
|---|---|
| Metric Name | nudr_dr_nf_type_subscription_request_status{NFType="PCF/UDM/NEF",StatusCode=~"2.*/4.*", Method="POST/PUT/DELETE/GET/PATCH"} |
| Description | Total number of success responses of subscriptions. |
| Type | Counter |
| Dimensions |
Method NFType StatusCode |
Table 6-103 Config Service Update
| Field | Details |
|---|---|
| Metric Name | Total number of config updates received by nudr-config microservices |
| Description | If the configuration change is successfully (2xx) received or throws an error (4xx). |
| Type | Counter |
| Dimensions |
StatusCode |
Table 6-104 VSA Specific Requests
| Field | Details |
|---|---|
| Metric Name | udr_vsa_specific_requests_total{Method="POST/PUT/DELETE/GET/PATCH"} |
| Description |
Total number of VSA requests method wise |
| Type | Counter |
| Dimensions |
Method NFType ResourceType |
Table 6-105 udr_request_processing_time_seconds
| Field | Details |
|---|---|
| Metric Name | udr_request_processing_time_seconds |
| Description | Average time taken by nudr-dr service to process the request including cnDBtier and nudr-dr service. |
| Type | Timer |
| Dimensions |
Not Applicable |
Table 6-106 udr_db_processing_time_seconds
| Field | Details |
|---|---|
| Metric Name | udr_db_processing_time_seconds |
| Description | Average time taken to process the database operations excluding the application logic. |
| Type | Timer |
| Dimensions |
Not Applicable |
Table 6-107 slf_sucess_txn_default_grp_id
| Field | Details |
|---|---|
| Metric Name | slf_sucess_txn_default_grp_id |
| Description | The number of requests for which the SLF reponds with default GroupId for Lookup. |
| Type | Counter |
| Dimensions |
Not Applicable |
Table 6-108 nudr_dr_subscription_expired
| Field | Details |
|---|---|
| Metric Name | nudr_dr_subscription_expired |
| Description | This metric will be logged when the subscription is expired. |
| Type | Counter |
| Dimensions |
NFType |
Table 6-109 udr_subscriber_not_found
| Field | Details |
|---|---|
| Metric Name | udr_subscriber_not_found{resource_name=~"nudr-dr|nudr-group-id-map|nudsf-dr"} |
| Description | This metric will be logged whenever subscriber is not present. |
| Type | Counter |
| Dimensions |
resource-name |
Table 6-110 eir_txn_default
| Field | Details |
|---|---|
| Metric Name | eir_txn_default_response_sent |
| Description | The number of EIR EIC responses using default response. |
| Type | Counter |
| Dimensions |
Not Applicable |
Table 6-111 Default SM Policy SNSSAI Data Creation
| Field | Details |
|---|---|
| Metric Name | udr_default_smPolicySnssaiData_creation_total{Method="PUT/PATCH"} |
| Description | Total number of requests for which default value of smPolicySnssaiData is applied. |
| Type | Counter |
| Dimensions |
Not Applicable |
Table 6-112 Auto Enrollment of Subscriber
| Field | Details |
|---|---|
| Metric Name | total_auto_enrol_requests_total |
| Description | The total number of auto enrollment requests. |
| Type | Counter |
| Dimensions |
Not Applicable |
Table 6-113 ETag Rest Request
| Field | Details |
|---|---|
| Metric Name | udr_etag_rest_request_total{Method="PUT/GET/PATCH/DELETE",etag_header="if-match/if-none-match"} |
| Description | Total number of Rest request received for which ETag is enabled. |
| Type | Counter |
| Dimensions |
Not Applicable |
Table 6-114 ETag Rest Response
| Field | Details |
|---|---|
| Metric Name | udr_etag_rest_response_total{Method(PUT,GET,PATCH,DELETE), status(200,201,204,412,304)} |
| Description | Total number of responses sent for which ETag is enabled. |
| Type | Counter |
| Dimensions |
Not Applicable |
Table 6-115 EIR Default Response IMEI Not Found
| Field | Details |
|---|---|
| Metric Name | eir_default_response_imei_not_found |
| Description | The number of EIR and EIC responses using default response when IMEI or PEI is not found in the database. |
| Type | Counter |
| Dimensions |
Not Applicable |
Table 6-116 Suppress Notifications
| Field | Details |
|---|---|
| Metric Name | suppress_user_agent_not_found_total |
| Description | This metric provides the total number of requests without User-Agent header when the feature is enabled. |
| Type | Counter |
| Dimensions | NA |
Table 6-117 udr_subscriptions_recreated
| Field | Details |
|---|---|
| Metric Name | udr_subscriptions_recreated |
| Description | This metric provides the total number of POST requests
received for the existing subscription when
allowSubscriptionRecreation is set to true.
|
| Type | Counter |
| Dimensions | NA |
6.4 nudr-dr-provservice Metrics
Table 6-118 UDR Total Requests
| Field | Details |
|---|---|
| Metric Name | udr_rest_all_requests_total |
| Description | Total number of requests received by nudr-dr-provservice (All UDR operations) |
| Type | Counter |
| Dimensions |
sbi_correlation_header(no)key(imsi/msisdn/nai/extid/accountid) |
Table 6-119 UDR Total Responses
| Field | Details |
|---|---|
| Metric Name | udr_rest_all_response_total |
| Description | Total number of responses sent by nudr-dr-provservice (All UDR operations) |
| Type | Counter |
| Dimensions |
sbi_correlation_header(no) key(imsi/msisdn/nai/extid/accountid) status(failure/success) |
Table 6-120 UDR TotalSuccess Responses
| Field | Details |
|---|---|
| Metric Name | udr_rest_success_response_total |
| Description | Total number of success responses sent by nudr-dr-provservice (All UDR operations) |
| Type | Counter |
| Dimensions |
Not Applicable |
Table 6-121 UDR Total Failure Responses
| Field | Details |
|---|---|
| Metric Name | udr_rest_failure_response_total |
| Description | Total number of failure responses sent by nudr-dr-provservice (All UDR operations) |
| Type | Counter |
| Dimensions |
Not Applicable |
Table 6-122 UDR Put Requests
| Field | Details |
|---|---|
| Metric Name | udr_rest_request_total{Method="PUT/PATCH/GET/DELETE/POST"} |
| Description | Total number of PUT requests received by nudr-dr-provservice (UDR related) |
| Type | Counter |
| Dimensions |
Method sbi_correlation_header key status |
Table 6-123 UDR Put Success Responses
| Field | Details |
|---|---|
| Metric Name | udr_rest_response_success_total{Method="PUT"} |
| Description | Total number of PUT success responses sent by nudr-dr-provservice (UDR related) |
| Type | Counter |
| Dimensions |
Method |
Table 6-124 UDR Put Failure Responses
| Field | Details |
|---|---|
| Metric Name | udr_rest_response_failure_total{Method="PUT"} |
| Description | Total number of PUT failure responses sent by nudr-dr-provservice (UDR related) |
| Type | Counter |
| Dimensions |
Method |
Table 6-125 UDR Patch Success Responses
| Field | Details |
|---|---|
| Metric Name | udr_rest_response_success_total{Method="PATCH/GET/DELETE/POST"} |
| Description | Total number of PATCH success responses sent by nudr-dr-provservice (UDR related) |
| Type | Counter |
| Dimensions |
Method |
Table 6-126 UDR Patch Failure Responses
| Field | Details |
|---|---|
| Metric Name | udr_rest_response_failure_total{Method="PATCH/GET/DELETE/POST"} |
| Description | Total number of PATCH failure responses sent by nudr-dr-provservice (UDR related) |
| Type | Counter |
| Dimensions |
Method |
Table 6-127 UDR Schema Validation Success
| Field | Details |
|---|---|
| Metric Name | udr_schema_validation_success_total |
| Description | Total success count of schema validations done for all operations with body. |
| Type | Counter |
| Dimensions | Not Applicable |
Table 6-128 UDR Schema Validation Failure
| Field | Details |
|---|---|
| Metric Name | udr_schema_validation_failure_total |
| Description | Total failure count of schema validations done for all operations with body. |
| Type | Counter |
| Dimensions | Not Applicable |
Table 6-129 UDR Put Schema Success
| Field | Details |
|---|---|
| Metric Name | udr_schema_mgm_operations_success_total |
| Description | Total number of successful schema updates processed by nudr-dr-provservice |
| Type | Counter |
| Dimensions |
Method (PUT/GET/DELETE) RESOURCE (POLICY_DATA/ SUBSCRIPTION_DATA/ PROFILE_DATA/SLF_GROUP) EXPOSURE_DATA |
Table 6-130 UDR Put Schema Failure
| Field | Details |
|---|---|
| Metric Name | udr_schema_mgm_operations_failure_total |
| Description | Total number of failure schema updates processed by nudr-dr-provservice |
| Type | Counter |
| Dimensions |
Method (PUT/GET/DELETE) RESOURCE (POLICY_DATA/ SUBSCRIPTION_DATA/ PROFILE_DATA/SLF_GROUP) EXPOSURE_DATA |
Table 6-131 Db Operations Total
| Field | Details |
|---|---|
| Metric Name | udr_db_operations_total{Method="READ/UPDATE"} |
| Description | Total number of database reads and writes performed by nudr-dr-provservice on the back end NDB Cluster. |
| Type | Counter |
| Dimensions |
Method |
Table 6-132 Db Operations Success
| Field | Details |
|---|---|
| Metric Name | udr_db_operations_success_total{Method="READ/UPDATE"} |
| Description | Total number of successful DB reads performed by nudr-drservice on the back end NDB Cluster. |
| Type | Counter |
| Dimensions |
Method |
Table 6-133 Db Operations Failure
| Field | Details |
|---|---|
| Metric Name | udr_db_operations_failure_total{Method="READ/UPDATE"} |
| Description | Total number of failed DB reads performed by nudr-drservice on the back end NDB Cluster. |
| Type | Counter |
| Dimensions |
Method |
Table 6-134 Db Total Txn Attempted
| Field | Details |
|---|---|
| Metric Name | udr_total_transactions_total |
| Description | Total number of successful DB transactions (includes all DB operations) performed by nudr-drservice on the back end NDB Cluster. |
| Type | Counter |
| Dimensions |
Not Applicable |
Table 6-135 DB Txn Success
| Field | Details |
|---|---|
| Metric Name | udr_successful_transactions_total |
| Description | Total number of failed DB transactions (includes all DB operations) performed by nudr-drservice on the back end NDB Cluster. |
| Type | Counter |
| Dimensions |
Not Applicable |
Table 6-136 UDR Subscription Requests
| Field | Details |
|---|---|
| Metric Name | nudr_dr_all_subscription_requests_total |
| Description | Total number of subscription requests received by nudr-dr-provservice (All operations) |
| Type | Counter |
| Dimensions |
Not Applicable |
Table 6-137 UDR Subscription Request Successful
| Field | Details |
|---|---|
| Metric Name | nudr_dr_all_subscription_responses_total |
| Description | Total number of successful subscription request processed successfully by nudr-dr-provservice (All operations) |
| Type | Counter |
| Dimensions |
Not Applicable |
Table 6-138 UDR Subscription Response Failure
| Field | Details |
|---|---|
| Metric Name | nudr_dr_all_subscription_failed_responses_total |
| Description | Total number of failed subscription response sent by nudr-dr-provservice (All operations) |
| Type | Counter |
| Dimensions |
Not Applicable |
Table 6-139 UDR Post Subscription Requests
| Field | Details |
|---|---|
| Metric Name | nudr_dr_subscription_request_total{Method="POST/PUT/GET/DELETE"} |
| Description | Total number of successful POST Subscription requests processed by nudr-dr-provservice |
| Type | Counter |
| Dimensions |
Method |
Table 6-140 UDR Post Subscription Response Success
| Field | Details |
|---|---|
| Metric Name | nudr_dr_subscription_successful_response_total{Method="POST/PUT/GET/DELETE"} |
| Description | Total number of successful POST Subscription response sent by nudr-dr-provservice |
| Type | Counter |
| Dimensions |
Method |
Table 6-141 UDR Post Subscription Response Failure
| Field | Details |
|---|---|
| Metric Name | nudr_dr_subscription_failed_response_total{Method="POST/PUT/GET/DELETE"} |
| Description | Total number of failed POST Subscription response sent by nudr-dr-provservice |
| Type | Counter |
| Dimensions |
Method |
Table 6-142 UDR Notification Requests
| Field | Details |
|---|---|
| Metric Name | nudr_dr_notif_signal_sent_total |
| Description | Total number of notifications sent successfully by nudr-dr-provservice to nudr-notify-service |
| Type | Counter |
| Dimensions |
Not Applicable |
Table 6-143 UDR Notification Failure
| Field | Details |
|---|---|
| Metric Name | nudr_dr_notif_signal_failed_notifications_total |
| Description | Total number of notifications failed to send to nudr-notify-service |
| Type | Counter |
| Dimensions |
Not Applicable |
Table 6-144 UDR Update Notification Success
| Field | Details |
|---|---|
| Metric Name | nudr_dr_notif_signal_notification_update_success_total |
| Description | Total number of update notifications sent successfully to nudr-notify-service |
| Type | Counter |
| Dimensions |
Method |
Table 6-145 UDR Update Notification Failure
| Field | Details |
|---|---|
| Metric Name | nudr_dr_notif_signal_notification_update_failed_total |
| Description | Total number of update notifications failed to send to nudr-notify-service |
| Type | Counter |
| Dimensions |
Method |
Table 6-146 UDR Delete Notification Success
| Field | Details |
|---|---|
| Metric Name | nudr_dr_notif_signal_notification_delete_success_total |
| Description | Total number of delete notifications sent successfully to nudr-notify-service |
| Type | Counter |
| Dimensions |
Method |
Table 6-147 UDR Delete Notification Failure
| Field | Details |
|---|---|
| Metric Name | nudr_dr_notif_signal_notification_delete_failed_total |
| Description | Total number of delete notifications failed to send to nudr-notify-service |
| Type | Counter |
| Dimensions |
Method |
Table 6-148 UDR NF Type Specific Metrics - Method wise
| Field | Details |
|---|---|
| Metric Name | udr_nftype_specific_requests{NFType="PCF/UDM/SLF/NEF/EIR",Method="GET/POST/PUT/DELETE/PATCH", ProvRequest="Y", subtype="SLFGroupName/NFGroupIdMap/EquipmentStatus/EIRProfileUpdate"} |
| Description | Total number of requests that UDR receives from different NF types along with method types |
| Type | Counter |
| Dimensions |
Method NFType ProvRequest subtype |
Table 6-149 UDR NF Type Specific Metrics - Success Response, Subtype wise, Method wise, and Provisioning Request
| Field | Details |
|---|---|
| Metric Name | udr_nftype_specific_requests_status{NFType="PCF/UDM/SLF/NEF/EIR",StatusCode=~"2.*/4.*/5.*", ProvRequest="Y", Method="GET/POST/PUT/PATCH/DELETE" , subtype="SLFGroupName/NFGroupIdMap/EquipmentStatus/EIRProfileUpdate"} |
| Description | Total number of success responses for SLF based on subtype, method wise |
| Type | Counter |
| Dimensions |
Method NFType ProvRequest subtype StatusCode |
Table 6-150 UDR NF Type Subscription Metrics - Method Wise
| Field | Details |
|---|---|
| Metric Name | nudr_dr_nf_type_subscription_request{NFType="PCF/UDM/NEF",Method="POST/PUT/DELETE/GET"} |
| Description | Total number of subscription requests for each NF type as well as each method type |
| Type | Counter |
| Dimensions |
Method NFType |
Table 6-151 UDR NF Type Subscription Metrics - Success Response
| Field | Details |
|---|---|
| Metric Name | nudr_dr_nf_type_subscription_request_status{NFType="PCF/UDM/NEF",StatusCode=~"2.*/4.*", Method="POST/PUT/DELETE/GET/PATCH"} |
| Description | Total number of success responses of subscriptions |
| Type | Counter |
| Dimensions |
Method NFType StatusCode |
Table 6-152 Config Service Update
| Field | Details |
|---|---|
| Metric Name | nudr_dr_config_service_update{StatusCode:200/400} |
| Description | If the configuration change is successfully(2xx) received or throws a error(4xx) |
| Type | Counter |
| Dimensions | StatusCode |
Table 6-153 VSA Specific Requests Total
| Field | Details |
|---|---|
| Metric Name | udr_vsa_specific_requests_total{Method="POST/PUT/DELETE/GET/PATCH"} |
| Description | Total number of VSA requests on the basis of method |
| Type | Counter |
| Dimensions |
Method NFType ResourceType |
Table 6-154 VSA Specific Requests Status
| Field | Details |
|---|---|
| Metric Name | udr_vsa_specific_requests_status_total{StatusCode=~"2.*/4.*",Method="POST/PUT/DELETE/GET/PATCH"} |
| Description | Total number of VSA requests Success(2xx)/Failure(4xx) Response method wise |
| Type | Counter |
| Dimensions |
Method NFType ResourceType StatusCode |
Table 6-155 Request Processing Time
| Field | Details |
|---|---|
| Metric Name | udr_request_processing_time_seconds |
| Description | Time to process UDR request. This is measured from when the request is received to when the response is sent |
| Type | Timer |
| Dimensions | Not Applicable |
Table 6-156 Database Processing Time
| Field | Details |
|---|---|
| Metric Name | udr_db_processing_time_seconds |
| Description | Time to process a DB query. This is measured from when the database method starts to the db method ends. |
| Type | Timer |
| Dimensions | Not Applicable |
Table 6-157 Subscription Expired
| Field | Details |
|---|---|
| Metric Name | nudr_dr_subscription_expired |
| Description | This metric is logged when the subscription is expired. |
| Type | Counter |
| Dimensions | NFType |
Table 6-158 Subscriber Not Found
| Field | Details |
|---|---|
| Metric Name | udr_subscriber_not_found{resource_name=~"nudr-dr-prov|nudr-group-id-map-prov|slf-group-prov"} |
| Description | This metric is logged whenever the subscriber is not present. |
| Type | Counter |
| Dimensions | resource-name |
6.5 nudr-notify-service Metrics
The following metrics are applicable to the nudr-notify-service of UDR.
Table 6-159 UDR Notification Requests
| Field | Details |
|---|---|
| Metric Name | nudr_notif_notifications_signals_received_total |
| Description | Total number of notifications received on nudr-notify-service from nudr-drservice. |
| Type | Counter |
| Dimensions | Not Applicable |
Table 6-160 UDR Failed Notifications Processing
| Field | Details |
|---|---|
| Metric Name | nudr_notif_notifications_processing_failed_total |
| Description | Total number of notification failure processing on nudr-notify-service. |
| Type | Counter |
| Dimensions | Not Applicable |
Table 6-161 UDR Notifications Sent
| Field | Details |
|---|---|
| Metric Name | nudr_notif_notifications_sent_total |
| Description | Total number of notifications sent to network. |
| Type | Counter |
| Dimensions | sbi_correlation_header(yes/no) key(imsi/msisdn/nai/extid/accountid) |
Table 6-162 UDR Send Notification Failures
| Field | Details |
|---|---|
| Metric Name | nudr_notif_notifications_send_fail_total |
| Description | Total number of notifications failed to send to network. |
| Type | Counter |
| Dimensions | Not Applicable |
Table 6-163 UDR Notifications Marked Retry
| Field | Details |
|---|---|
| Metric Name | nudr_notif_notifications_marked_for_retry_total |
| Description | Total number of notifications marked for retry after notification failure response. |
| Type | Counter |
| Dimensions | Not Applicable |
Table 6-164 UDR Notification Responses
| Field | Details |
|---|---|
| Metric Name | nudr_notif_notifications_ack_total |
| Description | Total number of responses for notifications sent to network. |
| Type | Counter |
| Dimensions | Not Applicable |
Table 6-165 UDR Notification Success Responses
| Field | Details |
|---|---|
| Metric Name | nudr_notif_notifications_ack_2xx_total |
| Description | Total number of success responses for notifications sent to network. |
| Type | Counter |
| Dimensions | Not Applicable |
Table 6-166 UDR Notification 4xx Responses
| Field | Details |
|---|---|
| Metric Name | nudr_notif_notifications_ack_4xx_total |
| Description | Total number of 4xx error responses for notifications sent to network. |
| Type | Counter |
| Dimensions | Not Applicable |
Table 6-167 UDR Notification 5xx Responses
| Field | Details |
|---|---|
| Metric Name | nudr_notif_notifications_ack_5xx_total |
| Description | Total number of 5xx error responses for notifications sent to network. |
| Type | Counter |
| Dimensions | Not Applicable |
Table 6-168 UDR NF Type Notification Metric
| Field | Details |
|---|---|
| Metric Name | nudr_notif_notifications_nftype_signals_received{NFType="UDM/PCF",Method="UPDATE/DELETE"} |
| Description | Total number of notifications received to sent out to UDM or PCF with update or delete requests. |
| Type | Counter |
| Dimensions |
Method NFType |
Table 6-169 Config Service Update
| Field | Details |
|---|---|
| Metric Name | nudr_notify_config_service_update{StatusCode:200/400} |
| Description | If the configuration change is received successfully(200) or throws error while processing (400) |
| Type | Counter |
| Dimensions | StatusCode |
Table 6-170 VSA Notification Received
| Field | Details |
|---|---|
| Metric Name | nudr_notif_notifications_vsa_signals_received {UPDATE, DELETE} |
| Description | Total number of notifications update received by Nudr-notify when the sm-data/vsa is updated. |
| Type | Counter |
| Dimensions |
Method NFType ResourceType |
Table 6-171 Subscriptions Expired Count
| Field | Details |
|---|---|
| Metric Name | nudr_notif_subscription_expired |
| Description | Total number of expired notifications for the subscription requests. |
| Type | Counter |
| Dimensions |
NFType Notification Type |
Table 6-172 Notification Count with ETag Header
| Field | Details |
|---|---|
| Metric Name | nudr_notif_etag_notifications_sent_total |
| Description | Total number of notifications for which ETAG is sent from Nudr-dr/Nudr-dr-prov microservices. |
| Type | Counter |
| Dimensions | etag (yes/no) |
Table 6-173 Notify Supress Notifications
| Field | Details |
|---|---|
| Metric Name | nudr_notif_suppress_notifications_total |
| Description | This metrics indicates number of suppressed notifications. |
| Type | Counter |
| Dimensions | NA |
6.6 nudr-diameterproxy-service Metrics
The following metrics are applicable to the nudr-diameterproxy-service of UDR.
Table 6-174 Diameter proxy Request Messages
| Field | Details |
|---|---|
| Metric Name | nudr_diameterproxy_total_requests_total |
| Description | The total number of requests received on the diameterproxy microservice. |
| Type | Counter |
| Dimensions | Not Applicable |
Table 6-175 Diameter proxy Response Messages
| Field | Details |
|---|---|
| Metric Name | nudr_diameterproxy_total_response_total |
| Description | Total number of Sh message responses from diameter peer |
| Type | Counter |
| Dimensions | ResultCode |
Table 6-176 Diameter proxy Success Messages
| Field | Details |
|---|---|
| Metric Name | nudr_diameterproxy_responses_total{ResultCode="2001"} |
| Description | Total number of successful Sh message responses from diameter peer. |
| Type | Counter |
| Dimensions |
MessageType ResultCode |
Table 6-177 Diameter proxy Failure Messages
| Field | Details |
|---|---|
| Metric Name | nudr_diameterproxy_responses_total{ResultCode=!"2001"} |
| Description | Total number of failure Sh message responses from diameter peer |
| Type | Counter |
| Dimensions |
MessageType ResultCode |
Table 6-178 Diameter proxy Decode Failed Messages
| Field | Details |
|---|---|
| Metric Name | nudr_diameterproxy_message_decoding_failed_total |
| Description | The total number of messages failed while decoding and invalid AVPs in the message. |
| Type | Counter |
| Dimensions | Not Applicable |
Table 6-179 Diameter proxy Discarded Messages
| Field | Details |
|---|---|
| Metric Name | nudr_diameterproxy_request_discarded_total |
| Description | The total number of discarded messages due to invalid command codes. |
| Type | Counter |
| Dimensions | Not Applicable |
Table 6-180 Diameter proxy UDA Success Messages
| Field | Details |
|---|---|
| Metric Name | nudr_diameterproxy_responses_total{MessageType="UDA", ResultCode="2001"} |
| Description | The total number of success User Data Answer messages received on diameterproxy. |
| Type | Counter |
| Dimensions |
MessageType ResultCode |
Table 6-181 Diameter proxy UDA Failure Messages
| Field | Details |
|---|---|
| Metric Name | nudr_diameterproxy_responses_total{MessageType="UDA", ResultCode !="2001"} |
| Description | The total number of failure User Data Answer messages received on diameterproxy. |
| Type | Counter |
| Dimensions |
MessageType ResultCode |
Table 6-182 Diameterproxy_UDR_Rejected_By_Unknown_User
| Field | Details |
|---|---|
| Metric Name | nudr_diameterproxy_request_rejected_unknown_user_total |
| Description | The total number User data requests messages failed because of Unknown user. |
| Type | Counter |
| Dimensions | Not Applicable |
Table 6-183 Diameterproxy_UDR_Rejected_By_Invalid_Service_Indication
| Field | Details |
|---|---|
| Metric Name | nudr_diameterproxy_rejected_invalid_service_indication_requests_total{MessageType="UDR"} |
| Description | The total number User Data request messages failed because of invalid service passed. |
| Type | Counter |
| Dimensions | MessageType |
Table 6-184 Diameterproxy_PUR_Messages
| Field | Details |
|---|---|
| Metric Name | nudr_diameterproxy_requests_total{MessageType="PUR"} |
| Description | The total number of profile update request messages received on diameterproxy. |
| Type | Counter |
| Dimensions | MessageType |
Table 6-185 Diameterproxy_PUA_Success_Messages
| Field | Details |
|---|---|
| Metric Name | nudr_diameterproxy_responses_total{MessageType="PUA", ResultCode="2001"} |
| Description | The total number of success profile data update requests |
| Type | Counter |
| Dimensions |
MessageType ResultCode |
Table 6-186 Diameterproxy_PUA_Failure_Messages
| Field | Details |
|---|---|
| Metric Name | nudr_diameterproxy_responses_total{MessageType="PUA", ResultCode !="2001"} |
| Description | The total number of failure profile data update requests |
| Type | Counter |
| Dimensions |
MessageType ResultCode |
Table 6-187 Diameterproxy_PUR_Rejected_By_Unknown_Use
| Field | Details |
|---|---|
| Metric Name | nudr_diameterproxy_request_rejected_unknown_user_total |
| Description | The total number of PUR messages rejected by unknown user( Subscriber doesn't exists). |
| Type | Counter |
| Dimensions | Not Applicable |
Table 6-188 Diameterproxy_PUR_Rejected_By_Invalid_Service_Indication
| Field | Details |
|---|---|
| Metric Name | nudr_diameterproxy_rejected_invalid_service_indication_requests_total{MessageType="PUR"} |
| Description | The total number of failed profile update requests with passing invalid service indication. |
| Type | Counter |
| Dimensions | MessageType |
Table 6-189 Diameterproxy_SNR_Messages
| Field | Details |
|---|---|
| Metric Name | nudr_diameterproxy_requests_total{MessageType="SNR"} |
| Description | The total number of subscriber notification request messages received on diameterproxy. |
| Type | Counter |
| Dimensions | MessageType |
Table 6-190 Diameterproxy_SNA_Success_Messages
| Field | Details |
|---|---|
| Metric Name | nudr_diameterproxy_responses_total{MessageType="SNA", ResultCode="2001"} |
| Description | The total number of Success subscriber notification messages. |
| Type | Counter |
| Dimensions |
MessageType ResultCode |
Table 6-191 Diameterproxy_SNA_Failure_Messages
| Field | Details |
|---|---|
| Metric Name | nudr_diameterproxy_responses_total{MessageType="SNA", ResultCode !="2001"} |
| Description | The total number of failure subscriber notification messages |
| Type | Counter |
| Dimensions |
MessageType ResultCode |
Table 6-192 Diameterproxy_SNR_Rejected_By_Unknown_User
| Field | Details |
|---|---|
| Metric Name | nudr_diameterproxy_request_rejected_unknown_user_total |
| Description | The total number of subscriber notification messages rejected by an unknown user |
| Type | Counter |
| Dimensions | Not Applicable |
Table 6-193 Diameterproxy_SNR_Rejected_By_Invalid_Service_Indication
| Field | Details |
|---|---|
| Metric Name | nudr_diameterproxy_rejected_invalid_service_indication_requests_total{MessageType="SNR"} |
| Description | The total number of subscriber notification requests rejected by passing invalid service indications |
| Type | Counter |
| Dimensions | MessageType |
Table 6-194 Diameterproxy_PNR_Messages
| Field | Details |
|---|---|
| Metric Name | udr_diameterproxy_requests_total{MessageType="PNR"} |
| Description | The total number of Push notification messages sent from diameterproxy. |
| Type | Counter |
| Dimensions | MessageType |
Table 6-195 Diameterproxy_PNA_Success_Messages
| Field | Details |
|---|---|
| Metric Name | nudr_diameterproxy_responses_total{MessageType="PNA", ResultCode="2001"} |
| Description | The total number of success Push notification sent from diameterproxy. |
| Type | Counter |
| Dimensions |
MessageType ResultCode |
Table 6-196 Diameterproxy_PNA_Failure_Messages
| Field | Details |
|---|---|
| Metric Name | nudr_diameterproxy_responses_total{MessageType="PNA", ResultCode !="2001"} |
| Description | The total number of failure push notification sent from diameterproxy. |
| Type | Counter |
| Dimensions |
MessageType ResultCode |
Table 6-197 Diameter_Total_Rest_request_recieved_From_Notify-service
| Field | Details |
|---|---|
| Metric Name | nudr_diameterproxy_total_notification_received_total |
| Description | The total number of rest requests received from notify-service. |
| Type | Counter |
| Dimensions | Not Applicable |
Table 6-198 Diameter_Total_Rest_Failure_requests_From_notify-service
| Field | Details |
|---|---|
| Metric Name | nudr_diameterproxy_notification_failed_total |
| Description | The total number of rest requests are failed to send Push notification from the diameterproxy service. |
| Type | Counter |
| Dimensions | Not Applicable |
Table 6-199 nudr_diameterproxy_config_service_update_total
| Field | Details |
|---|---|
| Metric Name | nudr_diameterproxy_config_service_update_total{StatusCode="200/400"} |
| Description | The total number of update requests(PUT) along with successfully updated the data in microservice |
| Type | Counter |
| Dimensions | StatusCode |
Table 6-200 diameter_request_processing_time_seconds
| Field | Details |
|---|---|
| Metric Name | diameter_request_processing_time_seconds |
| Description | Average time for processing diameter messages and database operation. |
| Type | Timer |
| Dimensions |
quantile InstanceIdentifier |
Table 6-201 diameter_db_processing_time_seconds
| Field | Details |
|---|---|
| Metric Name | diameter_db_processing_time_seconds |
| Description | Average time for only database operation for diameter messages. |
| Type | Timer |
| Dimensions |
quantile InstanceIdentifier |
Table 6-202 eir_default_response_imei_not_found
| Field | Details |
|---|---|
| Metric Name | eir_default_response_imei_not_found |
| Description | Provides the number of ECA messages based on Interface
(S13 or N17) with defaultResponses when IMEI is not
present in EIR database.
|
| Type | Counter |
| Dimensions |
Interface |
Table 6-203 eir_txn_default_response_sent
| Field | Details |
|---|---|
| Metric Name | eir_txn_default_response_sent |
| Description | Provides the number of ECA messages based on Interface
(S13 or N17) with defaultResponses when user name or
IMSI is not present in the EIR database but IMEI is present in the EIR
database.
|
| Type | Counter |
| Dimensions |
Interface |
6.7 nudr-config-service Metrics
The following table provides metrics for nudr-config microservice of UDR.
Table 6-204 config_schema_validation_total
| Field | Details |
|---|---|
| Metric Name | nudr_config_schema_validation_total{StatusCode="200/400"} |
| Description | Pegging schema validation with 200/400 as response code. |
| Type | Counter |
| Dimensions | StatusCode |
Table 6-205 config_total_requests_total
| Field | Details |
|---|---|
| Metric Name | nudr_config_total_requests_total{Method='GET/POST/PUT'} |
| Description | Pegging all the GET request received by configuration service |
| Type | Counter |
| Dimensions | Method |
Table 6-206 config_total_responses
| Field | Details |
|---|---|
| Metric Name | nudr_config_total_responses_total{Method='GET/PUT/POST',StatusCode="200/201/400/404/405/500"} |
| Description | Pegging the response of GET request with response code: 200/201/400/404/405/500 |
| Type | Counter |
| Dimensions |
Method StatusCode |
Table 6-207 export_total_requests
| Field | Details |
|---|---|
| Metric Name | nudr_config_export_total_requests_total{Method='POST'} |
| Description | Pegging all the POST request received by EXPORT API of configuration service |
| Type | Counter |
| Dimensions | Method |
Table 6-208 export_total_responses
| Field | Details |
|---|---|
| Metric Name | nudr_config_export_total_responses_total{Method='POST'} |
| Description | Pegging the response of EXPORT POST request with response code: 201/400/500 |
| Type | Counter |
| Dimensions |
Method StatusCode |
Table 6-209 export_total_responses
| Field | Details |
|---|---|
| Metric Name | nudr_config_export_status_total_requests_total{Method='GET'} |
| Description | Pegging all the GET request received by EXPORT status API of configuration service |
| Type | Counter |
| Dimensions | Method |
Table 6-210 export_status_total_responses
| Field | Details |
|---|---|
| Metric Name | nudr_config_export_status_total_responses_total{Method='GET'} |
| Description | Pegging the response of GET EXPORT status request with response code: 200/404/500 |
| Type | Counter |
| Dimensions |
Method StatusCode |
Table 6-211 export_report_total_requests
| Field | Details |
|---|---|
| Metric Name | nudr_config_export_report_total_requests_total{Method='GET'} |
| Description | Pegging all the GET Request received by EXPORT report API of config service |
| Type | Counter |
| Dimensions |
Method |
Table 6-212 export_report_total_responses
| Field | Details |
|---|---|
| Metric Name | nudr_config_export_report_total_responses_total{Method='GET'} |
| Description | Pegging the response of GET EXPORT report request with response code: 200/404/500 |
| Type | Counter |
| Dimensions |
Method StatusCode |
Table 6-213 export_download_total_requests
| Field | Details |
|---|---|
| Metric Name | nudr_config_export_download_total_requests_total{Method='GET'} |
| Description | Pegging all the GET request received by EXPORT download API of configuration service |
| Type | Counter |
| Dimensions | Method |
Table 6-214 export_download_total_responses
| Field | Details |
|---|---|
| Metric Name | nudr_config_export_download_total_responses_total{Method='GET'} |
| Description | Pegging the response of GET EXPORT download request with response code: 200/404/500 |
| Type | Counter |
| Dimensions |
Method StatusCode |
Table 6-215 import_total_requests
| Field | Details |
|---|---|
| Metric Name | nudr_config_import_total_requests_total{Method='POST'} |
| Description | Pegging all the POST request received by IMPORT API of configuration service |
| Type | Counter |
| Dimensions | Method |
Table 6-216 import_total_responses
| Field | Details |
|---|---|
| Metric Name | nudr_config_import_total_responses_total{Method='POST'} |
| Description | Pegging the response of IMPORT POST request with response code: 201/400/500 |
| Type | Counter |
| Dimensions |
Method StatusCode |
Table 6-217 import_status_total_requests
| Field | Details |
|---|---|
| Metric Name | nudr_config_import_status_total_requests_total{Method='GET'} |
| Description | Pegging all the GET request received by IMPORT status API of configuration service |
| Type | Counter |
| Dimensions | Method |
Table 6-218 import_status_total_responses
| Field | Details |
|---|---|
| Metric Name | nudr_config_import_status_total_responses_total{Method='GET'} |
| Description | Pegging the response of GET IMPORT status request with response code: 200/404/500 |
| Type | Counter |
| Dimensions |
Method StatusCode |
Table 6-219 import_report_total_requests
| Field | Details |
|---|---|
| Metric Name | nudr_config_import_report_total_requests_total{Method='GET'} |
| Description | Pegging all the GET requests received by IMPORT report API of configuration service |
| Type | Counter |
| Dimensions | Method |
Table 6-220 import_report_total_requests
| Field | Details |
|---|---|
| Metric Name | nudr_config_import_report_total_responses_total{Method='GET'} |
| Description | Pegging the response of GET IMPORT report request with response code: 200/404/500 |
| Type | Counter |
| Dimensions |
Method StatusCode |
Table 6-221 export_tool_controlled_shutdown
| Field | Details |
|---|---|
| Metric Name | export_tool_controlled_shutdown |
| Description | This metric indicates the operational status. For
example,
0 - NORMAL 1 - COMPLETE_SHUTDOWN |
| Type | Guage |
| Dimensions | NA |
Table 6-222 operational_status
| Field | Details |
|---|---|
| Metric Name | nudr_config_operational_status |
| Description | This metric indicates the operational status of UDR. For
example,
0 - NORMAL 1 - COMPLETE_SHUTDOWN |
| Type | Guage |
| Dimensions | NA |
6.8 nrf-client Metrics
The following table provides metrics for nrf-client.
Table 6-223 NRF Instance Status
| Field | Details |
|---|---|
| Metric Name | nrfclient_nrf_operative_status |
| Description | The current operative status of the NRF Instance.
0 - NRF is unavailable/unhealthy 1- NRF is available/healthy |
| Type | Gauge |
| Dimensions | NrfUri - URI of the NRF Instance |
Table 6-224 NRF Instance Status Count
| Field | Details |
|---|---|
| Metric Name | nrfclient_nrf_status_total |
| Description |
Total number of times a NRF Instance is marked as Healthy or Un-healthy apiRoot shall be specified in the format 'scheme'://'fqdn':'port' If Health Check procedure is disabled, all NRF Instances are marked as HEALTHY after Successful NfRegistration. |
| Type | Counter |
| Dimensions | NrfUri- URI of the NRF InstanceHealthStatusFailureReason - Reason for the status |
Table 6-225 NRF Instance Consecutive Healthy Count
| Field | Details |
|---|---|
| Metric Name | nrfclient_nrf_successive_healthy_count |
| Description | The metric shows the consecutive number of times the NRF
is considered as healthy.
The metric shall have a minimum value of 0 and maximum value of healthCheckCount. |
| Type | Counter |
| Dimensions | NrfUri- URI of the NRF Instance |
Table 6-226 NRF Instance Consecutive Unhealthy Count
| Field | Details |
|---|---|
| Metric Name | nrfclient_nrf_successive_unhealthy_count |
| Description | The metric shows the consecutive number of times the NRF
is considered as healthy.
The metric shall have a minimum value of 0 and maximum value of healthCheckCount. |
| Type | Counter |
| Dimensions | NrfUri- URI of the NRF Instance |
Table 6-227 DNS lookup requests
| Field | Details |
|---|---|
| Metric Name | nrfclient_dns_lookup_request_total |
| Description | Total number of times a DNS lookup request is sent to the alternate route service. This metric replaces ocpm_ar_lookup_request_total. |
| Type | Scheme - http or httpsVirtualFqdn - Fqdn that shall be used by the alternate service for the DNS lookup |
| Dimensions | The metric shall be pegged only if enableVirtualNrfResolution is set to true |
Table 6-228 DNS lookup requests
| Field | Details |
|---|---|
| Metric Name | nrfclient_dns_lookup_response_total |
| Description | Total number of times a DNS lookup response is received from the alternate route service. This metric replaces ocpm_ar_lookup_response_total. |
| Type | Scheme - HTTP or HTTPS
VirtualFqdn - Fqdn that shall be used by the alternate service for the DNS lookup HttpStatusCode - The status code as received in the response. |
| Dimensions | The metric shall be pegged only if enableVirtualNrfResolution is set to true |
Table 6-229 DNS setup requests
| Field | Details |
|---|---|
| Metric Name | nrfclient_dns_register_request_total |
| Description | Total number of times a DNS register request is sent to the alternate route service. This metric replaces ocpm_ar_setup_total. |
| Type |
Scheme - http or https VirtualFqdn - FQDN that shall be used by the alternate service for the DNS lookup |
| Dimensions | The metric shall be pegged only if enableVirtualNrfResolution is set to true. |
Table 6-230 NF Load
| Field | Details |
|---|---|
| Metric Name | nrfclient_perf_info_nf_profile_load |
| Description | The current Load of the NF |
| Type | Gauge |
| Dimensions | Not Applicable |
Table 6-231 Current NF Status
| Field | Details |
|---|---|
| Metric Name | nrfclient_current_nf_status |
| Description | The current operative status of the NF.
The gauge indicates the status as below: 0 - REGISTERED1 - DEREGISTERED2 - SUSPENDED3 - UNDISCOVERABLE4 - UNKNOWN |
| Type | Gauge |
| Dimensions |
NfType - The NF's NfType as present in the registered NfProfile. NfInstanceID - The NF's nfInstanceId as present in the registered NfProfile. NfFqdn - The NF's FQDN as present in the registered NfProfile. |
Table 6-232 Current NF Status with NRF
| Field | Details |
|---|---|
| Metric Name | nrfclient_nf_status_with_nrf |
| Description | The operative status of the NF communicated to the NRF.
The gauge must indicate the status as follows:
|
| Type | Gauge |
| Dimensions |
NfType - The NF's NfType as present in the registered NfProfile. NfInstanceID - The NF's nfInstanceId as present in the registered NfProfile. NfFqdn - The NF's FQDN as present in the registered NfProfile. |
Table 6-233 Health Status Subscription Requests
| Field | Details |
|---|---|
| Metric Name | nrfclient_conn_in_subscribe_nrf_health_status_total |
| Description | Total number of Subscribe requests from NF service to to NRF-client to monitor the health status of the configured NRFs |
| Type | counter |
| Dimensions | NotificationURI - The URI received in the request |
Table 6-234 Health Status Subscription Responses
| Field | Details |
|---|---|
| Metric Name | nrfclient_conn_out_subscribe_nrf_health_status_total |
| Description | Total number of Subscribe response from NRF-Client to the subscribed NF service |
| Type | counter |
| Dimensions |
NotificationURI - The URI received in the request HttpStatusCode - The HttpStatusCode of the response |
Table 6-235 Health Status Notification requests
| Field | Details |
|---|---|
| Metric Name | nrfclient_conn_out_notify_nrf_health_status_total |
| Description | Total number of notification sent to subscribed NF services due to health status update |
| Type | counter |
| Dimensions | NotificationURI - The URI to which notifications are sent. |
Table 6-236 Health Status Notification responses
| Field | Details |
|---|---|
| Metric Name | nrfclient_conn_in_notify_nrf_health_status_total |
| Description | Total number of response received for notification request from subscriber |
| Type | counter |
| Dimensions | NotificationURI - The URI to which notification is sent. , HttpStatusCode - The HttpResponseCode as sent by the subscriber, |
Table 6-237 Requests sent by NRF-Client to NRF
| Field | Details |
|---|---|
| Metric Name | nrfclient_nw_conn_out_request_total |
| Description |
Total number of times NRF-client has sent a request to NRF. This includes autonomous requests as well as on-demand requests. |
| Type | counter |
| Dimensions |
MessageType - The service request Type. NfType - The NF's NfType as present in the registered NfProfile. NfInstanceID - The NF's nfInstanceId as present in the registered NfProfile. NfFqdn - The NF's FQDN as present in the registered NfProfile. |
Table 6-238 Responses Received by NRF-Client from NRF
| Field | Details |
|---|---|
| Metric Name | nrfclient_nw_conn_in_response_total |
| Description | Total number of times NRF-client has received a response from NRF. |
| Type | counter |
| Dimensions |
MessageType - The service request Type. NfType - The NF's NfType as present in the registered NfProfile. NfInstanceID - The NF's nfInstanceId as present in the registered NfProfile. NfFqdn - The NF's FQDN as present in the registered NfProfile. StatusCode - The HttpStatusCode as received from NRF. |
Table 6-239 Notification Requests received at NRF-Client
| Field | Details |
|---|---|
| Metric Name | nrfclient_nw_conn_in_notify_request_total |
| Description | Total number of nfStatusNotify requests received from NRF |
| Type | counter |
| Dimensions |
EventType - The EventType for which the notification is triggered, NfInstanceID - The NfInstanceId for which the notification is triggered. |
Table 6-240 Notification responses sent by NRF-Client
| Field | Details |
|---|---|
| Metric Name | nrfclient_nw_conn_out_notify_response_total |
| Description | Total number of nfStatusNotify responses sent to NRF |
| Type | counter |
| Dimensions |
EventType - The EventType for which the notification is triggered, NfInstanceID - The NfInstanceId for which the notification is triggered. HttpStatusCode - The HttpStatusCode sent by NRF-Client. |
Table 6-241 Processing Time for Messages Between NRF-client and NRF
| Field | Details |
|---|---|
| Metric Name | nrfclient_network_message_processing_latency |
| Description | Total message processing time duration |
| Type | Histogram |
| Dimensions | MessageType - The service request Type.
NfType - The NF's NfType as present in the registered NfProfile. NfInstanceID - The NF's nfInstanceId as present in the registered NfProfile. NfFqdn - The NF's FQDN as present in the registered NfProfile. |
Table 6-242 Requests Sent to app-info service
| Field | Details |
|---|---|
| Metric Name | nrfclient_app_info_conn_out_request_total |
| Description | Total Number of requests sent to app-info service. |
| Type | Histogram |
| Dimensions | NfType - The NF's NfType as present in the registered NfProfile. |
Table 6-243 Responses Received from app-info service
| Field | Details |
|---|---|
| Metric Name | nrfclient_app_info_conn_in_response_total |
| Description | Total number of responses received from app-info service |
| Type | Counter |
| Dimensions |
NfType - The NF's NfType as present in the registered NfProfile. StatusCode - The HttpStatusCode sent by app-info. |
6.9 nudr-bulk-import-service Metrics
The following table provides metrics for nudr-bulk-import microservice of UDR.
Table 6-244 nudr_bulk_import_records_provisioned_total
| Field | Details |
|---|---|
| Metric Name | nudr_bulk_import_records_provisioned_total{StatusCode="204/201/500/400/404/503" ,Status="Success/Failure", NFType="PCF/SLF/PCF-VSA/EIR"} |
| Description | Total number of success or failure records provisioned in UDR for PCF or SLF or PCF-VSA or EIR |
| Type | Counter |
| Dimensions |
StatusCode Status NFType |
Table 6-245 nudr_bulk_import_csvfile_records_read_total
| Field | Details |
|---|---|
| Metric Name | nudr_bulk_import_csvfile_records_read_total{Method="DELETE/PUT/POST/PATCH" , Status="Success/Failure"} |
| Description | Total number of successful record reads from CSV file for DELETE, PUT, PATCH, POST operation. |
| Type | Counter |
| Dimensions |
Method Status |
Table 6-246 nudr_bulk_import_records_processed_total
| Field | Details |
|---|---|
| Metric Name | nudr_bulk_import_records_processed_total{Method = "POST/PUT/DELETE/PATCH" , StatusCode="201/204/500/404/400/503", Status="Success/Failure"} |
| Description | Total number of records processed from CSV file. |
| Type | Counter |
| Dimensions |
Method StatusCode Status |
Table 6-247 nudr_bulk_import_tool_pvc_full_usage
| Field | Details |
|---|---|
| Metric Name | nudr_bulk_import_tool_pvc_full_usage{container="nudr-bulk-import",namespace="ocudr"} |
| Description | Storage for Bulk Import tool is full |
| Type | Counter |
| Dimensions | container="nudr-bulk-import" |
Table 6-248 nudr_xmltocsv_xmlfile_records_read_total
| Field | Details |
|---|---|
| Metric Name | nudr_xmltocsv_xmlfile_records_read_total{Status="Success/Failure"} |
| Description | Total number of successful record reads from ixml file. |
| Type | Counter |
| Dimensions | Status |
Table 6-249 nudr_xmltocsv_records_processed_total
| Field | Details |
|---|---|
| Metric Name | nudr_xmltocsv_records_processed_total{Method = "POST/PUT/DELETE/PATCH", Status="Success/Failure"} |
| Description | Total number of xml records converted Success/Failure |
| Type | Counter |
| Dimensions |
Method Status |
Table 6-250 nudr_bulk_import_tool_pvc_full_usage
| Field | Details |
|---|---|
| Metric Name | nudr_bulk_import_tool_pvc_full_usage{container="nudr-xmltocsv",namespace="ocudr"} |
| Description | Storage for XML Bulk Import tool is full |
| Type | Counter |
| Dimensions | container="nudr-xmltocsv" |
Table 6-251 nudr_pdbi_to_csv_file_records_read
| Field | Details |
|---|---|
| Metric Name | nudr_pdbi_to_csv_file_records_read{Status="Success"} |
| Description | Total number of successful record reads from PDBI file |
| Type | Counter |
| Dimensions | Status |
Table 6-252 nudr_pdbi_to_csv_records_processed
| Field | Details |
|---|---|
| Metric Name | nudr_pdbi_to_csv_records_processed(Status="Success",Method="CREATE,MODIFY,DELETE") |
| Description | Total number of pdbi records processed |
| Type | Counter |
| Dimensions |
Method Status |
Table 6-253 nudr_pdbi_to_csv_records_processed
| Field | Details |
|---|---|
| Metric Name | nudr_pdbi_to_csv_records_processed_failed_total |
| Description | Total number of pdbi records processed failed |
| Type | Counter |
| Dimensions | container="nudr-pdbitocsv" |
Table 6-254 nudr_bulk_import_tool_pvc_full_usage
| Field | Details |
|---|---|
| Metric Name | nudr_bulk_import_tool_pvc_full_usage{container="nudr-pdbitocsv",namespace="ocudr"} |
| Description | Storage for PDBI Bulk Import tool is full |
| Type | Counter |
| Dimensions | container="nudr-bulk-import" |
Table 6-255 bulkimport_files_fetched_from_remote_total
| Field | Details |
|---|---|
| Metric Name | bulkimport_files_fetched_from_remote_total |
| Description | Total number of files that are transferred from remote to pvc |
| Type | Counter |
| Dimensions | NA |
Table 6-256 bulkimport_files_fetched_from_remote_status_total
| Field | Details |
|---|---|
| Metric Name | bulkimport_files_fetched_from_remote_status_total{status="success/failed",reason="CANNOT_CONNECT_TO_HOST/ACCESS_DENIED_TO_REMOTE/FILE_SIZE_NOT_AS_EXPECTED/LOGIN_DENIED/OUT_OF_SPACE"} |
| Description | Total number of files that are transferred from remote to pvc with status success/failure |
| Type | Counter |
| Dimensions | Status |
Table 6-257 bulkimport_files_transferred_to_remote_total
| Field | Details |
|---|---|
| Metric Name | bulkimport_files_transferred_to_remote_total |
| Description | Total number of files that are transferred from pvc to remote |
| Type | Counter |
| Dimensions | NA |
Table 6-258 bulkimport_files_transferred_to_remote_status_total
| Field | Details |
|---|---|
| Metric Name | bulkimport_files_transferred_to_remote_status_total{status="success/failed",reason="CANNOT_CONNECT_TO_HOST/ACCESS_DENIED_TO_REMOTE/FILE_SIZE_NOT_AS_EXPECTED/LOGIN_DENIED/OUT_OF_SPACE"} |
| Description | Total number of files that are transferred from pvc to remote with status success/failure |
| Type | Counter |
| Dimensions | status |
Table 6-259 bulkimport_transfer_in_status
| Field | Details |
|---|---|
| Metric Name | bulkimport_transfer_in_status |
| Description | Transfer-in status , 0 - success and 1- failure |
| Type | Gauge |
| Dimensions | NA |
Table 6-260 bulkimport_transfer_out_status
| Field | Details |
|---|---|
| Metric Name | bulkimport_transfer_out_status |
| Description | Transfer-in status , 0 - success and 1- failure |
| Type | Gauge |
| Dimensions | NA |
6.10 nudr-export-tool service Metrics
Note:
Prometheus automatically appends the word total to all the counter type metrics that are displayed on the Prometheus dashboard.Table 6-261 Export Status Aggregate
| Field | Details |
|---|---|
| Metric Name | export_tool_status_total{status="success/fail"} |
| Description | Total number of success or failure export operations. |
| Type | Counter |
| Dimensions |
Status |
Table 6-262 Total Export Operations
| Field | Details |
|---|---|
| Metric Name | export_tool_backUp_taken_total |
| Description | Total number of export operation triggered. |
| Type | Counter |
| Dimensions |
NA |
Table 6-263 Export Failure Indicator
| Field | Details |
|---|---|
| Metric Name | export_failure |
| Description | Gauge indicating export operation
failure.
Values: 0: Success 1: Failure |
| Type | Gauge |
| Dimensions |
NA |
Table 6-264 PVC Full Indication
| Field | Details |
|---|---|
| Metric Name | export_tool_full_usage |
| Description | Gauge indicating PVC full usage.
Values: PVC Full: 1 PVC normal: 0 |
| Type | Gauge |
| Dimensions |
NA |
Table 6-265 Total File Transfer Attempts
| Field | Details |
|---|---|
| Metric Name | nudr_export_tool_total_file_transfers_total |
| Description | Total number of file transfer attempts. |
| Type | Counter |
| Dimensions |
NA |
Table 6-266 Successfull File Transfer Attempts
| Field | Details |
|---|---|
| Metric Name | nudr_export_tool_successful_file_transfers_total |
| Description | Total number of successful file transfer attempts |
| Type | Counter |
| Dimensions | status |
Table 6-267 Failed File Transfer Attempts
| Field | Details |
|---|---|
| Metric Name | nudr_export_tool_failed_file_transfers_total |
| Description | Total number of failed file transfer
attempts.
status=failed,reason=CANNOT_CONNECT_TO_HOST,ACCESS_DENIED_TO_REMOTE,FILE_SIZE_NOT_AS_EXPECTED, LOGIN_DENIED,OUT_OF_SPACE |
| Type | Counter |
| Dimensions | status, reason |
Table 6-268 Operational state of the NF
| Field | Details |
|---|---|
| Metric Name | export_tool_controlled_shutdown |
| Description | Gives the operational state of the NF. For example, 0- NORMAL and 1- COMPLETE_SHUTDOWN |
| Type | Gauge |
| Dimensions | NA |
6.11 app-info Metrics
The following table provides metrics for app-info microservice.
Table 6-269 appinfo_service_running
| Field | Details |
|---|---|
| Metric Name | appinfo_service_running |
| Description | The status of monitored services |
| Type | Integer: 0,1 |
| Dimensions |
|
Table 6-270 appinfo_category_running
| Field | Details |
|---|---|
| Metric Name | appinfo_category_running |
| Description | The status of monitored categories |
| Type | Integer: 0,1 |
| Dimensions |
|
Table 6-271 appinfo_category_good
| Field | Details |
|---|---|
| Metric Name | appinfo_category_good |
| Description | The readiness of monitored categories |
| Type | Integer: 0,1 |
| Dimensions |
|
6.12 perf-info Metrics
The following table provides metrics for perf-info microservice.
Table 6-272 nf_load_info
| Field | Details |
|---|---|
| Metric Name | nf_load_info |
| Description | Service load info |
| Type | Float |
| Dimensions |
|
Table 6-273 jvm_cpu_usage
| Field | Details |
|---|---|
| Metric Name | jvm_cpu_usage |
| Description | Springboot per service jvm_cpu_usage |
| Type | Float |
| Dimensions |
|
Table 6-274 jvm_memory
| Field | Details |
|---|---|
| Metric Name | jvm_memory |
| Description | Springboot per service jvm_memory |
| Type | Float |
| Dimensions |
|
Table 6-275 cgroup_cpu_nanoseconds
| Field | Details |
|---|---|
| Metric Name | cgroup_cpu_nanoseconds |
| Description | It reports the total CPU time in nanoseconds on each CPU core for all tasks in the cgroup |
| Type | Float |
| Dimensions | NA |
Table 6-276 cgroup_memory_bytes
| Field | Details |
|---|---|
| Metric Name | cgroup_memory_bytes |
| Description | It reports the memory usage which is fairly straight forward to monitor |
| Type | Float |
| Dimensions | NA |
Table 6-277 load_level
| Field | Details |
|---|---|
| Metric Name | load_level |
| Description | The overload manager load level info |
| Type | Float |
| Dimensions | 0,1,2,3,4 |
Table 6-278 service_resource_stress
| Field | Details |
|---|---|
| Metric Name | service_resource_stress |
| Description | Tracks CPU, failures, and pending requests based on which the service calculates the overload level. |
| Type | NA |
| Dimensions |
|
Table 6-279 service_resource_overload_level
| Field | Details |
|---|---|
| Metric Name | service_resource_overload_level |
| Description | Tracks individual resource overload level. |
| Type | 0,1,2,3,4 |
| Dimensions |
|
6.13 Diameter Gateway Metrics
The following table provides metrics for Diameter Gateway.
Table 6-280 diam_conn_network
| Field | Details |
|---|---|
| Metric Name | diam_conn_network |
| Description | Tracks total number of active diameter connections with network peers. |
| Type | Gauge |
| Dimensions | destHost, destRealm, origHost, origRealm, direction from CER |
Table 6-281 diam_conn_network
| Field | Details |
|---|---|
| Metric Name | diam_conn_network_uptime_ms |
| Description | Tracks duration of active diameter connection with network peer. |
| Type | Histogram |
| Dimensions | destHost, destRealm, origHost, origRealm, direction, sduration |
Table 6-282 diam_conn_local
| Field | Details |
|---|---|
| Metric Name | diam_conn_local |
| Description | Tracks active diameter connection with local backend services. |
| Type | Gauge |
| Dimensions | destHost, destRealm, origHost, origRealm, direction from CER |
Table 6-283 diam_conn_local_uptime_ms
| Field | Details |
|---|---|
| Metric Name | diam_conn_local_uptime_ms |
| Description | Tracks overall up time of a diameter connection with local services. |
| Type | Histogram |
| Dimensions | destHost, destRealm, origHost, origRealm, direction, sduration |
Table 6-284 diam_request_network_total
| Field | Details |
|---|---|
| Metric Name | diam_request_network_total |
| Description | Tracks total number of request messages of a given command code to the network or from the network. |
| Type | Counter |
| Dimensions | destHost, destRealm, origHost, origRealm, appId, cmdCode, msgType, direction |
Table 6-285 diam_response_network_total
| Field | Details |
|---|---|
| Metric Name | diam_response_network_total |
| Description | Tracks total number of answer messages of a given command code to the network or from the network. |
| Type | Counter |
| Dimensions | reqDestHost, reqDestRealm, reqOrigHost, reqOrigRealm, appId, cmdCode, msgType, direction, responseCode |
Table 6-286 diam_response_network_processing_latency_ms
| Field | Details |
|---|---|
| Metric Name | diam_response_network_processing_latency_ms |
| Description | Tracks overall response time of a diameter answer of a given command code to or from the network. |
| Type | Histogram |
| Dimensions | reqDestHost, reqDestRealm, reqOrigHost, reqOrigRealm, appId, cmdCode, msgType, direction, duration |
Table 6-287 diam_request_local_total
| Field | Details |
|---|---|
| Metric Name | diam_request_local_total |
| Description | Tracks total number of request messages of a given command code to or from local service. |
| Type | Counter |
| Dimensions | destHost, destRealm, origHost, origRealm, appId, cmdCode, msgType, direction |
Table 6-288 diam_response_local_total
| Field | Details |
|---|---|
| Metric Name | diam_response_local_total |
| Description | Tracks total number of answer messages of a given command code to or from the local service. |
| Type | Counter |
| Dimensions | reqDestHost, reqDestRealm, reqOrigHost, reqOrigRealm, appId, cmdCode, msgType, direction, responseCode |
Table 6-289 diam_response_local_processing_latency_ms
| Field | Details |
|---|---|
| Metric Name | diam_response_local_processing_latency_ms |
| Description | Tracks overall response time of a diameter answer of a given command code to or from local service. |
| Type | Histogram |
| Dimensions | reqDestHost, reqDestRealm, reqOrigHost, reqOrigRealm, appId, cmdCode, msgType, direction, duration |
Table 6-290 diam_request_inter_total
| Field | Details |
|---|---|
| Metric Name | diam_request_inter_total |
| Description | Tracks total number of request messages sent or received during inter-pod routing. |
| Type | Counter |
| Dimensions | destHost, destRealm, origHost, origRealm, appId, cmdCode, msgType, direction, srcPodIp, dsrPodIp |
Table 6-291 diam_response_inter_total
| Field | Details |
|---|---|
| Metric Name | diam_response_inter_total |
| Description | Tracks total number of answer messages sent or received during inter-pod routing. |
| Type | Counter |
| Dimensions | reqDestHost, reqDestRealm, reqOrigHost, reqOrigRealm, appId, cmdCode, msgType, direction, srcPodIp, dsrPodIp, responseCode |
Table 6-292 diam_response_inter_latency_ms
| Field | Details |
|---|---|
| Metric Name | diam_response_inter_latency_ms |
| Description | Tracks overall response time of a diameter answer of a given command code for inter-pod messages. It tracks response only from a pod that initiates inter-pod routing. |
| Type | Histogram |
| Dimensions | reqDestHost, reqDestRealm, reqOrigHost, reqOrigRealm, appId, cmdCode, msgType, direction, srcPodIp, dsrPodIp, duration |
Table 6-293 ocudr_pod_congestion_state
| Field | Details |
|---|---|
| Metric Name | ocudr_pod_congestion_state |
| Description | Overall diameter gateway pod state.
Different states of pod:
|
| Type | Gauge |
| Dimensions | NA |
Table 6-294 ocudr_pod_resource_congestion_state
| Field | Details |
|---|---|
| Metric Name | ocudr_pod_resource_congestion_state |
| Description | Different resource state of the pod.
Different types of resource in pod state are as follows:
Each resource state as follows:
|
| Type | Gauge |
| Dimensions | type |
Table 6-295 ocudr_diam_congestion_message_reject_total
| Field | Details |
|---|---|
| Metric Name | ocudr_diam_congestion_message_reject_total |
| Description | Rejected messages if the configured priority is less than message priority. |
| Type | Counter |
| Dimensions | priority,responseCode,destHost,destRealm,origRealm,origHost,appId,cmdCode,msgType |
6.14 Nudr-dbcr-auditor-service
The following table provides metrics for Auditor Service.
Table 6-296 nudr_dbcr_auditor_service_monitor_total
| Field | Details |
|---|---|
| Metric Name | nudr_dbcr_auditor_service_monitor_total |
| Description | The total number of completed exception tables audit cycle. |
| Type | Counter |
| Dimensions | NA |
Table 6-297 nudr_dbcr_auditor_service_clear_total
| Field | Details |
|---|---|
| Metric Name | nudr_dbcr_auditor_service_clear_total |
| Description | The total number of completed exception tables clearing cycle. |
| Type | Counter |
| Dimensions | NA |
Table 6-298 nudr_dbcr_auditor_service_delete_total
| Field | Details |
|---|---|
| Metric Name | nudr_dbcr_auditor_service_delete_total |
| Description | The total number of deletions done from data and exception tables which includes total number of rows deleted from IDXTODATA/IDXTODATA$EX, other data tables and corresponding exception tables. |
| Type | Counter |
| Dimensions | NA |