Egress Gateway Metrics

B Egress Gateway Metrics

Table B-1 oc_egressgateway_http_requests_total

Field	Details
Available Tags	Method NFType NFServiceType Host HttpVersion Scheme Proxy InstanceIdentifier
Pegging Instance	This metric is pegged as soon as the request reaches the Egress Gateway in the first custom filter of the application.

Table B-2 oc_egressgateway_http_responses_total

Field	Details
Available Tags	Status Method NFType NFServiceType Host HttpVersion Scheme InstanceIdentifier Direction BlacklistedFqdn
Pegging Instance	This metric will be pegged in the last custom filter of the Egress gateway while the response is being sent back to backend NF microservice with direction as egress. This will also be pegged when the response is fetched in Jetty responseListener with direction as egressOut. BlacklistedFqdn tag will be filled with BlacklistedFqdn when request is sent with blacklisted producer.

Field

Details

Available Tags

Status
Method
NFType
NFServiceType
Host
HttpVersion
Scheme
InstanceIdentifier
Direction
BlacklistedFqdn

Pegging Instance

This metric will be pegged in the last custom filter of the Egress gateway while the response is being sent back to backend NF microservice with direction as egress.

This will also be pegged when the response is fetched in Jetty responseListener with direction as egressOut.

BlacklistedFqdn tag will be filled with BlacklistedFqdn when request is sent with blacklisted producer.

Table B-3 oc_egressgateway_request_latency_seconds

Field	Details
Available Tags	quantile InstanceIdentifier
Pegging Instance	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 as the request reaches the first custom filter of the application and lasts till, the response is sent back to the the consumer NF from the last custom filter of the application.

Table B-4 oc_egressgateway_connection_failure_total

Field	Details
Available Tags	Host Port InstanceIdentifier Direction error_reason
Pegging Instance	This metric will be pegged in the customized Jetty Client as soon as it fails to connect to the destination service. Here in case of Egress gateway, the destination service will be Producer NF. This will also be pegged when the request to Producer NF fails in Jetty request Listener with direction as egressOut

Field

Details

Available Tags

Host
Port
InstanceIdentifier
Direction
error_reason

Pegging Instance

This metric will be pegged in the customized Jetty Client as soon as it fails to connect to the destination service. Here in case of Egress gateway, the destination service will be Producer NF.

This will also be pegged when the request to Producer NF fails in Jetty request Listener with direction as egressOut

Table B-5 oc_egressgateway_notification_ratelimit_total

Field	Details
Available Tags	Method Scheme InstanceIdentifier
Pegging Instance	This metric is pegged in the custom filter implemented to check the notification rate limit conditions.

Table B-6 oc_egressgateway_request_processing_latency_seconds

Field	Details
Available Tags	quantile InstanceIdentifier
Pegging Instance	This metric is pegged in the last custom filter of the Egress Gateway while the response is sent back to the consumer NF. This metric tracks the amount of time taken for processing the request only within Egress Gateway. It starts as soon as the request reaches the first custom filter of the application and lasts till the request is forwarded to the destination.

Table B-7 oc_egressgateway_jetty_request_stat_metrics_total

Field	Details
Available Tags	event client_type InstanceIdentifier
Pegging Instance	This metric is pegged for every event occurred when a request is sent to EGW

Table B-8 oc_egressgateway_jetty_response_stat_metrics_total

Field	Details
Available Tags	event client_type InstanceIdentifier
Pegging Instance	This metric is pegged for every event occurred when a response is received by EGW

Table B-9 oc_egressgateway_jetty_latency_seconds

Field	Details
Available Tags	quantile InstanceIdentifier
Pegging Instance	This metric is pegged in Jetty response listener that captures the amount of time taken for processing of the request by jetty client

Table B-10 oc_egressgateway_netty_latency_seconds

Field	Details
Available Tags	quantile InstanceIdentifier
Pegging Instance	This metric is pegged in Netty outbound handler that captures the amount of time taken for processing of the request by netty server

Table B-11 oc_egressgateway_request_content_metrics_total

Field	Details
Available Tags	method content_available InstanceIdentifier
Pegging Instance	This metric is pegged by default filter RequestContentMetrics. It pegs whether request has request body or not and the method.

Table B-12 oc_egressgateway_blacklisted_producer_total

Field	Details
Available Tags	NFType NFServiceType InstanceIdentifier Host Route_path
Pegging Instance	This metric is a counter. Track number of times producer is blacklisted.

Table B-13 oc_configclient_request_total

Field	Details
Available Tags	Release version Config version
Pegging Instance	This metric will be pegged whenever config client is polling for configuration update from common configuration server

Table B-14 oc_configclient_response_total

Field	Details
Available Tags	Release version Config version Updated
Pegging Instance	This metrics will be pegged whenever config client receives response from common configuration server

Table B-15 oc_egressgateway_sbiRouting_http_responses_total

Field	Details
Available Tags	Sbi_Fqdn Reroute_Path Attempt HttpVersion Scheme InstanceIdentifier
Pegging Instance	This metric is pegged in the SBIRoutingFilter only when SBIRouting feature is enabled for a route to which request is sent to Egress Gateway.

Table B-16 oc_egressgateway_sbiRouting_http_requests_total

