Package com.activeviam.database.internal

Class ObservabilityUtil

java.lang.Object

com.activeviam.database.internal.ObservabilityUtil

public class ObservabilityUtil
extends Object

Observability utilities.

Author:

ActiveViam

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMMIT_TRANSACTION
static final String	EXCEPTION_RECORDED
static final String	IS_NOT_SHADOW
static final String	IS_SHADOW
static final String	MAINTENANCE_OPERATION
static final String	ROLLBACK_TRANSACTION
static final String	SPAN_BIGQUERY_ARROW_STREAM_READING
static final String	SPAN_BIGQUERY_JOB_EXEC
static final String	SPAN_BIGQUERY_JOB_INIT
static final String	SPAN_BIGQUERY_QUERY_TASK
static final String	SPAN_BIGQUERY_RESULT_PROCESSING
static final String	SPAN_CLICKHOUSE_QUERY_COMPUTATION
static final String	SPAN_CLICKHOUSE_QUERY_PREPARATION
static final String	SPAN_CLICKHOUSE_QUERY_TASK
static final String	SPAN_CLICKHOUSE_RESULT_PROCESSING
static final String	SPAN_DATA_CONTRIBUTION	Spans.
static final String	SPAN_DATABASE_QUERY
static final String	SPAN_DATASTORE_MAINTENANCE_OPERATION
static final String	SPAN_DATASTORE_TRANSACTION
static final String	SPAN_JDBC_QUERY_COMPUTATION
static final String	SPAN_JDBC_QUERY_EXECUTION_TASK
static final String	SPAN_JDBC_QUERY_PREPARATION
static final String	SPAN_JDBC_QUERY_RESULT_PROCESSING
static final String	SPAN_JDBC_QUERY_RESULT_READING
static final String	SPAN_TIME_TRAVEL_FETCHING
static final String	TAG_AGGREGATE_TABLE	Tag the local name of the Aggregate Table when one is used to optimize the query.
static final String	TAG_BIGQUERY_JOB_ID
static final String	TAG_BIGQUERY_JOB_STATS
static final String	TAG_BIGQUERY_JOB_STATUS
static final String	TAG_BIGQUERY_STREAM_STATS
static final String	TAG_CLICKHOUSE_QUERY_ID
static final String	TAG_CLICKHOUSE_STATS
static final String	TAG_DATABASE	Tag keys (kebab case).
static final String	TAG_EPOCH_ID
static final String	TAG_INTENDED_ACTION
static final String	TAG_SHADOW_TRANSACTION
static final String	TAG_SNOWFLAKE_QUERY_ID
static final String	TAG_SNOWFLAKE_RESULTSET_COUNT
static final String	TAG_SNOWFLAKE_RESULTSET_STATS
static final String	TAG_SQL_AGG_QUERY_PROCESSING_STATS
static final String	TAG_SQL_QUERY_PARAMETERS
static final String	TAG_SQL_QUERY_TEXT
static final String	TAG_STORES_LOCKED_BY_TRANSACTION
static final String	TAG_TRANSACTION_BRANCH
static final String	TAG_TRANSACTION_OUTCOME
static final String	TAG_WRITABLE_STORES
static final String	TYPE_AGGREGATE
static final String	TYPE_DISTINCT
static final String	TYPE_GET_BY_KEY
static final String	TYPE_LIST	Query types corresponding to the tag Observability.QUERY_TYPE_ATTRIBUTE for database queries.
static final String	TYPE_MULTI_STEP_AGGREGATE

Method Summary

Modifier and Type	Method	Description
static io.opentelemetry.api.trace.SpanBuilder	buildSpanNotStarted(io.opentelemetry.api.trace.Span parentSpan, String name)	Creates a new span without starting it.
static io.opentelemetry.api.trace.SpanBuilder	buildSpanNotStarted(io.opentelemetry.api.trace.Span parentSpan, String name, Map<String,String> tags)	Creates a new span without starting it.
static io.opentelemetry.api.trace.SpanBuilder	buildSpanNotStarted(String name)	Creates a new span without starting it.
static IEpoch	createDatabaseEpochWithObservability(IEpochCreator epochCreator, String branchName, boolean isShadow, DatabaseId databaseId)	Creates a database epoch and updates the associated sum metric.
static Map<String,String>	propagateTraceInTags(Map<String,String> queryTags)	Propagates trace tags in query tags if it exists.
static void	runInSpan(io.opentelemetry.api.trace.SpanBuilder span, Runnable runnable)	Runs in a span.
static void	sendQueryMetrics(long startTime, boolean success, String subtype, String tableName)	Sends query metrics.
static <T> T	supplyInSpan(io.opentelemetry.api.trace.SpanBuilder span, Supplier<T> supplier)	Supplies the value in a span.
static void	tagCurrentSpan(String key, Supplier<String> valueSupplier)	Tags current span if there is one.
static void	tagCurrentSpan(Supplier<Map<String,String>> tagSupplier)	Tags current span if there is one.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SPAN_DATA_CONTRIBUTION

