A Ingress Gateway Metrics

Ingress Gateway Metrics

Table A-1 oc_ingressgateway_http_requests_total

Field Details
Description This metric is pegged as soon as the request reaches the Ingress gateway in the first custom filter of the application.
Type Counter
Dimension
  • NFType
  • NFServiceType
  • Host
  • HttpVersion
  • Scheme
  • Route_path
  • InstanceIdentifier
  • ClientCertIdentity

Table A-2 oc_ingressgateway_http_responses_total

Field Details
Description This metric is pegged in the last custom filter of the Ingress gateway while the response is being sent back to the consumer NF.
Type Counter
Dimension
  • Status
  • Method
  • Route_path
  • NFType
  • NFServiceType
  • Host
  • HttpVersion
  • Scheme
  • Identifier
  • ClientCertIdentity

Table A-3 oc_ingressgateway_request_latency_seconds

Field Details
Description This metric is pegged in the last custom filter of the Ingress gateway while the response is being sent back to the consumer NF. This metric tracks the amount of time taken for processing the request. It starts as soon the request reaches the first custom filter of the application and lasts till the response is sent back to the consumer NF from the last custom filter of the application.
Type Timer
Dimension
  • quantile
  • InstanceIdentifier

Table A-4 oc_ingressgateway_connection_failure_total

Field Details
Description This metric is pegged in the customized Jetty Client as soon as it fails to connect to the destination service with direction as ingressOut. 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 with direction as ingress.
Type Counter
Dimension
  • Host
  • Port
  • Direction
  • InstanceIdentifier
  • error_reason

Table A-5 oc_ingressgateway_global_ratelimit_total

Field Details
Description This metric is pegged in the custom filter implemented to check the global rate limit conditions.
Type Counter
Dimension
  • Method
  • Route_path
  • Scheme
  • InstanceIdentifier
  • Status (Rate limit Status field is different here )

Table A-6 oc_ingressgateway_route_ratelimit_total

Field Details
Description This metric is pegged in the custom filter implemented to check the route level rate limit conditions.
Type Counter
Dimension
  • Method
  • Route_path
  • Scheme
  • InstanceIdentifier
  • Status (Rate limit Status field is different here )

Table A-7 oc_ingressgateway_request_processing_latency_seconds

Field Details
Description This metric is pegged in the last custom filter of the Ingress gateway while the response is being sent back to the consumer NF. This metric captures the amount of time taken for processing of the request only within Ingress gateway. It starts as soon the request reaches the first custom filter of the application and lasts till the request is forwarded to the destination.
Type Timer
Dimension
  • quantile
  • InstanceIdentifier

Table A-8 oc_ingressgateway_jetty_request_stat_metrics_total

Field Details
Description This metric is pegged for every event occurred when a request is sent to IGW.
Type Counter
Dimension
  • event
  • client_type
  • InstanceIdentifier

Table A-9 oc_ingressgateway_jetty_response_stat_metrics_total

Field Details
Description This metric is pegged for every event occurred when a response is received by IGW
Type Counter
Dimension
  • event
  • client_type
  • InstanceIdentifier

Table A-10 oc_ingressgateway_jetty_latency_seconds

Field Details
Description This metric is pegged in Jetty response listener that captures the amount of time taken for processing of the request by jetty client.
Type Timer
Dimension
  • quantile
  • InstanceIdentifier

Table A-11 oc_ingressgateway_netty_latency_seconds

Field Details
Description This metric is pegged in Netty outbound handler that captures the amount of time taken for processing of the request by netty server.
Type Timer
Dimension
  • quantile
  • InstanceIdentifier

Table A-12 oc_ingressgateway_request_content_metrics_total

Field Details
Description This metric is pegged by default filter RequestContentMetrics. It pegs whether request has request body or not.
Type Counter
Dimension
  • method
  • content_available
  • InstanceIdentifier

Table A-13 oc_ingressgateway_xfcc_header_validate_total

Field Details
Description This metric is pegged when xfccHeaderValidation is enabled in XfccHeaderValidationFilter. This metric along with the specified dimension captures the successful/ un-successful validation of XFCC header in the incoming request.
Type Counter
Dimension
  • Route_path
  • Status
  • Cause
  • CertsCompared
  • InstanceIdentifier
  • ErrorOriginator

Table A-14 oc_configclient_request_total

Field Details
Description This metric is pegged whenever config client is polling for configuration update from common configuration server.
Type Counter
Dimension
  • Release version
  • Config version

Table A-15 oc_configclient_response_total