Field	Details
Available Tags	Sbi_Fqdn Reroute_Path Attempt HttpVersion Scheme InstanceIdentifier ErrorOriginator
Pegging Instance	This metric is pegged in the SBIRoutingFilter only when SBIRouting feature is enabled for a route to which request is sent to Egress Gateway and when sbiRerouteEnabled is set to true and reroute mechanism is executed.

Table B-17 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
Dimension	NegotiatedTLSVersion Host Direction InstanceIdentifier

Table B-18 security_cert_x509_expiration_seconds

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

Egress Gateway Metrics Common Tags

Metric Type	Available Tags	Possible Values
Method	Http method	GET, PUT, POST, DELETE, PATCH
NFType	Name of the NF Type	"UNKNOWN" (Updates are available when Ingress is 5G aware)
NFServiceType	Name of the Service within the NF	"UNKNOWN" (Updates are available when Ingress is 5G aware)
Host	(IP or fqdn): port of ingress gateway	Not Applicable
HttpVersion	Http protocol version (http1.1/ http2)	HTTP1.1, HTTP2.0
Scheme	Http protocol scheme (http/https)	HTTP, HTTPS, UNKNOWN
Proxy	Value received for "x-custom-egress-proxy-header".	Unknown or value of "x-custom-egress-proxy-header".
oc_egressgateway_connection_failure_Host	destination ip/fqdn	Not Applicable
oc_egressgateway_connection_failure_Port	destination port	Not Applicable
BlacklistedFqdn	Blacklisted Producer Fqdn	Unknown or Blacklisted Producer Fqdn
oc_configclient_request_total_releaseVersion	This tag indicates the current release version of egress gateway	Picked from helm chart{{ .Chart.Version }}
oc_configclient_request_total_configVersion	This tag indicates the configuration version that egress 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 egress gateway	Picked from helm chart{{ .Chart.Version }}
oc_configclient_response_total_configVersion	This tag indicates the configuration version that egress 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

Table B-19 oc_oauth_nrf_request_total

Field	Details
Available Tags	ConsumerNFInstanceId ConsumerNFType TargetNFType TargetNFInstanceId scope NrfFqdn
Pegging Instance	This metric is pegged in the OAuth client implementation if the request is sent to NRF for requesting the OAuth token. OAuth client implementation will be used in Egress gateway.

Table B-20 oc_oauth_token_cache_total

Field	Details
Available Tags	ConsumerNFInstanceId ConsumerNFType TargetNFType TargetNFInstanceId scope
Pegging Instance	This metric is pegged in the OAuth Client Implementation if the OAuth token is found in the cache.

Table B-21 oc_oauth_validation_successful_total

Field	Details
Available Tags	issuer subject scope
Pegging Instance	This metric is pegged in OAuth validator implementation if the received OAuth token is validated successfully. OAuth validator implementation is used in Ingress Gateway.

Table B-22 oc_oauth_validation_failure_total

Field	Details
Available Tags	issuer subject scope reason
Pegging Instance	This metric is pegged in OAuth validator implementation if the validation of the the received OAuth token is failed. OAuth validator implementation is used in Ingress gateway.

OAuth Metrics common tags

Common Tags	Description	Possible Values
ConsumerNFInstanceId	NF instance id of the NF service consumer	Not Applicable
ConsumerNFType	The NF type of the NF service consumer	NRF, UDM, AMF, SMF, AUSF, NEF, PCF, SMSF, NSSF, UDR, LMF, GMLC,5G_EIR, SEPP, UPF, N3IWF, AF, UDSF, BSF, CHF, NWDAF
TargetNFType	The NF type of the NF service producer	NRF, UDM, AMF, SMF, AUSF, NEF, PCF, SMSF, NSSF, UDR, LMF, GMLC,5G_EIR, SEPP, UPF, N3IWF, AF, UDSF, BSF, CHF, NWDAF
TargetNFInstanceId	NF instance id of the NF service producer	Not Applicable
scope	NF service name(s) of the NF service producer(s), separated by whitespaces	Not Applicable
StatusCode	Status code of NRF access token request	Bad Request, Internal Server Error, and so on (HttpStatus.*)
ErrorOriginator	from where the error is originated (nrf or egress)	Nrf, EgressGW
issuer	NF instance id of NRF	Not Applicable
subject	NF instance id of service consumer	Not Applicable
reason	reason contains the human readable msg for OAuth validation failure	Not Applicable
NrfFqdn	NrfFqdn tag determines the corresponding fqdn of NRF where the request has been forwarded to.	Nrf-Fqdn (dynamic value based on Fqdn), NA
NrfClientUrl	This tag determines the url of NRF-Client Mgmt Svc where subscription requests are sent from OAuth Client module in EGW.	URL of NRF-Client Mgmt Svc (Dynamic value)
EgwNotificationUrl	This tag determines the notification URL mapped in OAuth Client module of EGW where NRF-Client Mgmt Svc will send notifications requests.	Notification URL (Dynamic value)
ConfigurationType	This tag determines the type of configuration in place for OAuth Client in Egress Gateway. If nrfClientQueryEnabled Helm parameter in oauthClient Helm configurations at Egress Gateway is false then the ConfigurationType is STATIC, else DYNAMIC.	STATIC, DYNAMIC

Table B-23 oc_egressgateway_msgcopy_requests_total

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

Table B-24 oc_egressgateway_msgcopy_responses_total

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