public static final String SPAN_DATA_CONTRIBUTION

Spans.

See Also:

• Constant Field Values

SPAN_TIME_TRAVEL_FETCHING

public static final String SPAN_TIME_TRAVEL_FETCHING

See Also:

• Constant Field Values

SPAN_DATABASE_QUERY

public static final String SPAN_DATABASE_QUERY

See Also:

• Constant Field Values

SPAN_BIGQUERY_QUERY_TASK

public static final String SPAN_BIGQUERY_QUERY_TASK

See Also:

• Constant Field Values

SPAN_BIGQUERY_JOB_INIT

public static final String SPAN_BIGQUERY_JOB_INIT

See Also:

• Constant Field Values

SPAN_BIGQUERY_JOB_EXEC

public static final String SPAN_BIGQUERY_JOB_EXEC

See Also:

• Constant Field Values

SPAN_BIGQUERY_RESULT_PROCESSING

public static final String SPAN_BIGQUERY_RESULT_PROCESSING

See Also:

• Constant Field Values

SPAN_BIGQUERY_ARROW_STREAM_READING

public static final String SPAN_BIGQUERY_ARROW_STREAM_READING

See Also:

• Constant Field Values

SPAN_CLICKHOUSE_QUERY_COMPUTATION

public static final String SPAN_CLICKHOUSE_QUERY_COMPUTATION

See Also:

• Constant Field Values

SPAN_CLICKHOUSE_QUERY_PREPARATION

public static final String SPAN_CLICKHOUSE_QUERY_PREPARATION

See Also:

• Constant Field Values

SPAN_CLICKHOUSE_QUERY_TASK

public static final String SPAN_CLICKHOUSE_QUERY_TASK

See Also:

• Constant Field Values

SPAN_CLICKHOUSE_RESULT_PROCESSING

public static final String SPAN_CLICKHOUSE_RESULT_PROCESSING

See Also:

• Constant Field Values

SPAN_JDBC_QUERY_COMPUTATION

public static final String SPAN_JDBC_QUERY_COMPUTATION

See Also:

• Constant Field Values

SPAN_JDBC_QUERY_PREPARATION

public static final String SPAN_JDBC_QUERY_PREPARATION

See Also:

• Constant Field Values

SPAN_JDBC_QUERY_EXECUTION_TASK

public static final String SPAN_JDBC_QUERY_EXECUTION_TASK

See Also:

• Constant Field Values

SPAN_JDBC_QUERY_RESULT_PROCESSING

public static final String SPAN_JDBC_QUERY_RESULT_PROCESSING

See Also:

• Constant Field Values

SPAN_JDBC_QUERY_RESULT_READING

public static final String SPAN_JDBC_QUERY_RESULT_READING

See Also:

• Constant Field Values

SPAN_DATASTORE_MAINTENANCE_OPERATION

public static final String SPAN_DATASTORE_MAINTENANCE_OPERATION

See Also:

• Constant Field Values

SPAN_DATASTORE_TRANSACTION

public static final String SPAN_DATASTORE_TRANSACTION

See Also:

• Constant Field Values

TAG_DATABASE

public static final String TAG_DATABASE

Tag keys (kebab case).

See Also:

• Constant Field Values

COMMIT_TRANSACTION

public static final String COMMIT_TRANSACTION

See Also:

• Constant Field Values

EXCEPTION_RECORDED

public static final String EXCEPTION_RECORDED

See Also:

• Constant Field Values

IS_NOT_SHADOW

public static final String IS_NOT_SHADOW

See Also:

• Constant Field Values

IS_SHADOW

public static final String IS_SHADOW

See Also:

• Constant Field Values

MAINTENANCE_OPERATION

public static final String MAINTENANCE_OPERATION

See Also:

• Constant Field Values

ROLLBACK_TRANSACTION

public static final String ROLLBACK_TRANSACTION

See Also:

• Constant Field Values

TAG_EPOCH_ID

public static final String TAG_EPOCH_ID

See Also:

• Constant Field Values

TAG_INTENDED_ACTION

public static final String TAG_INTENDED_ACTION

See Also:

• Constant Field Values

TAG_SHADOW_TRANSACTION

public static final String TAG_SHADOW_TRANSACTION

See Also:

• Constant Field Values

TAG_STORES_LOCKED_BY_TRANSACTION

public static final String TAG_STORES_LOCKED_BY_TRANSACTION

See Also:

• Constant Field Values

TAG_TRANSACTION_BRANCH

public static final String TAG_TRANSACTION_BRANCH

See Also:

• Constant Field Values

TAG_TRANSACTION_OUTCOME

public static final String TAG_TRANSACTION_OUTCOME

See Also:

• Constant Field Values

TAG_WRITABLE_STORES

public static final String TAG_WRITABLE_STORES

