Class NoopRequestSpan

A NOOP implementation of IRequestSpan. Calling any method will do nothing as it's a NOOP, except for constructing child spans. Tracers may opt to return a NoopRequestSpan when disabled or when sampling excludes the span, but a tracer may still choose to create an active span for the child span of a NOOP span.

Inheritance

object

NoopRequestSpan

Implements

IRequestSpan

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Couchbase.Core.Diagnostics.Tracing

Assembly: Couchbase.NetClient.dll

Syntax

public sealed class NoopRequestSpan : IRequestSpan, IDisposable

Constructors

NoopRequestSpan()

Creates a new NoopRequestSpan.

Declaration

public NoopRequestSpan()

NoopRequestSpan(IRequestTracer?, IRequestSpan?)

Creates a new NoopRequestSpan.

Declaration

public NoopRequestSpan(IRequestTracer? tracer, IRequestSpan? parentSpan = null)

Parameters

Type	Name	Description
IRequestTracer	tracer	The IRequestTracer used constructing child spans.
IRequestSpan	parentSpan	The IRequestSpan which is the parent of this span, if any.

Fields

Instance

Declaration

public static readonly IRequestSpan Instance

Field Value

Type	Description
IRequestSpan

Properties

CanWrite

If true IRequestSpan attributes will be written for this tag. In cases such as the NoopRequestSpan it should be false as no attributes/tags are collected.

Declaration

public bool CanWrite { get; }

Property Value

Type	Description
bool

Duration

The duration of the span set after Dispose() or End() is called.

Declaration

public uint? Duration { get; }

Property Value

Type	Description
uint?

Id

The id, possibly from the underlying activity, of the span.

Declaration

public string? Id { get; }

Property Value

Type	Description
string

Parent

The optional parent span.

Declaration

public IRequestSpan? Parent { get; set; }

Property Value

Type	Description
IRequestSpan

Methods

AddEvent(string, DateTimeOffset?)

Sets an event on the span which translates to the corresponding implementation.

Declaration

public IRequestSpan AddEvent(string name, DateTimeOffset? timestamp = null)

Parameters

Type	Name	Description
string	name	The name of the event.
DateTimeOffset?	timestamp	The timestamp when it happened.

Returns

Type	Description
IRequestSpan

Remarks

Depending upon the implementation the event might be ignored (NOOP) for example.

ChildSpan(string)

Creates a child span from this span.

Declaration

public IRequestSpan ChildSpan(string name)

Parameters

Type	Name	Description
string	name	The name of the span.

Returns

Type	Description
IRequestSpan	A child span with references to the parent span.

Dispose()

Declaration

public void Dispose()

End()

Completes the span.

Declaration

public void End()

SetAttribute(string, bool)

Sets an attribute on the span which is translated to a corresponding implementation specific tag.

Declaration

public IRequestSpan SetAttribute(string key, bool value)

Parameters

Type	Name	Description
string	key	The key of attribute.
bool	value	The boolean value of the attribute.

Returns

Type	Description
IRequestSpan

Remarks

Depending upon the implementation the attribute might be ignored (NOOP) for example.

SetAttribute(string, string)

Sets an attribute on the span which is translated to a corresponding implementation specific tag.

Declaration

public IRequestSpan SetAttribute(string key, string value)

Parameters

Type	Name	Description
string	key	The key of attribute.
string	value	The string value of the attribute.

Returns

Type	Description
IRequestSpan

Remarks

Depending upon the implementation the attribute might be ignored (NOOP) for example.

SetAttribute(string, uint)

Sets an attribute on the span which is translated to a corresponding implementation specific tag.

Declaration

public IRequestSpan SetAttribute(string key, uint value)

Parameters

Type	Name	Description
string	key	The key of attribute.
uint	value	The uint value of the attribute.

Returns

Type	Description
IRequestSpan

Remarks

Depending upon the implementation the attribute might be ignored (NOOP) for example.

Implements

IRequestSpan

IDisposable

Extension Methods

RequestSpanExtensions.LogOrphaned(IRequestSpan)

RequestSpanExtensions.WithCommonTags(IRequestSpan)