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

6.1 occm_config_http_requests_total

Table 6-3 occm_config_http_requests_total

Field Details
Description OCCM Configuration total HTTP request counter metric
Type Counter
Dimensions
  • host
  • application
  • httpVersion
  • scheme
  • method
  • nfType
  • uri
Example occm_config_http_requests_total{app_kubernetes_io_application="occm", app_kubernetes_io_component="occm", app_kubernetes_io_engVersion="24.3.0", app_kubernetes_io_instance="occm", app_kubernetes_io_managed_by="Helm", app_kubernetes_io_microservice="occm", app_kubernetes_io_mktgVersion="24.3.0.0.0", app_kubernetes_io_name="occm", app_kubernetes_io_part_of="occm", app_kubernetes_io_vendor="Oracle", app_kubernetes_io_version="24.3.0.0.0", application="occm", container="occm", endpoint="cnc-metrics", helm_sh_chart="occm-24.3.0", 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 OCCM Configuration total HTTP response counter metric
Type Counter
Dimensions
  • host
  • httpVersion
  • scheme
  • method
  • nfType
  • statusCode
  • uri
Example occm_config_http_responses_total{app_kubernetes_io_application="occm", app_kubernetes_io_component="occm", app_kubernetes_io_engVersion="24.3.0", app_kubernetes_io_instance="occm", app_kubernetes_io_managed_by="Helm", app_kubernetes_io_microservice="occm", app_kubernetes_io_mktgVersion="24.3.0.0.0", app_kubernetes_io_name="occm", app_kubernetes_io_part_of="occm", app_kubernetes_io_vendor="Oracle", app_kubernetes_io_version="24.3.0.0.0", application="occm", container="occm", endpoint="cnc-metrics", helm_sh_chart="occm-24.3.0", 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 OCCM total CMP request counter metric
Type Counter
Dimensions
  • certUuid
  • certName
  • nfType
  • requestType
  • issuerName
  • caServer
Example

occm_cmp_requests_total{app_kubernetes_io_application="occm", app_kubernetes_io_component="occm", app_kubernetes_io_engVersion="24.3.0", app_kubernetes_io_instance="occm", app_kubernetes_io_managed_by="Helm", app_kubernetes_io_microservice="occm", app_kubernetes_io_mktgVersion="24.3.0.0.0", app_kubernetes_io_name="occm", app_kubernetes_io_part_of="occm", app_kubernetes_io_vendor="Oracle", app_kubernetes_io_version="24.3.0.0.0", 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-24.3.0", 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{app_kubernetes_io_application="occm", app_kubernetes_io_component="occm", app_kubernetes_io_engVersion="24.3.0", app_kubernetes_io_instance="occm", app_kubernetes_io_managed_by="Helm", app_kubernetes_io_microservice="occm", app_kubernetes_io_mktgVersion="24.3.0.0.0", app_kubernetes_io_name="occm", app_kubernetes_io_part_of="occm", app_kubernetes_io_vendor="Oracle", app_kubernetes_io_version="24.3.0.0.0", 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-24.3.0", 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 OCCM total CMP response counter metric
Type Counter
Service Operation  
Dimensions
  • certUuid
  • certName
  • nfType
  • requestType
  • status
  • statusCode
  • issuerName
  • caServer
Example occm_config_http_responses_total{app_kubernetes_io_application="occm", app_kubernetes_io_component="occm", app_kubernetes_io_engVersion="24.3.0", app_kubernetes_io_instance="occm", app_kubernetes_io_managed_by="Helm", app_kubernetes_io_microservice="occm", app_kubernetes_io_mktgVersion="24.3.0.0.0", app_kubernetes_io_name="occm", app_kubernetes_io_part_of="occm", app_kubernetes_io_vendor="Oracle", app_kubernetes_io_version="24.3.0.0.0", application="occm", container="occm", endpoint="cnc-metrics", helm_sh_chart="occm-24.3.0", 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.5 occm_cert_expiry

Table 6-7 occm_cert_expiry

Field Details
Description OCCM Cert expiry gauge metrics. It will indicate Certificate expiry timestamp.
Type Gauge
Dimensions
  • certUuid
  • certName
  • nfType
  • issuerName
  • certPurpose
Example occm_cert_expiry{app_kubernetes_io_application="occm", app_kubernetes_io_component="occm", app_kubernetes_io_engVersion="24.3.0", app_kubernetes_io_instance="occm", app_kubernetes_io_managed_by="Helm", app_kubernetes_io_microservice="occm", app_kubernetes_io_mktgVersion="24.3.0.0.0", app_kubernetes_io_name="occm", app_kubernetes_io_part_of="occm", app_kubernetes_io_vendor="Oracle", app_kubernetes_io_version="24.3.0.0.0", application="occm", certName="NRFTLS-47", certPurpose="NRF SBI", certUuid="c0578b02-caab-454a-bd97-422b0e1c575b", container="occm", endpoint="cnc-metrics", helm_sh_chart="occm-24.3.0", 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"}

6.6 occm_cert_status

Table 6-8 occm_cert_status

Field Details
Description OCCM Cert status gauge metric. Gauge values indicate the Certificate status CREATING(1), READY(2), FAILED(3), DELETED(6), EXPIRED(7), WAITING(8)
Type Gauge
Dimensions
  • certUuid
  • nfType
  • certName
  • certPurpose
  • issuerName
Example occm_cert_status{app_kubernetes_io_application="occm", app_kubernetes_io_component="occm", app_kubernetes_io_engVersion="24.3.0", app_kubernetes_io_instance="occm", app_kubernetes_io_managed_by="Helm", app_kubernetes_io_microservice="occm", app_kubernetes_io_mktgVersion="24.3.0.0.0", app_kubernetes_io_name="occm", app_kubernetes_io_part_of="occm", app_kubernetes_io_vendor="Oracle", app_kubernetes_io_version="24.3.0.0.0", application="occm", certName="NRFTLS-47", certPurpose="NRF SBI", certUuid="c0578b02-caab-454a-bd97-422b0e1c575b", container="occm", endpoint="cnc-metrics", helm_sh_chart="occm-24.3.0", 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"}

6.7 occm_cmp_cli_durations

Table 6-9 occm_cmp_cli_durations

Field Details
Description OCCM cmp cli duration histogram metrics . CMP cli time taken in between request and response from CA
Type Histogram
Dimensions
  • certUuid
  • nfType
  • certName
  • requestType
  • caServer
Example occm_cmp_cli_durations_bucket{app_kubernetes_io_application="occm", app_kubernetes_io_component="occm", app_kubernetes_io_engVersion="24.3.0", app_kubernetes_io_instance="occm", app_kubernetes_io_managed_by="Helm", app_kubernetes_io_microservice="occm", app_kubernetes_io_mktgVersion="24.3.0.0.0", app_kubernetes_io_name="occm", app_kubernetes_io_part_of="occm", app_kubernetes_io_vendor="Oracle", app_kubernetes_io_version="24.3.0.0.0", 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-24.3.0", instance="10.233.121.228:9000", job="occne-infra/occne-nf-cnc-podmonitor", le="5.0", namespace="occncc-thrust5-01", nfType="NRF", pod="occm-occm-67764765f8-7rpm8", pod_template_hash="67764765f8", requestType="kur"}

6.8 occm_cert_request_status_total

Table 6-10 occm_cert_request_status

Field Details
Description

OCCM Certificate request status counter metric.

It will indicate certificate status, error reason, operation type whether Create, Renew, or Recreate etc.
Type Counter
Dimensions
  • certName
  • certUuid
  • errorReason
  • issuerName
  • nfType
  • operationType
Example occm_cert_request_status_total{app_kubernetes_io_application="occm", app_kubernetes_io_component="occm", app_kubernetes_io_engVersion="24.3.0", app_kubernetes_io_instance="occm", app_kubernetes_io_managed_by="Helm", app_kubernetes_io_microservice="occm", app_kubernetes_io_mktgVersion="24.3.0.0.0", app_kubernetes_io_name="occm", app_kubernetes_io_part_of="occm", app_kubernetes_io_vendor="Oracle", app_kubernetes_io_version="24.3.0.0.0", application="occm", certName="NRFTLS-47", certUuid="c0578b02-caab-454a-bd97-422b0e1c575b", container="occm", endpoint="cnc-metrics", errorReason="OK", helm_sh_chart="occm-24.3.0", instance="10.233.121.228:9000", issuerName="CA90", job="occne-infra/occne-nf-cnc-podmonitor", namespace="occncc-thrust5-01", nfType="NRF", operationType="RENEW", pod="occm-occm-67764765f8-7rpm8", pod_template_hash="67764765f8"}

6.9 occm_secret_event_status

Table 6-11 occm_secret_event_status

Field Details
Description Kubernetes secret to modify or delete event status.

It will indicate the current operation performed by non-OCCM users on secrets that are linked to the OCCM application. It will also update the type of secret gets modified or deleted, that is, input or output secret and linked to either certificate or issuer.

Gauge values - MODIFIED(1), DELETED(2)
Type Gauge
Dimensions
  • name
  • uuid
  • type
  • belongs
  • secret
  • secretNamespace
Example

occm_secret_event_status{app_kubernetes_io_application="occm", app_kubernetes_io_component="occm", app_kubernetes_io_engVersion="24.3.0", app_kubernetes_io_instance="occm", app_kubernetes_io_managed_by="Helm", app_kubernetes_io_microservice="occm", app_kubernetes_io_mktgVersion="24.3.0.0.0", app_kubernetes_io_name="occm", app_kubernetes_io_part_of="occm", app_kubernetes_io_vendor="Oracle", app_kubernetes_io_version="24.3.0.0.0", application="occm", belongs="certificate-other", container="occm", endpoint="cnc-metrics", helm_sh_chart="occm-24.3.0", instance="10.233.80.179:8989", job="occne-infra/occne-nf-cnc-podmonitor", name="Nrf-tls28", namespace="occm-ns", pod="occm-occm-5fdb4b7984-2fclh", pod_template_hash="5fdb4b7984", secret="nrf-tls-secret28", secretNamespace="occm-ns", type="output-secret", uuid="8cc14488-26c2-485c-800e-ee5ca8012c8d"}

occm_secret_event_status{app_kubernetes_io_application="occm", app_kubernetes_io_component="occm", app_kubernetes_io_engVersion="24.3.0", app_kubernetes_io_instance="occm", app_kubernetes_io_managed_by="Helm", app_kubernetes_io_microservice="occm", app_kubernetes_io_mktgVersion="24.3.0.0.0", app_kubernetes_io_name="occm", app_kubernetes_io_part_of="occm", app_kubernetes_io_vendor="Oracle", app_kubernetes_io_version="24.3.0.0.0", application="occm", belongs="issuer", container="occm", endpoint="cnc-metrics", helm_sh_chart="occm-24.3.0", instance="10.233.80.151:8989", job="occne-infra/occne-nf-cnc-podmonitor", name="CA1", namespace="occm-ns", pod="occm-occm-649c5b8bcb-vpxck", pod_template_hash="649c5b8bcb", secret="ca1-mac-secret", secretNamespace="occm-ns", type="input-secret", uuid="989b549e-c2ca-49aa-9886-6b41216861e6"}

occm_secret_event_status{app_kubernetes_io_application="occm", app_kubernetes_io_component="occm", app_kubernetes_io_engVersion="24.3.0", app_kubernetes_io_instance="occm", app_kubernetes_io_managed_by="Helm", app_kubernetes_io_microservice="occm", app_kubernetes_io_mktgVersion="24.3.0.0.0", app_kubernetes_io_name="occm", app_kubernetes_io_part_of="occm", app_kubernetes_io_vendor="Oracle", app_kubernetes_io_version="24.3.0.0.0", application="occm", belongs="certificate-other", container="occm", endpoint="cnc-metrics", helm_sh_chart="occm-24.3.0", instance="10.233.80.151:8989", job="occne-infra/occne-nf-cnc-podmonitor", name="Nrf-tls3", namespace="occm-ns", pod="occm-occm-649c5b8bcb-vpxck", pod_template_hash="649c5b8bcb", secret="nrf-tls-secret2", secretNamespace="occm", type="namespace", uuid="514b64bb-edbd-480a-a760-5d5ef1b7e100"}

6.10 occm_secret_event_total

Table 6-12 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="24.3.0-COCCM-1332-240722084346-939119a5", app_kubernetes_io_instance="occm", app_kubernetes_io_managed_by="Helm", app_kubernetes_io_microservice="occm", app_kubernetes_io_mktgVersion="24.3.0.0.0", app_kubernetes_io_name="occm", app_kubernetes_io_part_of="occm", app_kubernetes_io_vendor="Oracle", app_kubernetes_io_version="24.3.0.0.0", application="occm", belongs="certificate-other", container="occm", endpoint="cnc-metrics", event="deleted", exported_namespace="kvikrant-ns", helm_sh_chart="occm-24.3.0-COCCM-1332-240722084346-939119a5", instance="10.233.80.225:8989", job="occne-infra/occne-nf-cnc-podmonitor", name="Nrf-tls8", namespace="kvikrant-ns", pod="occm-occm-7b6fd5dcf7-7n4ld", pod_template_hash="7b6fd5dcf7", secret="nrf-tls-secret8", type="output-secret", uuid="2111e512-10d7-4ffd-a0db-a995d606bc60"}