See Also:

• Constant Field Values

TAG_AGGREGATE_TABLE

public static final String TAG_AGGREGATE_TABLE

Tag the local name of the Aggregate Table when one is used to optimize the query.

See Also:

• Constant Field Values

TAG_SQL_QUERY_TEXT

public static final String TAG_SQL_QUERY_TEXT

See Also:

• Constant Field Values

TAG_SQL_QUERY_PARAMETERS

public static final String TAG_SQL_QUERY_PARAMETERS

See Also:

• Constant Field Values

TAG_SQL_AGG_QUERY_PROCESSING_STATS

public static final String TAG_SQL_AGG_QUERY_PROCESSING_STATS

See Also:

• Constant Field Values

TAG_BIGQUERY_JOB_ID

public static final String TAG_BIGQUERY_JOB_ID

See Also:

• Constant Field Values

TAG_BIGQUERY_JOB_STATUS

public static final String TAG_BIGQUERY_JOB_STATUS

See Also:

• Constant Field Values

TAG_BIGQUERY_JOB_STATS

public static final String TAG_BIGQUERY_JOB_STATS

See Also:

• Constant Field Values

TAG_BIGQUERY_STREAM_STATS

public static final String TAG_BIGQUERY_STREAM_STATS

See Also:

• Constant Field Values

TAG_CLICKHOUSE_QUERY_ID

public static final String TAG_CLICKHOUSE_QUERY_ID

See Also:

• Constant Field Values

TAG_CLICKHOUSE_STATS

public static final String TAG_CLICKHOUSE_STATS

See Also:

• Constant Field Values

TAG_SNOWFLAKE_QUERY_ID

public static final String TAG_SNOWFLAKE_QUERY_ID

See Also:

• Constant Field Values

TAG_SNOWFLAKE_RESULTSET_COUNT

public static final String TAG_SNOWFLAKE_RESULTSET_COUNT

See Also:

• Constant Field Values

TAG_SNOWFLAKE_RESULTSET_STATS

public static final String TAG_SNOWFLAKE_RESULTSET_STATS

See Also:

• Constant Field Values

TYPE_LIST

public static final String TYPE_LIST

Query types corresponding to the tag Observability.QUERY_TYPE_ATTRIBUTE for database queries.

See Also:

• Constant Field Values

TYPE_DISTINCT

public static final String TYPE_DISTINCT

See Also:

• Constant Field Values

TYPE_GET_BY_KEY

public static final String TYPE_GET_BY_KEY

See Also:

• Constant Field Values

TYPE_AGGREGATE

public static final String TYPE_AGGREGATE

See Also:

• Constant Field Values

TYPE_MULTI_STEP_AGGREGATE

public static final String TYPE_MULTI_STEP_AGGREGATE

See Also:

• Constant Field Values

Method Details

propagateTraceInTags

public static Map<String,String> propagateTraceInTags(Map<String,String> queryTags)

Propagates trace tags in query tags if it exists.

buildSpanNotStarted

public static io.opentelemetry.api.trace.SpanBuilder buildSpanNotStarted(@Nullable
 io.opentelemetry.api.trace.Span parentSpan,
 String name)

Creates a new span without starting it.

Parameters:

parentSpan - the parent span

name - the span name

buildSpanNotStarted

public static io.opentelemetry.api.trace.SpanBuilder buildSpanNotStarted(String name)

Creates a new span without starting it.

Parameters:

name - the span name

buildSpanNotStarted

public static io.opentelemetry.api.trace.SpanBuilder buildSpanNotStarted(@Nullable
 io.opentelemetry.api.trace.Span parentSpan,
 String name,
 Map<String,String> tags)

Creates a new span without starting it.

Parameters:

parentSpan - the parent span

name - the span name

tags - tags that will be added to the newly created span

tagCurrentSpan

public static void tagCurrentSpan(String key,
 Supplier<String> valueSupplier)

Tags current span if there is one.

tagCurrentSpan

public static void tagCurrentSpan(Supplier<Map<String,String>> tagSupplier)

Tags current span if there is one.

supplyInSpan

public static <T> T supplyInSpan(io.opentelemetry.api.trace.SpanBuilder span,
 Supplier<T> supplier)

Supplies the value in a span.

runInSpan

public static void runInSpan(io.opentelemetry.api.trace.SpanBuilder span,
 Runnable runnable)

Runs in a span.

sendQueryMetrics

public static void sendQueryMetrics(long startTime,
 boolean success,
 String subtype,
 String tableName)

Sends query metrics.

Parameters:

startTime - the start time in nanoseconds

success - the success flag

subtype - the subtype of the query

tableName - the table name

createDatabaseEpochWithObservability

public static IEpoch createDatabaseEpochWithObservability(IEpochCreator epochCreator,
 String branchName,
 boolean isShadow,
 DatabaseId databaseId)

Creates a database epoch and updates the associated sum metric.