Egress Gateway Metrics

B Egress Gateway Metrics

The following table describes the Egress Gateway Metrics.

Table B-1 occnp_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 occnp_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_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-10 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-11 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-12 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-13 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-14 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-15 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-16 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

Egress Gateway Metrics Common Tags

The following table describes the common tags used in Egress Gateway Metrics.

Table B-17 Method

Field	Details
Available Tags	Http method
Pegging Instance	GET, PUT, POST, DELETE, PATCH

Table B-18 NFType

Field	Details
Available Tags	Name of the NF Type
Pegging Instance	"UNKNOWN" (Updates are available when Ingress is 5G aware)

Table B-19 NFServiceType

Field	Details
Available Tags	Name of the Service within the NF
Pegging Instance	"UNKNOWN" (Updates are available when Ingress is 5G aware)

Table B-20 Host

Field	Details
Available Tags	(IP or fqdn): port of ingress gateway
Pegging Instance	Not Applicable

Table B-21 HttpVersion

Field	Details
Available Tags	Http protocol version (http1.1/ http2)
Pegging Instance	HTTP1.1, HTTP2.0

Table B-22 Scheme

Field	Details
Available Tags	Http protocol scheme (http/https)
Pegging Instance	HTTP, HTTPS, UNKNOWN

Table B-23 Proxy

Field	Details
Available Tags	Value received for "x-custom-egress-proxy-header".
Pegging Instance	Unknown or value of "x-custom-egress-proxy-header".

Table B-24 oc_egressgateway_connection_failure_Host

Field	Details
Available Tags	destination ip/fqdn
Pegging Instance	Not Applicable

Table B-25 oc_egressgateway_connection_failure_Port

Field	Details
Available Tags	destination port
Pegging Instance	Not Applicable

Table B-26 BlacklistedFqdn

Field	Details
Available Tags	Blacklisted Producer Fqdn
Pegging Instance	Unknown or Blacklisted Producer Fqdn

Table B-27 oc_configclient_request_total_releaseVersion

Field	Details
Available Tags	This tag indicates the current release version of egress gateway
Pegging Instance	Picked from helm chart{{ .Chart.Version }}

Table B-28 oc_configclient_request_total_configVersion

Field	Details
Available Tags	This tag indicates the configuration version that egress gateway is currently maintaining
Pegging Instance	Initial value is 0. Incremental value received from config server whenever there is an update from config server (0, 1, 2...)

Table B-29 oc_configclient_response_total_releaseVersion

Field	Details
Available Tags	This tag indicates the current release version of egress gateway
Pegging Instance	Picked from helm chart{{ .Chart.Version }}

Table B-30 oc_configclient_response_total_configVersion

Field	Details
Available Tags	This tag indicates the configuration version that egress gateway is currently maintaining
Pegging Instance	Value received from config server (1, 2...)

Table B-31 oc_configclient_response_total_updated

Field	Details
Available Tags	This tag indicates whether the configuration was updated or not
Pegging Instance	true/false

SCP Metrics

The following table describes the different metrics and their respective tags that are available in the SCP Module:

Table B-32 oc_egressgateway_sbiRouting_http_requests_total

Field	Details
Available Tags	Scp_Fqdn Reroute_Path Attempt HttpVersion Scheme InstanceIdentifier
Pegging Instance	This metric will be pegged when SBIRouting feature is enabled for a route to which request is sent to EGW

Table B-33 oc_egressgateway_sbiRouting_http_responses_total

Field	Details
Available Tags	Scp_Fqdn Reroute_Path Status Attempt HttpVersion Scheme InstanceIdentifier ErrorOriginator
Pegging Instance	This metric is pegged only when SBIRouting feature is enabled for a route to which request is sent to EGW and reroute mechanism is executed.

Table B-34 oc_egressgateway_sbiRouting_request_distribution

