7 Binding Support Function Metrics

BSF Metrics

This chapter includes information about Metrics for Oracle Communications Cloud Native Core, Binding Support Function (BSF).

BSF uses the observability tool Grafana to analyze and visualize data. The Grafana Dashboard consists of panels displaying the data as graphs, charts or other visualizations. A dashboard in Grafana is represented by a JSON object, which stores the metadata of its dashboard. Following Grafana dashboards are created for BSF Observability and debugging purposes:
  • Observability Dashboard:
    • This dashboard metadata is stored in the BSF_Observability_Dashboard.json file.
    • This dashboard has the panels that monitors the overall health status of the setup & contains details like resource utilization, kmps, latency, etc.
    • Customers can use this Dashboard on a regular basis for observing the status of the setup and also for assessing the setup performance with a run.
    • Depending upon the applicability of a panel or row, the customers have the flexibility to either remove, update or add content to the Dashboard.
  • Debug Dashboard:
    • This dashboard metadata is stored in the BSF_Debug_Dashboard.json file.
    • This dashboard has the panels that monitor the operational status of the setup and is used for debugging & troubleshooting purposes.
    • Customers can use this Dashboard when any issue occur in the NF and also when reporting a probable issue to Oracle Customer Support from the setup.
    • Depending upon the applicability of a panel or row, the customers have the flexibility to either remove, update or add content to the Dashboard.

7.1 Egress Gateway Metrics for SCP

This section provides details about SCP health monitoring metrics and the respective dimensions.

Table 7-1 ocbsf_oc_egressgateway_peer_health_status

Field Details
Description

It defines Egress Gateway peer health status.

  • This metric is set to 1, if a peer is unhealthy.
  • This metric is reset to 0, when it becomes healthy again.
  • This metric is set to -1, if peer is removed from peerconfiguration.
Type Gauge
Dimensions
  • peer
  • vfqdn
Examples
  • ocbsf_oc_egressgateway_peer_health_status{"peer":"10.75.213.172:8080"} 1.0
  • ocbsf_oc_egressgateway_peer_health_status{"peer":"10.75.213.172:8080"} 0.0
  • ocbsf_oc_egressgateway_peer_health_status{"vfqdn":"http://abc.com","peer":"10.75.213.172:8080"} 1.0
  • ocbsf_oc_egressgateway_peer_health_status{"vfqdn":"http://abc.com","peer":"10.75.213.172:8080"} 0.0

Table 7-2 ocbsf_oc_egressgateway_peer_health_ping_request

Field Details
Description This metric is incremented every time a health ping is sent toward a peer.
Type Counter
Dimensions
  • peer
  • vfqdn
Examples
  • ocbsf_oc_egressgateway_peer_health_ping_request{"peer":"10.75.213.172:8080"} 389.0
  • ocbsf_oc_egressgateway_peer_health_ping_request{"peer":"10.75.213.172:8080"} 439.0
  • ocbsf_oc_egressgateway_peer_health_ping_request{"vfqdn":"http://abc.com","peer":"10.75.213.172:8080"} 389.0
  • ocbsf_oc_egressgateway_peer_health_ping_request{"vfqdn":"http://abc.com","peer":"10.75.213.172:8080"} 439.0

Table 7-3 ocbsf_oc_egressgateway_peer_health_ping_response

Field Details
Description This metric is incremented every time a health ping response is received from a peer irrespective of success or failure.
Type Counter
Dimensions
  • peer
  • vfqdn
  • statusCode
  • cause
Examples
  • ocbsf_oc_egressgateway_peer_health_ping_response{"peer":"10.75.213.172:8080","status":"httpstatus","cause":""} 89.0
  • ocbsf_oc_egressgateway_peer_health_ping_response{"peer":"10.75.213.172:8080","status":"Exception","cause":"exception cause"} 39.0
  • ocbsf_oc_egressgateway_peer_health_ping_response{"vfqdn":"http://abc.com","status":"httpstatus","cause":""} 89.0
  • ocbsf_oc_egressgateway_peer_health_ping_response{"vfqdn":"http://abc.com","status":"Exception","cause":"exception cause"} 39.0

Table 7-4 ocbsf_oc_egressgateway_peer_health_status_transitions

Field Details
Description This metric is incremented every time a peer is transitioned from Availble to Unavailable or from Unavailable to Available.
Type Counter
Dimensions
  • peer
  • vfqdn
  • from
  • to
Examples
  • ocbsf_oc_egressgateway_peer_health_status_transitions{"identifier":"10.75.213.172:8080","from":"available","to":"unavailable"} 14.0
  • ocbsf_oc_egressgateway_peer_health_status_transitions{"identifier":"10.75.213.172:8080","from":"unavailable","to":"available"} 34.0
  • ocbsf_oc_egressgateway_peer_health_status_transitions{"vfqdn":"http://abc.com","peer":"10.75.213.172:8080","from":"unavailable","to":"available"} 34.0
  • ocbsf_oc_egressgateway_peer_health_status_transitions{"vfqdn":"http://abc.com","peer":"10.75.213.172:8080","from":"available","to":"unavailable"} 14.0

Table 7-5 ocbsf_oc_egressgateway_peer_count

Field Details
Description This metric is incremented every time for the peer count.
Type Gauge
Dimensions
  • peerset
Example ocbsf_oc_egressgateway_peer_count{"peerset":"set-0"} 3.0

Table 7-6 ocbsf_oc_egressgateway_peer_available_count

