Class TelemetryConstants (2.40.0) 

public class TelemetryConstants

Internal telemetry constants shared between OpenTelemetry tracing and metrics.

Warning: This is intended to be an internal API and is not intended for external use. This is public solely for implementation purposes and does not promise any backwards compatibility.

Inheritance

java.lang.Object > TelemetryConstants

Static Fields

ATTRIBUTES_KEY_DATABASE_ID

public static final String ATTRIBUTES_KEY_DATABASE_ID

Attribute key for the Datastore database ID.

Field Value
Type Description
String

ATTRIBUTES_KEY_DEFERRED

public static final String ATTRIBUTES_KEY_DEFERRED
Field Value
Type Description
String

ATTRIBUTES_KEY_DOCUMENT_COUNT

public static final String ATTRIBUTES_KEY_DOCUMENT_COUNT
Field Value
Type Description
String

ATTRIBUTES_KEY_METHOD

public static final String ATTRIBUTES_KEY_METHOD

Attribute key for the RPC method name (e.g. "Transaction.Run").

Field Value
Type Description
String

ATTRIBUTES_KEY_MISSING

public static final String ATTRIBUTES_KEY_MISSING
Field Value
Type Description
String

ATTRIBUTES_KEY_MORE_RESULTS

public static final String ATTRIBUTES_KEY_MORE_RESULTS
Field Value
Type Description
String

ATTRIBUTES_KEY_PROJECT_ID

public static final String ATTRIBUTES_KEY_PROJECT_ID

Attribute key for the GCP project ID.

Field Value
Type Description
String

ATTRIBUTES_KEY_READ_CONSISTENCY

public static final String ATTRIBUTES_KEY_READ_CONSISTENCY
Field Value
Type Description
String

ATTRIBUTES_KEY_RECEIVED

public static final String ATTRIBUTES_KEY_RECEIVED
Field Value
Type Description
String

ATTRIBUTES_KEY_SERVICE

public static final String ATTRIBUTES_KEY_SERVICE

String key for the service metric attribute (value: "service").

Field Value
Type Description
String

ATTRIBUTES_KEY_STATUS

public static final String ATTRIBUTES_KEY_STATUS

Attribute key for the gRPC status code (e.g. "OK", "ABORTED", "UNAVAILABLE").

Field Value
Type Description
String

ATTRIBUTES_KEY_TRANSACTIONAL

public static final String ATTRIBUTES_KEY_TRANSACTIONAL
Field Value
Type Description
String

ATTRIBUTES_KEY_TRANSACTION_ID

public static final String ATTRIBUTES_KEY_TRANSACTION_ID
Field Value
Type Description
String

CLIENT_UID_KEY

public static final AttributeKey<String> CLIENT_UID_KEY
Field Value
Type Description
io.opentelemetry.api.common.AttributeKey<String>

COMMON_ATTRIBUTES

public static final Set<AttributeKey<?>> COMMON_ATTRIBUTES

The allowlist of metric attributes that are permitted on every exported data point.

Cloud Monitoring is strict about label schemas: exporting a label that was not present when the metric descriptor was first created will cause the entire createTimeSeries call to fail. Only status, method, service, and client_uid are accepted; all other attributes must be omitted from every record*() call.

Field Value
Type Description
Set<io.opentelemetry.api.common.AttributeKey<?>>

DATABASE_ID_KEY

public static final AttributeKey<String> DATABASE_ID_KEY
Field Value
Type Description
io.opentelemetry.api.common.AttributeKey<String>

DATASTORE_METER_NAME

public static final String DATASTORE_METER_NAME
Field Value
Type Description
String

DATASTORE_RESOURCE_LABELS

public static final Set<String> DATASTORE_RESOURCE_LABELS
Field Value
Type Description
Set<String>

DATASTORE_RESOURCE_TYPE

public static final String DATASTORE_RESOURCE_TYPE
Field Value
Type Description
String

LOCATION_ID_KEY

public static final AttributeKey<String> LOCATION_ID_KEY
Field Value
Type Description
io.opentelemetry.api.common.AttributeKey<String>

METHOD_ALLOCATE_IDS

