Google.Cloud.Diagnostics.Common - Interface IManagedTracer (5.1.0)

Version latest

• 5.2.0 (latest)
• 5.1.0
• 5.0.0
• 4.4.0
• 4.3.1

public interface IManagedTracer

Reference documentation and code samples for the Google.Cloud.Diagnostics.Common interface IManagedTracer.

Manages creating spans for a trace as well as adding meta data to them.

Namespace

GoogleCloudGoogle.Cloud.DiagnosticsCommon

Assembly

Google.Cloud.Diagnostics.Common.dll

Methods

AnnotateSpan(Dictionary<string, string>)

void AnnotateSpan(Dictionary<string, string> labels)

Annotates the current span with the given labels.

Parameter
Name	Description
labels	Dictionarystringstring

GetCurrentSpanId()

ulong? GetCurrentSpanId()

Gets the current span id or null if none exists.

Returns
Type	Description
ulong

GetCurrentTraceId()

string GetCurrentTraceId()

Gets the current trace id or null if none exists.

Returns
Type	Description
string

RunInSpan(Action, string, StartSpanOptions)

void RunInSpan(Action action, string name, StartSpanOptions options = null)

Runs the function in a span and will add a stacktrace from a thrown exception (the exception will be re-thrown) to the span.

Parameters
Name	Description
action	Action The action to run in a span.
name	string The name of the span. Must not be null.
options	StartSpanOptions The span options to override default values.

RunInSpan<T>(Func<T>, string, StartSpanOptions)

T RunInSpan<T>(Func<T> func, string name, StartSpanOptions options = null)

Runs the function in a span and will add a stacktrace from a thrown exception (the exception will be re-thrown) to the span.

Parameters
Name	Description
func	Func The function to run in a span.
name	string The name of the span. Must not be null.
options	StartSpanOptions The span options to override default values.

Returns
Type	Description
T	The result from the call to func

Type Parameter
Name	Description
T

RunInSpanAsync<T>(Func<Task<T>>, string, StartSpanOptions)

Task<T> RunInSpanAsync<T>(Func<Task<T>> func, string name, StartSpanOptions options = null)

Runs the function asynchronously in a span and will add a stacktrace from a thrown exception (the exception will be re-thrown) to the span.

Parameters
Name	Description
func	FuncTask The function to run in a span.
name	string The name of the span. Must not be null.
options	StartSpanOptions The span options to override default values.

Returns
Type	Description
Task	The result from the call to func

Type Parameter
Name	Description
T

SetStackTrace(StackTrace)

void SetStackTrace(StackTrace stackTrace)

Adds the given StackTrace to the current span.

Parameter
Name	Description
stackTrace	StackTrace

StartSpan(string, StartSpanOptions)

ISpan StartSpan(string name, StartSpanOptions options = null)

Starts a new span using the most recent (if any) unfinished span as the parent.

Parameters
Name	Description
name	string The name of the span. Must not be null.
options	StartSpanOptions The span options to override default values.

Returns
Type	Description
ISpan	An ISpan that will end the current span when disposed.