Field Details
Description This metric is incremented every time for the available peer count.
Type Gauge
Dimensions
  • peerset
Example ocbsf_oc_egressgateway_peer_available_count{"peerset":"set-0"} 4.0

7.2 Correlation-Info Header Metrics

For every correlation-info header received or newly generated, a metric will be pegged. Following are the list of metrics:

Below mention table list the metrics that shall be implemented as part of this feature with the following Dimensions:

  1. operation_type= {"create","update","delete","subscribe","unsubscribe","terminate","register","deregister"....}
  2. correlation_info_type={"imsi", "msisdn", "imsi,msisdn"}

Table 7-7 ocbsf_correlation_info_header_received

Field Details
Description

BSF reports total outgoing request that are carried by the correlation-info header.
Type Counter
Dimensions
  • operation_type
  • correlation_info_type
Example ocbsf_correlation_info_header_received_total '{correlation_info_type="imsi", operation_type="create"}',2

Table 7-8 ocbsf_correlation_info_header_forwarded

Field Details
Description

BSF reports total incoming request that are carried by the correlation-info header.
Type Counter
Dimensions
  • operation_type
  • correlation_info_type
Example ocbsf_correlation_info_header_received_total '{correlation_info_type="imsi", operation_type="update"}',1

Table 7-9 ocbsf_correlation_info_header_generated

Field Details
Description

BSF reports the total responses carried by the correlation-info header.
Type Counter
Dimensions
  • operation_type
  • correlation_info_type
Examples
  • ocbsf_correlation_info_header_forwarded_total '{correlation_info_type="imsi", operation_type="subscribe"}',2
  • ocbsf_correlation_info_header_generated_total '{correlation_info_type="imsi", operation_type="create"}',2

7.3 Configuration Server Metrics

Table 7-10 topic_version

Field Details
Description

Configuration service will have this metrics a database value from each topic version.

The Services fetching the configurations from Configuration Server, will have its current topic version till which configurations has been fetched successfully.
Type Gauge
Dimensions
  • Service Name
  • Pod Name
Examples
  • topic_version{topicName="common.congestionthreshold.diam-gateway",} 1.0
  • topic_version{topicName="common.auditservice.cfg",} 1.0
  • topic_version{topicName="bsf.sbi.errorcodes",} 36.0
  • topic_version{topicName="common.diamsetting",} 2.0
  • topic_version{topicName="common.public.diammessagepriority",} 2.0
  • topic_version{topicName="bsf.managementservice",} 1.0
  • topic_version{topicName="subscriber.activity.logging.idlist.bsf",} 1.0
  • topic_version{topicName="public.policy.error.handler.config",} 1.0
  • topic_version{topicName="common.public.diampeernode",} 5.0
  • topic_version{topicName="nrfclient.cfg",} 1.0
  • topic_version{topicName="common.public.diamloadshedding",} 2.0
  • topic_version{topicName="diameter.errorcodes",} 7.0
  • topic_version{topicName="common.public.diamroutingtable",} 1.0
  • topic_version{topicName="subscriber.activity.logging.mapping.bsf",} 1.0
  • topic_version{topicName="bsf.global.cfg",} 1.0
  • topic_version{topicName="common.public.diamcontrolledshutdown",} 1.0
  • topic_version{topicName="config.level",} 53.0
  • topic_version{topicName="diameter.customerrorcodes",} 1.0

7.4 Active Sessions Count Metrics

Table 7-11 oc_db_active_session_count

Field Details
Description Active sessions count
Type Gauge
Dimensions
  • Service
  • Table

Table 7-12 inbound_requests_total

Field Details
Description Inbound requests total (number of requests received via CM/REST to get instantaneous Active Session Count)
Type Counter
Dimensions
  • requestType (onDemandActiveSessionCount, register, deregister)
  • tableName

7.5 AppInfo Metrics

Table 7-13 appinfo_service_running

Field Details
Description Provides the status of monitored services.
Type Gauge
Dimensions
  • service
  • namespace
  • category
Example appinfo_service_running{service="xxx",namespace="xxx",category="xxx"} 1

Table 7-14 appinfo_category_running

Field Details
Description Provides the status of monitored categories.
Type Gauge
Dimensions
  • namespace
  • category
Example
  • appinfo_category_running{category="xxx",namespace="xxx"} 1
  • appinfo_category_good{category="xxx",namespace="xxx"} 1

Table 7-15 appinfo_category_good

Field Details
Description Provides the readiness of monitored categories.
Type Gauge
Dimensions
  • namespace
  • category

Table 7-16 nfscore

Field Details
Description
  • factor
    • Contains one of the values: all, successTPS, serviceHealth, signallingConnections, replicationHealth, localityPreference.
    • When the factor is set to all that means NF score is calculated for all the factors.
  • status
    • success: when the factor is enabled and its value is fetched successfully.
    • failed: when the factor is enabled and fetching the value fails.
    • notCalculated: when the factor is disabled.
Type Gauge
Dimensions
  • nfInstanceID
  • factor
  • Status
Example
  • nfscore{app="testing-appinfo", app_kubernetes_io_instance="testing", app_kubernetes_io_managed_by="Helm", app_kubernetes_io_name="appinfo", app_kubernetes_io_part_of="ocbsf", app_kubernetes_io_version="1.7.1.0.0", application="ocbsf", calculatedStatus="success", container="appinfo", endpoint="cnc-metrics", engVersion="22.4.0-rc.5", factor="localityPreference", helm_sh_chart="appinfo-22.4.0-rc.5", instance="10.233.117.146:9000", job="occne-infra/occne-nf-cnc-podmonitor", microservice="bsf-app-info", mktgVersion="1.7.1.0.0", namespace="biloxi-ns", nfInstanceID="fe7d992b-0541-4c7d-ab84-c6d70b1b0666", pod="testing-appinfo-78dc65865f-hgrhk", pod_template_hash="78dc65865f", vendor="Oracle"} 5

