6 OCCM Metrics

This chapter provides information about metrics for OCCM.

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 OCCM, and so on.
Gauge Represents a single numerical value that changes randomly. This metric type is used to measure various parameters, such as OCCM load values, memory usage, and so on.
Histogram Represents samples of observations (such as request durations or response sizes) and counts them in configurable buckets. It also provides a sum of all observed values.

Dimension Description

The following table describes different types of metric dimensions:

Table 6-2 OCCM Dimension Description

Dimension Description Possible Values
method Http method GET, PUT, POST, DELETE
httpVersion Http protocol version HTTP/1.1
scheme Http protocol scheme HTTP, UNKNOWN
uri URL of requested API /occm-config/v1/certs
nfType API called by NF eg: SCP, NRF, OCCM, NA
statusCode Http status code 200, 202
certUuid Unique ID for the purpose of logging and tracking eg: 7523a545-089b-49e9-a05c-ae5141db544b
requestType Type of request IR, KUR
certName Name of the certificate NRFTLS-1, SCPTLS-1
certPurpose Purpose of the certificate creation NRF SBI
issuerName Name of the Issuer CA
errorReason Reason of the error eg:ERR_K8S_SECRET_CREATION_ERROR
operationType Type of operation CREATE, RENEW, DELETE, RECREATE
host Application hosted on cluster eg: occm.occncc-thrust5-01.svc.thrust5
application Name of the application OCCM
caServer URL of the Certificate Authority (Issuer) eg: http://ca1-openssl-mock.occncc-thrust5-01.svc.thrust5:8089, https://ca2-openssl-mock.occncc-thrust5-01.svc.thrust5:8443
status To know the status of openssl CMP cmd SUCCESS, FAILED
belongs To determine the secret belongs to which entity certificate-other, certificate-occm, issuer
type To determine the type of the secret input-secret, output-secret
secret Name of the secret nrf-tls-secret
uuid Unique id of the entity eg: 7523a545-089b-49e9-a05c-ae5141db544b
event Name of the event eg: modify, delete
secretNamespace Name of the secret's namespace eg: occncc-thrust5-01

Note:

After OCCM application starts, the default metrics are visible for the following metrics without pegging any metric to list down the available metrics. The default metrics are visible all the time and the values for the labels will be empty. It is possible that in prometheus the labels of the metrics are not visible and only Kubernetes default labels are visible.

6.1 occm_config_http_requests_total

Table 6-3 occm_config_http_requests_total

Field Details
Description The total number of requests to the OCCM configuration service.
Type Counter
Dimensions
  • host
  • application
  • httpVersion
  • scheme
  • method
  • nfType
  • uri
Example occm_config_http_requests_total{ application="occm", container="occm", endpoint="cnc-metrics", helm_sh_chart="occm-25.1.200", host="occm.occncc-thrust5-01.svc.thrust5", httpVersion="HTTP/1.1", instance="10.233.121.228:9000", job="occne-infra/occne-nf-cnc-podmonitor", method="POST", namespace="occncc-thrust5-01", nfType="NRF", pod="occm-occm-67764765f8-7rpm8", pod_template_hash="67764765f8", scheme="http", uri="/occm-config/v1/certs" }

6.2 occm_config_http_response_total

Table 6-4 occm_config_http_response_total

Field Details
Description The total number of responses from the OCCM configuration service
Type Counter
Dimensions
  • host
  • httpVersion
  • scheme
  • method
  • nfType
  • statusCode
  • uri
Example

occm_config_http_responses_total{ application="occm", container="occm", endpoint="cnc-metrics", helm_sh_chart="occm-25.1.200", host="occm.occncc-thrust5-01.svc.thrust5", httpVersion="HTTP/1.1", instance="10.233.121.228:9000", job="occne-infra/occne-nf-cnc-podmonitor", method="POST", namespace="occncc-thrust5-01", nfType="NRF", pod="occm-occm-67764765f8-7rpm8", pod_template_hash="67764765f8", scheme="http", statusCode="202", uri="/occm-config/v1/certs"}