public static final String METHOD_ALLOCATE_IDS
Field Value
Type Description
String

METHOD_BEGIN_TRANSACTION

public static final String METHOD_BEGIN_TRANSACTION
Field Value
Type Description
String

METHOD_COMMIT

public static final String METHOD_COMMIT
Field Value
Type Description
String

METHOD_KEY

public static final AttributeKey<String> METHOD_KEY
Field Value
Type Description
io.opentelemetry.api.common.AttributeKey<String>

METHOD_LOOKUP

public static final String METHOD_LOOKUP
Field Value
Type Description
String

METHOD_RESERVE_IDS

public static final String METHOD_RESERVE_IDS
Field Value
Type Description
String

METHOD_ROLLBACK

public static final String METHOD_ROLLBACK
Field Value
Type Description
String

METHOD_RUN_AGGREGATION_QUERY

public static final String METHOD_RUN_AGGREGATION_QUERY
Field Value
Type Description
String

METHOD_RUN_QUERY

public static final String METHOD_RUN_QUERY
Field Value
Type Description
String

METHOD_TRANSACTION_COMMIT

public static final String METHOD_TRANSACTION_COMMIT
Field Value
Type Description
String

METHOD_TRANSACTION_RUN

public static final String METHOD_TRANSACTION_RUN
Field Value
Type Description
String

METRIC_NAME_ATTEMPT_COUNT

public static final String METRIC_NAME_ATTEMPT_COUNT

Metric name for the count of RPC attempts.

Field Value
Type Description
String

METRIC_NAME_ATTEMPT_LATENCY

public static final String METRIC_NAME_ATTEMPT_LATENCY

Metric name for the latency of a single RPC attempt.

The plural form (attempt_latencies) is intentional: it matches the internal Cloud Monitoring metric descriptor name. OpenTelemetryDatastoreMetricsRecorder overrides the inherited GAX method to record to this name rather than the singular GAX default.

Field Value
Type Description
String

METRIC_NAME_OPERATION_COUNT

public static final String METRIC_NAME_OPERATION_COUNT

Metric name for the count of operations.

Field Value
Type Description
String

METRIC_NAME_OPERATION_LATENCY

public static final String METRIC_NAME_OPERATION_LATENCY

Metric name for the total latency of an operation (one full RPC call including retries).

The plural form (operation_latencies) is intentional: it matches the internal Cloud Monitoring metric descriptor name. OpenTelemetryDatastoreMetricsRecorder overrides the inherited GAX method to record to this name rather than the singular GAX default.

Field Value
Type Description
String

METRIC_NAME_TRANSACTION_ATTEMPT_COUNT

public static final String METRIC_NAME_TRANSACTION_ATTEMPT_COUNT

Metric name for the number of attempts a transaction took.

Field Value
Type Description
String

METRIC_NAME_TRANSACTION_LATENCY

public static final String METRIC_NAME_TRANSACTION_LATENCY

Metric name for the total latency of a transaction.

Field Value
Type Description
String

METRIC_PREFIX

public static final String METRIC_PREFIX
Field Value
Type Description
String

PROJECT_ID_KEY

public static final AttributeKey<String> PROJECT_ID_KEY
Field Value
Type Description
io.opentelemetry.api.common.AttributeKey<String>

RESOURCE_LABEL_DATABASE_ID

public static final String RESOURCE_LABEL_DATABASE_ID
Field Value
Type Description
String

RESOURCE_LABEL_LOCATION

public static final String RESOURCE_LABEL_LOCATION
Field Value
Type Description
String

RESOURCE_LABEL_PROJECT_ID

public static final String RESOURCE_LABEL_PROJECT_ID
Field Value
Type Description
String

SERVICE_KEY

public static final AttributeKey<String> SERVICE_KEY
Field Value
Type Description
io.opentelemetry.api.common.AttributeKey<String>

SERVICE_VALUE

public static final String SERVICE_VALUE
Field Value
Type Description
String

STATUS_KEY

public static final AttributeKey<String> STATUS_KEY
Field Value
Type Description
io.opentelemetry.api.common.AttributeKey<String>