Table 7-17 nfScoringFactorActualValue

Field Details
Description factor tag would contain one of the following values: successTPS, serviceHealth, signallingConnections, replicationHealth, localityPreference
Type Gauge
Dimensions
  • nfInstanceID
  • factor
Example
  • nfScoringFactorActualValue{app="testing-appinfo", app_kubernetes_io_instance="testing", app_kubernetes_io_managed_by="Helm", app_kubernetes_io_name="appinfo", app_kubernetes_io_part_of="ocbsf", app_kubernetes_io_version="1.7.1.0.0", application="ocbsf", calculatedStatus="success", container="appinfo", endpoint="cnc-metrics", engVersion="22.4.0-rc.5", factor="localityPreference", helm_sh_chart="appinfo-22.4.0-rc.5", instance="10.233.117.146:9000", job="occne-infra/occne-nf-cnc-podmonitor", microservice="bsf-app-info", mktgVersion="1.7.1.0.0", namespace="biloxi-ns", nfInstanceID="fe7d992b-0541-4c7d-ab84-c6d70b1b0666", pod="testing-appinfo-78dc65865f-hgrhk", pod_template_hash="78dc65865f", vendor="Oracle"} 5

7.6 Audit Service Metrics

The following table describes the Audit Service metrics and respective dimensions:

Table 7-18 audit_recs_stale_total

Field Details
Description Number of records detected as stale.
Type Counter
Dimensions

  • ServiceName

  • TableName
Example audit_recs_stale_total{ServiceName="bsf-management-service",TableName="pcf_binding",} 1.0

Table 7-19 audit_recs_notif_total

Field Details
Description Number of stale record notifications sent, applicable for modes: NOTIFY and DELETE_NOTIFY.
Type Counter
Dimensions

ServiceName
Example audit_recs_notif_total{ServiceName="bsf-management-service",} 1.0

Table 7-20 audit_recs_deque_for_notif_total

Field Details
Description Number of stale records dequeued to send Notification.
Type Counter
Dimensions

ServiceName
Example audit_recs_deque_for_notif_total{ServiceName="bsf-management-service",} 1.0

Table 7-21 audit_recs_enque_for_notif_total

Field Details
Description Number of stale records enqueued from Database.
Type Counter
Dimensions

ServiceName
Example audit_recs_enque_for_notif_total{ServiceName="bsf-management-service",} 1.0

Table 7-22 oc_db_active_session_count

Field Details
Description Reports the session for a given service.
Type Gauge
Dimensions

  • ServiceName

  • TableName
Example oc_db_active_session_count{Service="bsf-management-service",Table="pcfbinding",} 1.0

Table 7-23 topic_version

Field Details
Description Describes the current applied version of a given topic (mentioned in dimension topic_name) into the pod.
Type Gauge
Dimensions
  • Service Name
  • Pod Name

7.7 BSF Management Service

This section describes the metrics used for BSF Management service.

The following table provides information about metrics related to BSF Management service.

Table 7-24 ocbsf_ingress_response_total

Field Details
Description This metric is pegged when BSF sends a response message through Ingress Gateway.
Type Gauge
Dimensions operation_type

dnn

snssai

application_error_code

response_code

binding_level

binding_id
Example ocbsf_ingress_response_total{application="bsf-management-service",application_error_code="",binding_id="setxyz.bsfset.5gc.mnc015.mcc360,setxyz.bsfset.5gc.mnc015.mcc350",binding_level="nf-set",dnn="dnn1",operation_type="register",response_code="2xx",snssai="100-D143A5",}

Table 7-25 ocbsf_ingress_request_total

Field Details
Description This metric is pegged when BSF receives a request message through Ingress Gateway.
Type Gauge
Dimensions operation_type

dnn

snssai

pcf_set_id

pcf_id
Example ocbsf_ingress_request_total{application="bsf-management-service",dnn="dnn1",operation_type="register",pcf_id="somePcfId",pcf_set_id="somePcfSetId",snssai="100-D143A5",} 1.0

Table 7-26 ocbsf_audit_notif_request_count_total

Field Details
Description This metric is pegged when BSF receives a notification request from the audit service for stale bindings.
Type Counter
Dimensions application
Example ocbsf_audit_notif_request_count_total{application="bsf-management-service",operation_type="audit_notify",} 1.0

Table 7-27 ocbsf_audit_notif_response_count_total

Field Details
Description This metric is pegged when BSF sends a notification response for the request received from the Audit service for stale bindings.
Type Counter
Dimensions application
Example ocbsf_audit_notif_response_count_total{application="bsf-management-service",operation_type="audit_notify",response_code="2xx",} 1.0

Table 7-28 ocbsf_audit_delete_records_count_total

Field Details
Description This metric is pegged when BSF successfully deletes stale bindings.
Type Counter
Dimensions application
Example ocbsf_audit_delete_records_count_total{application="bsf-management-service",operation_type="audit_notify",} 1.0

Table 7-29 ocbsf_audit_delete_records_max_ttl_count_total