6.3 occm_cmp_requests_total

Table 6-5 occm_cmp_requests_total

Field Details
Description The number of CMP requests to the CA.
Type Counter
Dimensions
  • certUuid
  • certName
  • nfType
  • requestType
  • issuerName
  • caServer
Example

occm_cmp_requests_total{ application="occm", caServer="http://ca90-openssl-mock.occncc-thrust5-01.svc.thrust5:8083", certName="NRFTLS-47", certUuid="c0578b02-caab-454a-bd97-422b0e1c575b", container="occm", endpoint="cnc-metrics", helm_sh_chart="occm-25.1.200", instance="10.233.121.228:9000", issuerName="CA90", job="occne-infra/occne-nf-cnc-podmonitor", namespace="occncc-thrust5-01", nfType="NRF", pod="occm-occm-67764765f8-7rpm8", pod_template_hash="67764765f8", requestType="ir"}

occm_cmp_requests_total{ application="occm", caServer="http://ca90-openssl-mock.occncc-thrust5-01.svc.thrust5:8083", certName="NRFTLS-47", certUuid="c0578b02-caab-454a-bd97-422b0e1c575b", container="occm", endpoint="cnc-metrics", helm_sh_chart="occm-25.1.200", instance="10.233.121.228:9000", issuerName="CA90", job="occne-infra/occne-nf-cnc-podmonitor", namespace="occncc-thrust5-01", nfType="NRF", pod="occm-occm-67764765f8-7rpm8", pod_template_hash="67764765f8", requestType="kur"}

6.4 occm_cmp_responses_total

Table 6-6 occm_cmp_responses_total

Field Details
Description The number of CMP responses from the CA.
Type Counter
Service Operation  
Dimensions
  • certUuid
  • certName
  • nfType
  • requestType
  • status
  • statusCode
  • issuerName
  • caServer
Example

occm_cmp_responses_total{ application="occm", caServer="http://ca90-openssl-mock.occncc-thrust5-01.svc.thrust5:8083", certName="NRFTLS-47", certUuid="c0578b02-caab-454a-bd97-422b0e1c575b", container="occm", endpoint="cnc-metrics", helm_sh_chart="occm-25.1.200", instance="10.233.121.228:9000", issuerName="CA90", job="occne-infra/occne-nf-cnc-podmonitor", namespace="occncc-thrust5-01", nfType="NRF", pod="occm-occm-67764765f8-7rpm8", pod_template_hash="67764765f8", requestType="ir", status="SUCCESS", statusCode="OK"}

occm_cmp_responses_total{ application="occm", caServer="http://ca90-openssl-mock.occncc-thrust5-01.svc.thrust5:8083", certName="NRFTLS-47", certUuid="c0578b02-caab-454a-bd97-422b0e1c575b", container="occm", endpoint="cnc-metrics", helm_sh_chart="occm-25.1.200", instance="10.233.121.228:9000", issuerName="CA90", job="occne-infra/occne-nf-cnc-podmonitor", namespace="occncc-thrust5-01", nfType="NRF", pod="occm-occm-67764765f8-7rpm8", pod_template_hash="67764765f8", requestType="kur", status="SUCCESS", statusCode="OK"}

6.5 occm_cmp_identity_cert_expiration_seconds

Table 6-7 occm_cmp_identity_cert_expiration_seconds

Field Details
Description It is the CMP identity (OCCM) Certificate expiry gauge metrics. It indicates the CMP identity (OCCM) certificate expiry timestamp.
Type Gauge
Dimensions
  • certUuid
  • certName
  • nfType
  • issuerName
  • certPurpose
Example occm_cmp_identity_cert_expiration_seconds{ application="occm", certName="OCCM-HTTPS-1", certPurpose="HTTPS-RA", certUuid="164dea8d-a54e-4556-81d0-f0a923030416", container="occm", endpoint="cnc-metrics", helm_sh_chart="occm-25.1.200-COCCM-2520-metrics-improve-241128052710-9f49f6ef", instance="10.233.80.166:9000", issuerName="CA-1", job="occne-infra/occne-nf-cnc-podmonitor", namespace="occm-ns", nfType="OCCM", pod="occm-occm-59898cf755-vr2hq", pod_template_hash="59898cf755"} 1734674763