Field	Details
Available Tags	request_distribution_type:<Priority_Based/Weight_Based> oc_alternateroute_attempt:<oc_alternateroute_attempt>
Pegging Instance	For every request, this metric should be pegged to depict whether request would follow RFC( weight-based) or it will go through priority based routing.

Table B-35 oc_egressgateway_sbiRouting_weightBased_distribution

Field	Details
Available Tags	virtual_Fqdn:<virtual_Fqdn> host:<host> port:<port>
Pegging Instance	This metric will be pegged to show the distribution of traffic on virtual fqdn only when weight-based-algorithm is applied.

Table B-36 oc_egressgateway_sbiRouting_http_error_responses_total

Field	Details
Available Tags	statusCode InstanceIdentifier authority targetDestination
Pegging Instance	This metric will be pegged to show the number of error responses received by egress gateway.

Table B-37 oc_egressgateway_sbiRouting_retry_info

Field	Details
Available Tags	attempt retryStatusCode retryReason InstanceIdentifier authority targetDestination
Pegging Instance	This metric will be pegged to show the number of retry made out of egress gateway.

Table B-38 oc_egressgateway_sbiRouting_reroute_info

Field	Details
Available Tags	attempt rerouteStatusCode InstanceIdentifier authority targetDestination
Pegging Instance	This metric will be pegged to show the number of re-route made out of egress gateway.

Table B-39 oc_egressgateway_sbiRouting_response_body_fetch

Field	Details
Available Tags	NA
Pegging Instance	This metric will be pegged to show the number of times EGW had to block and fetch the response payload.

Table B-40 occnp_oc_egressgateway_sbiRouting_cause_based_validation_success_total

Field	Details
Available Tags	NA
Pegging Instance	This metric will be pegged to show the number of times the cause-based validation was successful.

Table B-41 occnp_oc_egressgateway_sbiRouting_cause_based_validation_failure_total

Field	Details
Available Tags	cause
Pegging Instance	This metric will be pegged to show the number of times the cause-based validation failed.

Table B-42 oc_egressgateway_sbiRouting_attempts_to_fulfill_request

Field	Details
Available Tags	NA
Pegging Instance	This metrics will be pegged to show the number of attempts taken to fulfill a request.

SCP Metrics common tags

The following table describes common tags used in SCP Metrics.

Table B-43 Scp_Fqdn

Field	Details
Description	SCP Fqdn
Possible Values	Not Applicable

Table B-44 Reroute_Path

Field Details

Description

Field	Details
Description	Path that matched the request to over corresponding route Example: `/nef/**`
Possible Values	Not Applicable

Path that matched the request to over corresponding route