Field Details
Description This metric is pegged when the BSF successfully deletes bindings on receiving maxTTL as 'true'
Type Counter
Dimensions application
Example ocbsf_audit_delete_records_count_total{application="bsf-management-service",operation_type="audit_notify",} 1.0

Table 7-30 ocbsf_diamgw_notification_request_count_total

Field Details
Description This metric is pegged when BSF management service receives stale binding notification request from Diameter Gateway.
Type Counter
Dimensions application
Example ocbsf_diamgw_notification_request_count_total{application="bsf-management-service",operation_type="audit_notify",} 1.0

Table 7-31 ocbsf_diamgw_notification_response_count_total

Field Details
Description This metric is pegged when BSF management service sends a response for the stale binding notification request from Diameter Gateway.
Type Counter
Dimensions application
Example ocbsf_diamgw_notification_response_count_total{application="bsf-management-service",operation_type="audit_notify",} 1.0

Table 7-32 ocbsf_diamgw_delete_records_count_total

Field Details
Description This metric is pegged when BSF management service successfully deletes stale PCF bindings due to Diameter Gateway notification requests.
Type Counter
Dimensions application
Example ocbsf_diamgw_delete_records_count_total{application="bsf-management-service",operation_type="audit_notify",} 1.0

Table 7-33 ocbsf_query_request_count_total

Field Details
Description This metric is pegged when BSF management service sends request to PCF to confirm if PcfBinding is stale or not.
Type Counter
Dimensions

  • application

  • operation_type

  • response_code
Example ocbsf_query_request_count_total{application="bsf-management-service",operation_type="query",response_code="2xx",} 1.0

Table 7-34 ocbsf_query_response_count_total

Field Details
Description This metric is pegged when BSF management service receives a response for PcfBinding stale confirmation request.
Type Counter
Dimensions application
Example ocbsf_query_response_count_total{application=“bsf-management-service”,operation_type=“query”,response_code=“timeout”,} 1.0

Table 7-35 ocbsf_http_out_conn_request_total

Field Details
Description This metric is pegged when BSF sends notification request using HTTP in Diameter Gateway.
Type Counter
Dimensions

operation_type (delete)

serviceResource

servicename3gpp (DiameterGateway)

Table 7-36 ocbsf_http_out_conn_response_total

Field Details
Description This metric is pegged when BSF receives response for notification request requests using HTTP in Diameter Gateway.
Type Counter
Dimensions

operation_type (delete)

responseCode

serviceResource

servicename3gpp (DiameterGateway)

Table 7-37 ocbsf_bindingQuery_request_total

Field Details
Description This metric is pegged when BSF receives a query request for PCF bindings. PCF Binding query-service sends SUPI, GPSI, IPv4 address, IPv6 address, and mac address to BSF.
Type Counter
Dimensions

operation_type (query)

criteria_type (SUPI/GPSI/UE Address)
Example ocbsf_bindingQuery_request_total{application="bsf-managementservice",gpsi="false",ipv4Addr="true",ipv6Prefix="false",macAddr48="false",operation_type="query",supi="true",} 1.0

Table 7-38 ocbsf_bindingQuery_response_total

Field Details
Description This metric is pegged when BSF sends a response message for a PCF bindings query request. PCF Binding query-service sends SUPI, GPSI, IPv4 address, IPv6 address, and mac address to BSF.
Type Counter
Dimensions response_code (2xx, 4xx)

operation_type (query)

criteria_type (SUPI/GPSI/UE Address)
Example ocbsf_bindingQuery_response_total{application="bsf-managementservice",application_error_code="",gpsi="false",ipv4Addr="true",ipv6Prefix="false",macAddr48="false",operation_type="query",response_code="2xx",supi="true",} 1.0

Table 7-39 ocbsf_bindingDelete_request_total

Field Details
Description This metric is pegged when BSF receives a request to delete PCF bindings. PCF binding sends the binding ids to BSF.
Type Counter
Dimensions application

operation_type (DELETE)
Example ocbsf_bindingDelete_request_total{application="bsf-management-service",operation_type="manual_delete",pcf_binding_delete_count="3",}1.0

Table 7-40 ocbsf_bindingDelete_response_total

Field Details
Description This metric is pegged when BSF sends a response message to the delete PCF bindings request. PCF binding sends the binding ids to BSF.
Type Counter
Dimensions application

response_code (2xx,5xx)

operation_type (DELETE)
Example ocbsf_bindingDelete_response_total{application="bsf-management-service",application_error_code="",operation_type="manual_delete",pcf_binding_delete_count="3",response_code="2xx",}1.0

Table 7-41 topic_version

Field Details
Description Describes the current applied version of a given topic (mentioned in dimension topic_name) into the pod.
Type Gauge
Dimensions
  • Service Name
  • Pod Name
Example  

Table 7-42 http_server_requests_seconds_count

Field Details
Description BSF Management service overall processing time.
Type Counter
Dimensions
  • application
  • exception
  • method
  • outcome
  • status
  • uri
Example http_server_requests_seconds_count{application="bsf-management-service",exception="None",method="GET",outcome="SUCCESS",status="200",uri="/v3/api-docs/swagger-config",} 1.0

Table 7-43 http_server_requests_seconds_sum

Field Details
Description BSF Management service overall processing time.
Type Gauge
Dimensions
  • application
  • exception
  • method
  • outcome
  • status
  • uri
Example http_server_requests_seconds_sum{application="bsf-management-service",exception="None",method="GET",outcome="SUCCESS",status="200",uri="/v3/api-docs/swagger-config",} 0.008189215