Field Details
Description This metrics is pegged whenever config client receives response from common configuration server.
Type Counter
Dimension
  • Release version
  • Config version
  • Updated

Table A-16 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
Dimension
  • NegotiatedTLSVersion
  • Host
  • Direction
  • InstanceIdentifier

Table A-17 security_cert_x509_expiration_seconds

Field Details
Description Indicates the time to certificate expiry in epoch seconds.
Type Histogram
Dimension
  • NegotiatedTLSVersion
  • Host
  • Direction
  • InstanceIdentifier

Ingress Metrics Common Tags

Tags Description Possible Values
Method Http method GET, PUT, POST, DELETE, PATCH
NFType Name of the NF Type.

For example: Path is /nxxx-yyy/vz/.......

Where XXX(Upper Case) is NFType

UNKNOWN if unable to extract NFType from the path
NFServiceType Name of the Service within the NF.

For example: Path is /nxxx-yyy/vz/.......

Where nxxx-yyy is NFServiceType

UNKNOWN if unable to extract NFServiceType from the path
Host (Ip or fqdn): port of ingress gateway NA
HttpVersion Http protocol version HTTP/1.1, HTTP/2.0
Scheme Http protocol scheme HTTP, HTTPS, UNKNOWN
ClientCertIdentity Cerificate Identity of the client SAN=127.0.0.1,localhost CN=localhost, N/A if data is not available
Route_Path Path predicate/Header predicate that matched the current request NA
InstanceIdentifier Prefix of the pod configured in helm when there are multiple instances in same deployment Prefix configured in helm otherwise UNKNOWN
ErrorOriginator This tag captures the ErrorOriginator ServiceProducer, Nrf, IngresGW, None

oc_ingressgateway_route_ratelimit_Status

oc_ingressgateway_global_ratelimit_Status

 Request accepted or dropped accepted, dropped
oc_ingressgateway_connection_failure_Host destination ip/fqdn NA
oc_ingressgateway_connection_failure_Port destination port NA
oc_ingressgateway_xfcc_header_validate_Status Https Status value after performing xfccHeaderValidation at IGW 200 (OK), 400 (BAD_REQUEST)
oc_ingressgateway_xfcc_header_validate_Cause This tag determines the validation cause for the xfcc header validation metric being pegged VALIDATION_FAILURE, VALIDATION_SUCCESS, HEADER_NOT_FOUND
oc_ingressgateway_xfcc_header_validate_CertsCompared This tag captures the total number of certificates compared in XFCC header at IGW during the header validation Count of the certificates compared (0,1,2..)
oc_configclient_request_total_releaseVersion This tag indicates the current release version of ingress gateway Picked from helm chart{{ .Chart.Version }}
oc_configclient_request_total_configVersion This tag indicates the configuration version that ingress gateway is currently maintaining Initial value is 0. Incremental value received from config server whenever there is an update from config server (0, 1, 2...)
oc_configclient_response_total_releaseVersion This tag indicates the current release version of ingress gateway

Picked from helm chart

{{ .Chart.Version }}
oc_configclient_response_total_configVersion This tag indicates the configuration version that ingress gateway is currently maintaining Value received from config server (1, 2...)
oc_configclient_response_total_updated This tag indicates whether the configuration was updated or not true/false

OAuth Metrics

Below are the metrics and their respective tags that are available in OAuth:

Table A-18 oc_oauth_validation_successful _total

Field Details
Description This metric is pegged in the OAuth validator implementation if the received OAuth token is validated successfully. The implementation of OAuth validator is used in Ingress Gateway.
Type Counter
Dimension
  • issuer
  • subject
  • scope

Table A-19 oc_oauth_validation_failure _total

Field Details
Description This metric is pegged in the implementation of OAuth validator if the validation of the the received OAuth token fails. The implementation of OAuth validator is used in Ingress G;ateway.
Type Counter
Dimension
  • issuer
  • subject
  • scope
  • reason

OAuth Metrics Common Tags

Tags Description Possible Values
scope NF service name(s) of the NF service producer(s), separated by whitespaces NA
issuer NF instance id of NRF NA
subject NF instance id of service consumer NA
reason reason contains the human readable message for OAuth validation failure NA

Table A-20 oc_ingressgateway_msgcopy_requests_total

Field Details
Description This is incremented whenever ingress request message is sent or acknowledged from Kafka.
Type Counter
Dimension  

Table A-21 oc_ingressgateway_msgcopy_responses_total

Field Details
Description This is incremented whenever ingress response message is sent or acknowledged from Kafka.
Type Counter
Dimension