Class Instrumentation.ClosableTelemetryScope

java.lang.Object

com.google.adk.telemetry.Instrumentation.ClosableTelemetryScope

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

Instrumentation.AgentInvocation, Instrumentation.ToolExecution

Enclosing class:

Instrumentation

public abstract static class Instrumentation.ClosableTelemetryScope
extends Object
implements AutoCloseable

Base class for AutoCloseable telemetry tracking scopes.

Field Summary

Fields

Modifier and Type	Field	Description
protected @Nullable Throwable	caughtError
protected final AtomicBoolean	closed
protected final io.opentelemetry.context.Scope	scope
protected final io.opentelemetry.api.trace.Span	span
protected final long	startTimeNanos
protected final Instrumentation.TelemetryContext	telemetryContext

Method Summary

Modifier and Type	Method	Description
protected void	beforeSpanEnd()	Hook for subclasses to run code before span ends.
final void	close()
Instrumentation.TelemetryContext	context()
protected abstract void	handleMetricsError(RuntimeException e)	Hook for subclasses to handle metrics recording errors.
protected abstract void	recordMetrics(Duration elapsed, @Nullable Throwable error)	Hook for subclasses to record metrics.
void	setError(Throwable caughtError)

Methods inherited from class Object

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

Field Details

startTimeNanos

protected final long startTimeNanos

span

protected final io.opentelemetry.api.trace.Span span

scope

protected final io.opentelemetry.context.Scope scope

telemetryContext

protected final Instrumentation.TelemetryContext telemetryContext

caughtError

protected @Nullable Throwable caughtError

closed

protected final AtomicBoolean closed

Method Details

context

public Instrumentation.TelemetryContext context()

setError

public void setError(Throwable caughtError)

close

public final void close()

Specified by:

close in interface AutoCloseable

beforeSpanEnd

protected void beforeSpanEnd()

Hook for subclasses to run code before span ends.

recordMetrics

protected abstract void recordMetrics(Duration elapsed,
 @Nullable Throwable error)

Hook for subclasses to record metrics.

handleMetricsError

protected abstract void handleMetricsError(RuntimeException e)

Hook for subclasses to handle metrics recording errors.