Table 7-44 error_handler_exec_total

Field Details
Description This metric is incremented on error handling performed by framework.
Type Counter
Dimensions
  • application
  • applicationException
  • error_type
  • operation
  • origin
  • rule_name
  • source_interface
  • target_interface
  • wrapped_exception
Example ocbsf_error_handler_exec_total{application="bsf-management-service",application_exception="JavaException",error_type="INTERNAL",operation="CREATE",origin="JAVA",rule_name="REJECT_WITH_ENHANCED_DETAIL",source_interface="POLICY",status="400",target_interface="BSF",wrapped_exception="ServiceException",}

Table 7-45 error_handler_in_total

Field Details
Description This metric is incremented on initialization of error handling.
Type Counter
Dimensions
  • application
  • applicationException
  • wrapped_exception
Example ocbsf_error_handler_in_total{application="bsf-management-service",application_exception="JavaException",status="500",wrapped_exception="ServiceException",}

Table 7-46 error_handler_out_total

Field Details
Description This metric is incremented on completion of error handling.
Type Counter
Dimensions
  • application
  • applicationException
  • error_resolved
  • wrapped_exception
Example ocbsf_error_handler_out_total{application="bsf-management-service",application_exception="JavaException",error_resolved="true",status="400",wrapped_exception="ServiceException",}

7.8 Collision Detection Metrics

Table 7-47 ocbsf_collision_detection_bad_request_code

Field Details
Description This metric is pegged when a BAD_REQUEST error code is detected.
Metric Type Counter
Dimensions
  • DNN
  • SNSSAI
  • APPLICATION_ERROR_CODE
  • RESPONSE_CODE
  • BINDING_LEVEL
  • BINDING_ID

Table 7-48 ocbsf_collision_detection_not_found_code

Field Details
Description This metric is pegged when a NOT_FOUND error code is detected.
Type Counter
Dimensions
  • DNN
  • SNSSAI
  • APPLICATION_ERROR_CODE
  • RESPONSE_CODE
  • BINDING_LEVEL
  • BINDING_ID

Table 7-49 ocbsf_collision_detection_forbidden_code

Field Details
Description This metric is pegged when a FORBIDDEN error code is detected.
Type Counter
Dimensions
  • DNN
  • SNSSAI
  • APPLICATION_ERROR_CODE
  • RESPONSE_CODE
  • BINDING_LEVEL
  • BINDING_ID

Table 7-50 ocbsf_collision_detection_unauthorized_code

Field Details
Description This metric is pegged when an UNAUTHORIZED error code is detected.
Type Counter
Dimensions
  • DNN
  • SNSSAI
  • APPLICATION_ERROR_CODE
  • RESPONSE_CODE
  • BINDING_LEVEL
  • BINDING_ID

Table 7-51 ocbsf_collision_detection_not_acceptable_code

Field Details
Description This metric is pegged when a NON_ACCEPTABLE error code is detected.
Type Counter
Dimensions
  • DNN
  • SNSSAI
  • APPLICATION_ERROR_CODE
  • RESPONSE_CODE
  • BINDING_LEVEL
  • BINDING_ID

Table 7-52 ocbsf_collision_detection_service_unavailable_code

Field Details
Description This metric is pegged when an UNAVAILABLE error code is detected.
Type Counter
Dimensions
  • DNN
  • SNSSAI
  • APPLICATION_ERROR_CODE
  • RESPONSE_CODE
  • BINDING_LEVEL
  • BINDING_ID

Table 7-53 ocbsf_collision_detection_method_not_allowed_code

Field Details
Description This metric is pegged when a NOT_ALLOWED error code is detected.
Type Counter
Dimensions
  • DNN
  • SNSSAI
  • APPLICATION_ERROR_CODE
  • RESPONSE_CODE
  • BINDING_LEVEL
  • BINDING_ID

Table 7-54 ocbsf_collision_detection_error_code

Field Details
Description This metric is pegged when a GENERAL error code is detected.
Type Counter
Dimensions
  • DNN
  • SNSSAI
  • APPLICATION_ERROR_CODE
  • RESPONSE_CODE
  • BINDING_LEVEL
  • BINDING_ID

7.9 CM Service Metrics

The following table describes the CM Service metrics and respective dimensions:

Table 7-55 system_operational_state

Field Details
Description This metric indicates the current operational state
Type Gauge
Dimensions
  • application
  • eng_version
  • namespace
  • node
  • pod
  • vendor
Example system_operational_state{application="config-server",eng_version="",microservice="",namespace="",node="",pod="occnp-config-mgmt",vendor="oracle",} 1.0

7.10 Diameter Gateway Metrics

Table 7-56 ocbsf_diam_response_local_total

Field Details
Description When the diameter request is timed out from the backend peer (diameter connector), this metric is incremented.
Type Counter
Dimensions
  • appId
  • cmdCode
  • msgType
  • reqDestHost
  • reqDestRealm
  • reqOrigHost
  • responseCode
  • reqOrigRealm
Example ocbsf_diam_response_local_total{appId="16777236",cmdCode="265",direction="in",msgType="AAA",reqDestHost="ocbsf",reqDestRealm="oracle.com",reqOrigHost="",reqOrigRealm="",responseCode="timeout",} 1.0

Table 7-57 ocbsf_diam_response_network_total