6.6 occm_end_entity_cert_expiration_seconds

Table 6-8 occm_end_entity_cert_expiration_seconds

Field Details
Description It is the End Entity (NF) Certificate expiry gauge metrics. It indicates the End Entity (NF) Certificate expiry timestamp.
Type Gauge
Dimensions
  • certUuid
  • certName
  • nfType
  • issuerName
  • certPurpose
Example

occm_end_entity_cert_expiration_seconds{ app_kubernetes_io_vendor="Oracle", app_kubernetes_io_version="25.1.0.0.0", application="occm", certName="nrfcert-nov2711-1", certPurpose="NRF SBI", certUuid="591e3743-70d0-4425-9300-10ebb989d02c", container="occm", endpoint="cnc-metrics", helm_sh_chart="occm-25.1.200-COCCM-2520-metrics-improve-241128052710-9f49f6ef", instance="10.233.80.166:9000", issuerName="CA-1", job="occne-infra/occne-nf-cnc-podmonitor", namespace="occm-ns", nfType="NRF", pod="occm-occm-59898cf755-vr2hq", pod_template_hash="59898cf755"} 1733306455

6.7 occm_cmp_identity_cert_status

Table 6-9 occm_cmp_identity_cert_status

Field Details
Description It is the CMP Identity (OCCM) certificate status gauge metric. The Gauge values indicate the CMP Identity (OCCM) Certificate status. For example, CREATING(1), READY(2), FAILED(3), DELETED(6), EXPIRED(7), and WAITING(8).
Type Gauge
Dimensions
  • certUuid
  • nfType
  • certName
  • certPurpose
  • issuerName
Example

occm_cmp_identity_cert_status{ application="occm", certName="OCCM-HTTPS-1", certPurpose="HTTPS-RA", certUuid="164dea8d-a54e-4556-81d0-f0a923030416", container="occm", endpoint="cnc-metrics",helm_sh_chart="occm-25.1.200-COCCM-2520-metrics-improve-241128052710-9f49f6ef", instance="10.233.80.166:9000", issuerName="CA-1", job="occne-infra/occne-nf-cnc-podmonitor", namespace="occm-ns", nfType="OCCM", pod="occm-occm-59898cf755-vr2hq", pod_template_hash="59898cf755"} 2

6.8 occm_end_entity_cert_status

Table 6-10 occm_end_entity_cert_status

Field Details
Description It is the End Entity (NF) Cert status gauge metric. The Gauge values indicate the End Entity (NF) Certificate status. For example, CREATING(1), READY(2), FAILED(3), DELETED(6), EXPIRED(7), and WAITING(8).
Type Gauge
Dimensions
  • certUuid
  • nfType
  • certName
  • certPurpose
  • issuerName
Example

occm_end_entity_cert_status{ application="occm", certName="nrfcert-nov2711-1", certPurpose="NRF SBI", certUuid="591e3743-70d0-4425-9300-10ebb989d02c", container="occm", endpoint="cnc-metrics", helm_sh_chart="occm-25.1.200-COCCM-2520-metrics-improve-241128052710-9f49f6ef", instance="10.233.80.166:9000", issuerName="CA-1", job="occne-infra/occne-nf-cnc-podmonitor", namespace="occm-ns", nfType="NRF", pod="occm-occm-59898cf755-vr2hq", pod_template_hash="59898cf755"} 2

6.9 occm_cmp_cli_durations_seconds

Table 6-11 occm_cmp_cli_durations_seconds

Field Details
Description OCCM CMP CLI duration histogram metrics. It indicates the time taken for CMP CLI between request and response from CA.
Type Histogram
Dimensions
  • certUuid
  • nfType
  • certName
  • requestType
  • caServer
Example

