Class ObservabilityAttributes (2.79.0)

public class ObservabilityAttributes

Utility class with common attribute names in app-centric observability.

For internal use only.

Inheritance

java.lang.Object > ObservabilityAttributes

Static Fields

DESTINATION_RESOURCE_ID_ATTRIBUTE

public static final String DESTINATION_RESOURCE_ID_ATTRIBUTE

The destination resource id of the request (e.g. projects/p/locations/l/topics/t).

Field Value
Type Description
String

ERROR_DOMAIN_ATTRIBUTE

public static final String ERROR_DOMAIN_ATTRIBUTE

The domain of the error (e.g., from google.rpc.ErrorInfo.domain).

Field Value
Type Description
String

ERROR_METADATA_ATTRIBUTE_PREFIX

public static final String ERROR_METADATA_ATTRIBUTE_PREFIX

The prefix for error metadata (e.g., from google.rpc.ErrorInfo.metadata).

Field Value
Type Description
String

ERROR_TYPE_ATTRIBUTE

public static final String ERROR_TYPE_ATTRIBUTE
  • The specific error type. Value will be google.rpc.ErrorInfo.reason, a specific Server Error Code, Client-Side Network/Operational Error (e.g., CLIENT_TIMEOUT) or internal fallback.
Field Value
Type Description
String

EXCEPTION_MESSAGE_ATTRIBUTE

public static final String EXCEPTION_MESSAGE_ATTRIBUTE

If the error was caused by an exception, the exception message.

Field Value
Type Description
String

EXCEPTION_TYPE_ATTRIBUTE

public static final String EXCEPTION_TYPE_ATTRIBUTE

If the error was caused by an exception, the exception class name.

Field Value
Type Description
String

GCP_CLIENT_SERVICE_ATTRIBUTE

public static final String GCP_CLIENT_SERVICE_ATTRIBUTE

The service name of a client (e.g. "bigtable", "spanner").

Field Value
Type Description
String

GRPC_RESEND_COUNT_ATTRIBUTE

public static final String GRPC_RESEND_COUNT_ATTRIBUTE

The resend count of the request. Only used in gRPC transport.

Field Value
Type Description
String

GRPC_RPC_METHOD_ATTRIBUTE

public static final String GRPC_RPC_METHOD_ATTRIBUTE

The full RPC method name, including package, service, and method.

Field Value
Type Description
String

HTTP_METHOD_ATTRIBUTE

public static final String HTTP_METHOD_ATTRIBUTE

The HTTP method of the request (e.g., "GET"). Only used in HTTP transport.

Field Value
Type Description
String

HTTP_RESEND_COUNT_ATTRIBUTE

public static final String HTTP_RESEND_COUNT_ATTRIBUTE

The resend count of the request. Only used in HTTP transport.

Field Value
Type Description
String

HTTP_RESPONSE_BODY_SIZE

public static final String HTTP_RESPONSE_BODY_SIZE

Size of the response body in bytes.

Field Value
Type Description
String

HTTP_RESPONSE_STATUS_ATTRIBUTE

public static final String HTTP_RESPONSE_STATUS_ATTRIBUTE

The HTTP status code of the request (e.g., 200, 404).

Field Value
Type Description
String

HTTP_URL_FULL_ATTRIBUTE

public static final String HTTP_URL_FULL_ATTRIBUTE

The full URL of the HTTP request, with sensitive query parameters redacted.

Field Value
Type Description
String

HTTP_URL_TEMPLATE_ATTRIBUTE

public static final String HTTP_URL_TEMPLATE_ATTRIBUTE

The HTTP URL template of the request (e.g. "/v1/{name}:access"). Only used in HTTP transport.

Field Value
Type Description
String

REPO_ATTRIBUTE

public static final String REPO_ATTRIBUTE

The repository of the client library (e.g., "googleapis/google-cloud-java").

Field Value
Type Description
String

RPC_RESPONSE_STATUS_ATTRIBUTE

public static final String RPC_RESPONSE_STATUS_ATTRIBUTE

The error codes of the request. The value will be the string representation of the canonical gRPC status code (e.g., "OK", "INTERNAL").

Field Value
Type Description
String

RPC_SYSTEM_NAME_ATTRIBUTE

public static final String RPC_SYSTEM_NAME_ATTRIBUTE

The RPC system name, e.g. 'grpc' or 'http'.

Field Value
Type Description
String

SERVER_ADDRESS_ATTRIBUTE

public static final String SERVER_ADDRESS_ATTRIBUTE

The address of the server being called (e.g., "pubsub.googleapis.com").

Field Value
Type Description
String

SERVER_PORT_ATTRIBUTE

public static final String SERVER_PORT_ATTRIBUTE

The port of the server being called (e.g., 443).

Field Value
Type Description
String

STATUS_MESSAGE_ATTRIBUTE

public static final String STATUS_MESSAGE_ATTRIBUTE

A human-readable error message, which may include details from the exception or response.

Field Value
Type Description
String

URL_DOMAIN_ATTRIBUTE

public static final String URL_DOMAIN_ATTRIBUTE

The url domain of the request (e.g. "pubsub.googleapis.com").

Field Value
Type Description
String

URL_TEMPLATE_ATTRIBUTE

public static final String URL_TEMPLATE_ATTRIBUTE

The url template of the request (e.g. /v1/{name}:access).

Field Value
Type Description
String

Constructors

ObservabilityAttributes()

public ObservabilityAttributes()