Field Details
Description When the diameter request is timed out from the external NF (AF or PCF), this metric is incremented.
Type Counter
Dimensions
  • appId
  • cmdCode
  • direction
  • msgType
  • reqDestHost
  • reqDestRealm
  • reqOrigHost
  • responseCode
  • reqOrigRealm
Example ocbsf_diam_response_network_total{appId="16777236",cmdCode="265",direction="in",msgType="AAA",reqDestHost="oc-diam-gateway",reqDestRealm="oracle.com",reqOrigHost="",reqOrigRealm="",responseCode="timeout",} 1.0

Table 7-58 diam_controlled_shutdown_message_reject_total

Field Details
Description Indicates failure count because of forced shutdown feature.
Type Counter
Dimensions
  • state
  • response_code
  • destHost
  • destRealm
  • origHost
  • origRealm
  • appId
  • cmdCode
  • msgType
  • direction
Example diam_controlled_shutdown_message_reject_total{msgType="Gx_CCR_I",appId="16777238",cmdCode="272",destHost="",destRealm="oracle.com",operationalState="PARTIAL_SHUTDOWN",origHost="pgw.oracle.com",origRealm="test.example.com",responseCode="5012",} 1.0

Table 7-59 topic_version

Field Details
Description Describes the current applied version of a given topic (mentioned in dimension topic_name) into the pod.
Type Gauge
Dimensions
  • Service Name
  • Pod Name

Table 7-60 ocbsf_diam_request_network_total

Field Details
Description Tracks total number of request messages of given command code to or from network.
Type Counter
Dimensions
  • appId
  • cmdCode
  • destHost
  • destRealm
  • direction
  • msgType
  • origHost
  • origRealm
  • retry
  • retryReason

Table 7-61 ocbsf_diam_request_inter_total

Field Details
Description Tracks total number of request messages of given command code to or from host services.
Type Counter
Dimensions
  • appId
  • cmdCode
  • destHost
  • destRealm
  • direction
  • msgType
  • origHost
  • origRealm
  • retry
  • retryReason

Table 7-62 ocbsf_diam_realm_validation_failed_total

Field Details
Description Used to count the number of failed Destination-Realm validation at Diameter Gateway for BSF.
Type Counter
Dimensions
  • appId
  • cmdCode
  • destHost
  • destRealm
  • origHost
  • origRealm
  • responseCode
  • validateRealmFailed
  • validateBindingRealmFailed
Example ocbsf_diam_realm_validation_failed_total{appId="16777236",cmdCode="265",destHost="",destRealm="oracle.com",origHost="af.oracle.com",origRealm="oracle.com",responseCode="3003",validateRealmFailed="false", validateBindingRealmFailed="true"} 1.0 ; Type-Counter

7.11 NRF Management Service

Table 7-63 NRF Instance Status

Field Details
Description If the metric has value

0 - NRF is unavailable/unhealthy

1 - NRF is available/healthy
Type Gauge
Dimensions NrfUri - URI of the NRF Instance

Table 7-64 NRF Instance Status Count

Field Details
Description The apiRoot shall be specified in the following format:

'scheme'://'fqdn':'port'

If health check procedure is disabled, all NRF instances are marked as HEALTHY after successful NfRegistration.
Type Gauge
Dimensions NrfUri - URI of the NRF Instance

HealthStatus

FailureReason - Reason for the status

Table 7-65 NRF Instance Consecutive Healthy Count

Field Details
Description The metric shall have a minimum value of 0 and maximum value of healthCheckCount.
Type Gauge
Dimensions NrfUri - URI of the NRF Instance

Table 7-66 NRF Instance Consecutive Unhealthy Count

Field Details
Description The metric shall have a minimum value of 0 and maximum value of healthCheckCount.
Type Gauge
Dimensions NrfUri - URI of the NRF Instance

Table 7-67 DNS lookup requests

Field Details
Description The metric shall be pegged only if enableVirtualNrfResolution is set to true.
Type Gauge
Dimensions Scheme - http or https

VirtualFqdn - Fqdn that shall be used by the alternate service for the DNS lookup.

Table 7-68 DNS lookup responses

Field Details
Description The metric shall be pegged only if enableVirtualNrfResolution is set to true.
Type Gauge
Dimensions 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.

Table 7-69 DNS setup requests

Field Details
Description The metric shall be pegged only if enableVirtualNrfResolution is set to true.
Type Counter
Dimensions Scheme - http or https

VirtualFqdn - Fqdn that shall be used by the alternate service for the DNS lookup.

Table 7-70 nrfclient_nfUpdate_status

Field Details
Description Indicates if the NfRegister/NfUpdate operation is successful with NRF after the NfProfile has been updated using the REST API.

0 - Update is not successful.

1 - Update is successful.

NFs may use this metric to configure alerts.
Type Gauge
Dimensions
  • NfInstanceId - The NF's nfInstanceId as present in the NfProfile.
  • NfFqdn - The NF's FQDN as present in the NfProfile.

7.12 Overload Control Metrics

Table 7-71 service_resource_stress

Field Details
Description This metric tracks CPU, memory, failure count, and pending requests on the basis of which the overload level of a service is calculated.
Type Gauge
Dimensions type, Service

Table 7-72 service_resource_overload_level

Field Details
Description This metric tracks an individual resource's overload level that is calculated based on the resource usage and configured threshold.
Type Gauge
Dimensions type, Service

Table 7-73 load_level

Field Details
Description Provides information about the overload manager load level.
Type Gauge
Dimensions Service, namespace

Table 7-74 diam_overload_message_reject_total