occm_cmp_cli_durations_seconds{ application="occm", caServer="http://ejbca-ejbca-community-helm.occm-ns.svc.thrust5:30080/ejbca/publicweb/cmp/occmaliasra", certName="OCCM-test1", certUuid="c7343daa-9eb0-4ba5-9e02-67a945f2bd9b", container="occm", endpoint="cnc-metrics", helm_sh_chart="occm-25.1.200", namespace="occm-ns", nfType="OCCM", pod="occm-occm-ccfcbbbfb-nl22k", quantile="0.5", requestType="ir"}

6.10 occm_cert_request_status_total

Table 6-12 occm_cert_request_status

Field Details
Description

OCCM certificate request status counter metric. This metrics includes both CMP Identity (OCCM) and End Entity (NF).

It indicates CMP Identity (OCCM) and End Entity (NF) certificate status, error reason, operation type whether Create, Renew, or Recreate etc.
Type Counter
Dimensions
  • certName
  • certUuid
  • errorReason
  • issuerName
  • metadata
  • nfType
  • operationType
Example

occm_cert_request_status_total{ application="occm", certName="NRFTLS-47", certUuid="c0578b02-caab-454a-bd97-422b0e1c575b", container="occm", endpoint="cnc-metrics", errorReason="OK", helm_sh_chart="occm-25.1.200", instance="10.233.121.228:9000", issuerName="CA90", job="occne-infra/occne-nf-cnc-podmonitor", metadata="NA", namespace="occncc-thrust5-01", nfType="NRF", operationType="RENEW", pod="occm-occm-67764765f8-7rpm8", pod_template_hash="67764765f8"}

For bulk certificate migration, operationType will be RECREATE and the metadata will have the bulk migration UUID. The errorReason is OK_BULK_CERT_MIGRATION or ERR_BULK_CERT_MIGRATION to depict success and failure cases respectively.

occm_cert_request_status_total{ application="occm", certName="NRFTLS-48", certUuid="c1278b02-caab-454a-bd97-422b0e1c805b", container="occm", endpoint="cnc-metrics", errorReason="OK_BULK_CERT_MIGRATION ", helm_sh_chart="occm-25.1.200", instance="10.233.121.228:9000", issuerName="CA90", job="occne-infra/occne-nf-cnc-podmonitor", metadata="7787cac2-5250-4aee-9f7b-fe3e469d5f0e", namespace="occncc-thrust5-01", nfType="NRF", operationType="RECREATE", pod="occm-occm-67764765f8-7rpm8", pod_template_hash="67764765f8"}

6.11 occm_secret_event_total

Table 6-13 occm_secret_event_total

Field Details
Description Kubernetes secret event count.

It will indicate the number of operations that have been performed to delete or modify a secret linked to OCCM.
Type Counter
Dimensions
  • name
  • uuid
  • type
  • belongs
  • secret
  • secretNamespace
  • event
Example occm_secret_event_total{app_kubernetes_io_application="occm", app_kubernetes_io_component="occm", app_kubernetes_io_engVersion="25.1.200-COCCM-1332-240722084346-939119a5", app_kubernetes_io_instance="occm", app_kubernetes_io_managed_by="Helm", app_kubernetes_io_microservice="occm", app_kubernetes_io_mktgVersion="25.1.200.0.0", app_kubernetes_io_name="occm", app_kubernetes_io_part_of="occm", app_kubernetes_io_vendor="Oracle", app_kubernetes_io_version="25.1.200.0.0", application="occm", belongs="certificate-other", container="occm", endpoint="cnc-metrics", event="deleted", exported_namespace="occm-ns", helm_sh_chart="occm-25.1.200-COCCM-1332-240722084346-939119a5", instance="10.233.80.225:8989", job="occne-infra/occne-nf-cnc-podmonitor", name="Nrf-tls8", namespace="occm-ns", pod="occm-occm-7b6fd5dcf7-7n4ld", pod_template_hash="7b6fd5dcf7", secret="nrf-tls-secret8", type="output-secret", uuid="2111e512-10d7-4ffd-a0db-a995d606bc60"}