Example: /nef/**

Possible Values Not Applicable

Table B-45 Status

Field	Details
Description	Sbi peer response status code.
Possible Values	200 OK

Table B-46 Attempt

Field	Details
Description	Attempt number for scp re-route. Example: 1, 2 etc.
Possible Values	Not Applicable

Field

Details

Description

Attempt number for scp re-route.

Example: 1, 2 etc.

Possible Values

Not Applicable

Table B-47 HttpVersion

Field	Details
Description	Http protocol version (http1.1/ http2)
Possible Values	HTTP/1.1, HTTP/2.0

Table B-48 Scheme

Field	Details
Description	Http protocol scheme (http/https)
Possible Values	HTTP, HTTPS, UNKNOWN

Table B-49 InstanceIdentifier

Field	Details
Description	Prefix of the pod configured in helm when there are multiple instances in same deployment
Possible Values	Prefix configured in helm otherwise UNKNOWN

Oauth Metrics

The following table includes metrics and their respective tags that are available in the Oauth Module:

Table B-50 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-51 oc_oauth_nrf_response_success_total

Field	Details
Available Tags	ConsumerNFInstanceId ConsumerNFType TargetNFType TargetNFInstanceId scope StatusCode NrfFqdn
Pegging Instance	This metric is pegged in the OAuth client implementation if an OAuth token is successfully received from the NRF. OAuth client implementation is used in the Egress Gateway.

Table B-52 oc_oauth_nrf_response_failure_total

Field	Details
Available Tags	ConsumerNFInstanceId ConsumerNFType TargetNFType TargetNFInstanceId scope StatusCode ErrorOriginator NrfFqdn
Pegging Instance	This metric is pegged in the OAuthClientFilter in Egress Gateway whenever GetAccessTokenFailedException is caught.

Table B-53 oc_oauth_request_failed_internal_total

Field	Details
Available Tags	ConsumerNFInstanceId ConsumerNFType TargetNFType TargetNFInstanceId scope StatusCode ErrorOriginator NrfFqdn
Pegging Instance	This metric is pegged in the OAuthClientFilter in Egress Gateway whenever InternalServerErrorException is caught.

Table B-54 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-55 oc_oauth_request_invalid_total

Field	Details
Available Tags	ConsumerNFInstanceId ConsumerNFType TargetNFType TargetNFInstanceId scope StatusCode ErrorOriginator
Pegging Instance	This metric is pegged in the OAuthClientFilter in Egress Gateway whenever a BadAccessTokenRequestException/JsonProcessingException is caught.

Table B-56 oc_egressgateway_ouath_access_token_request_header_missing

Field	Details
Available Tags	NA
Pegging Instance	This metric is pegged in the OAuthClientFilter in Egress Gateway whenever oc-access-token-request-info header is missing in the request.

Table B-57 oc_oauth_cert_expiryStatus

Field	Details
Available Tags	id certificateName secretName
Pegging Instance	This Gauge metric is used to peg expiry date of the certificate. This metric is further used for raising alarms if certificate expires within 30 days or 7 days.

Table B-58 oc_oauth_cert_loadStatus

Field	Details
Available Tags	id certificateName secretName
Pegging Instance	This gauge metric is used to peg expiry date of the certificate. This metric is further used for raising alarms if certificate expires within 30 days or 7 days.

Table B-59 oc_oauth_request_failed_cert_expiry

Field	Details
Available Tags	target nf type target nf instance id consumer nf instance id nrf instance id service name of nf producer service key id
Pegging Instance	This counter metric is used to keep track of number of requests with keyId in token that failed due to certificate expiry. It is pegged whenever oAuth Validator module throws oauth custom exception due to certificate expiry for an incoming request.

Table B-60 oc_oauth_keyid_count

Field	Details
Available Tags	target nf type target nf instance id consumer nf instance id nrf instance id service name of nf producer service key id
Pegging Instance	This counter metric used to keep track of number of requests received with keyId in token. It is pegged whenever a request with an access token containing keyid in header comes to oAuth Validator.

Table B-61 oc_oauth_nrf_token_retrieval_failure_total

Field	Details
Available Tags	ConsumerNFInstanceId ConsumerNFType TargetNFType TargetNFInstanceId scope StatusCode ErrorOriginator ErrorDetail NrfFqdn
Pegging Instance	This metric is pegged to track requests discarded due to oAuth token retrieval failure from NRF.

OAuth Metrics (NRF-Client Mgmt Service Call-Flow)

Table B-62 oc_oauth_nrf_client_subscription_request_total

Field

Details

Available Tags

NrfClientUrl
EgwNotificationUrl

When it is pegged

This metric will be pegged in the OAuth client implementation module

when a subscription request is sent from EGW to NRF-Client Mgmt Svc

with request-URL (NrfClientUrl) and request body containing notification-URL of EGW (EgwNotificationUrl) for Oauth Client notification requests generated from NRF-Client Mgmt Svc to EGW. OAuth client implementation will be used in Egress gateway.

Table B-63 oc_oauth_nrf_client_notification_request_total

Field	Details
Available Tags	None
When it is pegged	This metric will be pegged in the OAuth client implementation module when a notification request is sent from NRF-Client Mgmt Svc to EGW.OAuth client implementation will be used in Egress gateway.

Table B-64 oc_oauth_nrf_client_subscription_response_total

Field

Details

Available Tags

NrfClientUrl
EgwNotificationUrl
StatusCode

When it is pegged

This metric will be pegged in the OAuth client implementation module

when a subscription response is sent from NRF-Client Mgmt Svc having

URL (NrfClientUrl) to EGW having URL (EgwNotificationUrl). StatusCode

tag will capture the corresponding response status obtained from

NRF-Client. OAuth client implementation will be used in Egress gateway.

Table B-65 oc_oauth_nrf_client_notification_response_total

Field	Details
Available Tags	StatusCode
When it is pegged	This metric will be pegged in the OAuth client implementation modulewhen a notification response is sent from EGW to NRF-Client Mgmt Svc.StatusCode tag will capture the corresponding response status sent fromEGW. OAuth client implementation will be used in Egress gateway.

Table B-66 oc_oauth_nrf_client_active_nrf_instances

Field	Details
Available Tags	NrfFqdn
When it is pegged	This is a GAUGE metric which keeps track of healthy NRF Fqdns recievedfrom NRF-Client Mgmt Svc as part of subscription response/ notificationrequest to EGW.

OAuth Metrics common tags

The following table describes common tags used in the OAuth Module.

Table B-67 ConsumerNFInstanceId

Field	Details
Description	NF instance id of the NF service consumer
Possible Values	Not Applicable

Table B-68 ConsumerNFType

Field	Details
Description	The NF type of the NF service consumer
Possible Values	NRF, UDM, AMF, SMF, AUSF, NEF, PCF, SMSF, NSSF, UDR, LMF, GMLC,5G_EIR, SEPP, UPF, N3IWF, AF, UDSF, BSF, CHF, NWDAF

Table B-69 TargetNFType

Field	Details
Description	The NF type of the NF service producer
Possible Values	NRF, UDM, AMF, SMF, AUSF, NEF, PCF, SMSF, NSSF, UDR, LMF, GMLC,5G_EIR, SEPP, UPF, N3IWF, AF, UDSF, BSF, CHF, NWDAF

Table B-70 TargetNFInstanceId

Field	Details
Description	NF instance id of the NF service producer
Possible Values	Not Applicable

Table B-71 scope

Field	Details
Description	NF service name(s) of the NF service producer(s), separated by whitespaces
Possible Values	Not Applicable

Table B-72 StatusCode

Field	Details
Description	Status code of NRF access token request
Possible Values	Bad Request, Internal Server Error etc. (HttpStatus.*)

Table B-73 ErrorOriginator

Field	Details
Description	from where error is originated (nrf or egress)
Possible Values	Nrf, EgressGW

Table B-74 issuer

Field	Details
Description	NF instance id of NRF
Possible Values	Not Applicable

Table B-75 subject

Field	Details
Description	NF instance id of service consumer
Possible Values	Not Applicable

Table B-76 reason

Field	Details
Description	reason contains the human readable msg for oauth validation failure
Possible Values	Not Applicable

Table B-77 NrfFqdn

Field	Details
Description	NrfFqdn tag determines the corresponding fqdn of NRF where the request has been forwarded to.
Possible Values	Nrf-Fqdn (dynamic value based on Fqdn), NA

Table B-78 NrfClientUrl

Field	Details
Description	This tag determines the url of NRF-Client Mgmt Svc where subscription requests are sent from OAuth Client module in EGW.
Possible Values	URL of NRF-Client Mgmt Svc (Dynamic value)

Table B-79 EgwNotificationUrl

Field	Details
Description	This tag determines the notification URL mapped in OAuth Client module of EGW where NRF-Client Mgmt Svc will send notifications requests.
Possible Values	Notification URL (Dynamic value)

Table B-80 ConfigurationType

Field	Details
Description	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.
Possible Values	STATIC, DYNAMIC

Table B-81 oc_egressgateway_msgcopy_requests_total

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

Table B-82 oc_egressgateway_msgcopy_responses_total

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