Field Details
Description This metric tracks the total number of messages rejected due to overload on Diameter interface.
Type Counter
Dimensions

priority, response_code

Other dimensions:destHost, destRealm, origHost, origRealm, appId, cmdCode, msgType, direction

7.13 PerfInfo Metrics

Table 7-75 nf_load_info

Field Details
Description Provides information about service load.
Type Gauge
Dimensions
  • service
  • namespace
Example nf_load_info{namespace="xxx",service="xxx"} 0.8486912141984638

Table 7-76 jvm_cpu_usage

Field Details
Description Springboot per service jvm_cpu_usage.
Type Gauge
Dimensions
  • service
  • namespace
Example jvm_cpu_usage{namespace="xxx",service="xxx"} 0.2758240242725142

Table 7-77 jvm_memory

Field Details
Description Springboot per service jvm_memory.
Type Gauge
Dimensions
  • service
  • namespace
Example jvm_memory{namespace="ttz",service="xxx"} 18.361382484436035

Table 7-78 cgroup_cpu_nanoseconds

Field Details
Description Reports the total CPU time (in nanoseconds) on each CPU core for all the tasks in the cgroup.
Type Gauge
Dimensions NA
Example cgroup_cpu_nanoseconds 2.1782821080274e+013

Table 7-79 cgroup_memory_bytes

Field Details
Description Reports the memory usage.
Type Gauge
Dimensions NA
Example cgroup_memory_bytes 1.31289088e+08

Table 7-80 load_level

Field Details
Description Provides information about the overload manager load level.
Type Gauge
Dimensions
  • service
  • namespace
Example load_level{serivce="xxx"} L1

Table 7-81 system_overload_threshold_config_mode

Field Details
Description Indicates whether the overload level threshold configuration is based on STANDALONE or PROFILE mode.
Type Gauge
Dimensions
  • 1 - STANDALONE
  • 2 - PROFILE
Example system_overload_threshold_config_mode 1.0

Table 7-82 active_overload_threshold_fetch_failed

Field Details
Description Indicates whether the active profile data is fetched successfully or failed to fetch
Type Gauge
Dimensions

  • 0 - Success

  • 1 - Failure
Example active_overload_threshold_fetch_failed 1.0

7.14 Pod Congestion Metrics

Table 7-83 ocbsf_pod_congestion_state

Field Details
Description Tracks congestion state of pod.
Type Gauge
Dimensions level = 0,1,2 (0 = Normal, 1 = DoC, 2 = Congested)

Table 7-84 ocbsf_pod_resource_stress

Field Details
Description Tracks CPU, memory, queue usage (percentage) based on which POD is calculating its congestion state.
Type Gauge
Dimensions type = "PendingRequest","CPU","Memory"

Table 7-85 ocbsf_pod_resource_congestion_state

Field Details
Description Tracks individual resource's congestion state calculated based on the resource usage and configured threshold.
Type Gauge
Dimensions type = "PendingRequest","CPU","Memory"

level = 0,1,2 (0 = Normal, 1 = DoC, 2 = Congested)

Table 7-86 ocbsf_diam_congestion_message_reject_total

Field Details
Description Tracks number of messages rejected due to congestion.
Type Counter
Dimensions priority = calculated or received DRMP priority of message being rejected

response_code = response code sent with rejected message

destHost, destRealm, origHost, origRealm, appId, cmdCode, msgType, direction

7.15 User-Agent Header Metrics

The following metric is introduced for User-Agent Header:

Table 7-87 oc.ingressgateway.http.requests

Field Details
Description This metric is pegged for every incoming request. If the User-Agent header is not present, then UNKNOWN will be pegged. This will be independent of the User Agent validation feature at the Ingress Gateway.
Type Counter
Dimensions
  • consumerNfType
  • consumerInstanceId
  • ConsumerFqdn

7.16 Query Service Metrics

Table 7-88 queryservice_request

Field Details
Description Number of query requests received.
Type Counter
Dimensions RequestType
Example queryservice_response_total{Code="2xx",ReqType="GET",} 195.0

Table 7-89 queryservice_response

Field Details
Description Number of responses sent for query requests.
Type Counter
Dimensions RequestType
Example queryservice_request_total{ReqType="GET",} 257.0

Table 7-90 queryservice_sessionDelete_request

Field Details
Description Total number of query requests to delete PCF bindings.
Type Counter
Dimensions
  • ResourceType
  • Result_Code
Example queryservice_sessionDelete_request{ReqType="DELETE",} 257.0

Table 7-91 queryservice_sessionDelete_response

Field Details
Description Total number of responses for delete PCF bindings query requests.
Type Counter
Dimensions
  • ResourceType
  • Result_Code
Example queryservice_sessionDelete_response{Code="2xx",ReqType="DELETE",} 195.0

7.17 TLS Metrics

The following table describes the TLS metrics and the respective dimensions:

Table 7-92 oc_ingressgateway_incoming_tls_connections

Field Details
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
  • host
  • NegotiatedTLSVersion
  • direction
  • instanceIdentifier
Example  

Table 7-93 oc_egressgateway_incoming_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
  • host
  • NegotiatedTLSVersion
  • direction
  • instanceIdentifier
Example  

Table 7-94 security_cert_x509_expiration_seconds

Field Details
Description Indicates the time to certificate expiry in epoch seconds.
Type Histogram
Dimensions serialNumber
Example  

Table 7-95 diam_conn_network

Field Details
Description Indicates the number of TLS connections per TLS version.
Type Gauge
Dimensions tlsversion
Example diam_conn_network{destHost="",destRealm="",direction="out",origHost="oc-diam-gateway",origRealm="oracle.com",tlsVersion="TLSv1.3"} 1 this metric will depict the number of tls connections .

Table 7-96 diam_failed_conn_network

Field Details
Description Indicates the number of failed TLS connections.

Note: It is applicable when we configure Initiate Connection to true in peer node configurations in the CNC Console.

Type Gauge
Dimensions
  • tlsversion
  • reason
Example diam_failed_conn_network{peerName="dgw",reason="SSL Handshake Exception",} 1.0

Table 7-97 diam_conn_network_responder

Field Details
Description Indicates the number of allowed TLS responder connections with or without the peer configuration.
Type Gauge
Dimensions
  • tlsversion
  • peerconfigvalidated
Example diam_conn_network_responder{destHost="",destRealm="",direction="in",origHost="oc-diam-gateway",origRealm="oracle.com",tlsVersion="TLSv1.3", peerConfigValidated="true"}

Table 7-98 dgw_tls_cert_expiration_seconds

Field Details
Description Indicates the number of allowed TLS responder connections with or without the peer configuration.
Type Gauge
Dimensions
  • serialNumber (a number assigned by CA to each certificate)
  • subject (information about the cert issuer)
Example dgw_tls_cert_expiration_seconds{serialNumber="122859034516052844067924392230910496431389299229",subject="OU=CGIU, O=ORCL, L=BLR, ST=KA, C=IN",} 1.797882352E9

7.18 NRF Client Metrics

NF status and NF load metrics

Table 7-99 nrfclient_perf_info_nf_profile_load

Field Details
Description The current Load of the NF.
Type Gauge
Dimensions  

Table 7-100 nrfclient_current_nf_status

Field Details
Description The current operative status of the NF. The gauge shall be indicate the status as below:
  • 0 - REGISTERED
  • 1 - DEREGISTERED
  • 2 - SUSPENDED
  • 3 - UNDISCOVERABLE
  • 4 - 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 7-101 nrfclient_nf_status_with_nrf

Field Details
Description The operative status of the NF communicated to the NRF. The gauge shall be indicate the status as below:
  • 0 - REGISTERED
  • 1 - DEREGISTERED
  • 2 - SUSPENDED
  • 3 - UNDISCOVERABLE
  • 4 - 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.

NRF Health Status

Table 7-102 nrfclient_nrf_operative_status

Field Details
Description The current operative status of the NRF Instance. If the metric has value
  • 0 - NRF is unavailable or unhealthy
  • 1 - NRF is available or healthy
Type Gauge
Dimensions NrfUri - URI of the NRF Instance

Table 7-103 nrfclient_nrf_status_total

Field Details
Description Total number of times an NRF instance is marked as healthy or unhealthy. The apiRoot is specified in the format 'scheme'://'fqdn':'port'.

Note: If health check procedure is disabled, all NRF instances are marked as HEALTHY after successful NF registration.

Type Counter
Dimensions NrfUri- URI of the NRF InstanceHealthStatus FailureReason - Reason for the status

Table 7-104 nrfclient_nrf_successive_healthy_count

Field Details
Description The metric shows the consecutive number of times the NRF is considered as healthy. The metric has a minimum value of 0 and maximum value of healthCheckCount.
Type Counter
Dimensions NrfUri- URI of the NRF Instance

Table 7-105 nrfclient_nrf_successive_unhealthy_count

Field Details
Description The metric shows the consecutive number of times the NRF is considered as unhealthy
Type Counter
Dimensions NrfUri- URI of the NRF Instance

NF - NRF-Client metrics

Table 7-106 nrfclient_on_demand_conn_in_request_total

Field Details
Description Total number of on-demand requests received from the backend NF to NRF Client.
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 7-107 nrfclient_on_demand_conn_out_response_total

Field Details
Description Total number of on-demand responses sent to the backend NF to NRF Client.
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 the NRF or generated by NRF-client.

Table 7-108 nrfclient_on_demand_processing_latency_ms

Field Details
Description Total message processing time duration in milliseconds.
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 7-109 ocpm_nrf_tracing_request_timeout_total

Field Details
Description Total number of requests timeout sent to the backend NF from NRF Client.
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.

NRF-Client - NRF metrics

Table 7-110 nrfclient_nw_conn_out_request_total

Field Details
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 7-111 nrfclient_nw_conn_in_response_total

Field Details
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 the NRF or generated by NRF-client.

Table 7-112 nrfclient_nw_conn_in_notify_request_total

Field Details
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 7-113 nrfclient_nw_conn_out_notify_response_total

Field Details
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 7-114 nrfclient_network_message_processing_latency

Field Details
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.

7.19 Metrics for Automated Certificate Lifecycle Management

The following metrics are used to support automated certificate lifecycle management for BSF:

Table 7-115 oc_certificatemanagement_tls_certificate_info

Field Details
Description This metric is used to peg status of TLS certificates. This metric is further used for raising alarms.
Type Gauge
Dimensions
  • CertificateName
  • SecretName
  • Status (VALID, CORRUPT, MISSING, EXPIRED)
  • Service (IngressGateway, EgressGateway)
Example occnp_oc_certificatemanagement_tls_certificate_info{CertificateName="key-password.txt,bsf.cer,pcf.pem,trust-chain-password.txt,trust-chain.cer,",SecretName="bsf-igw-tls-ssl-bundle",Service="IngressGateway",Status="VALID",} 1.0