Gondwana.Diagnostics.TelemetrySource Class Reference

Bounded extension source. Define measurements once, capture a generation before work, then record it. More...

Inheritance diagram for Gondwana.Diagnostics.TelemetrySource:

Public Member Functions
bool	Define (string name, TelemetryAvailability availability=TelemetryAvailability.NotYetSampled, TelemetryMetricKind kind=TelemetryMetricKind.Sample)
	Defines a measurement before use. Include units and scope in its name.
long	BeginSample ()
	Captures an epoch before measured work; zero means disabled.
void	Record (long generation, string metric, double value)
	Records a finite observation without retaining raw samples.
void	Dispose ()
	Permanently retires the source; late observations are ignored.

Properties
long	Id [get]
	Session-local identity, unchanged by collector reset or temporary context loss.
string	Name [get]
	Source label.
string	Backend [get]
	Backend label.

Detailed Description

Bounded extension source. Define measurements once, capture a generation before work, then record it.

Definition at line 302 of file RuntimeProfiler.cs.

Member Function Documentation

BeginSample()

long Gondwana.Diagnostics.TelemetrySource.BeginSample

(

)

Captures an epoch before measured work; zero means disabled.

Returns

A token to pass to Record; reset, stop, and source retirement invalidate old tokens.

Define()

bool Gondwana.Diagnostics.TelemetrySource.Define	(	string	name,
		TelemetryAvailability	availability = TelemetryAvailability.NotYetSampled,
		TelemetryMetricKind	kind = TelemetryMetricKind.Sample )

Defines a measurement before use. Include units and scope in its name.

Parameters

name	Bounded unique metric name, such as update.cpu.ms.
availability	Unsupported, NotApplicable, or NotYetSampled; Available is normalized to NotYetSampled.
kind	Interpretation of observations across windows.

Returns

False if the source is retired or configured detail capacity is exhausted.

Dispose()

void Gondwana.Diagnostics.TelemetrySource.Dispose

(

)

Permanently retires the source; late observations are ignored.

Record()

void Gondwana.Diagnostics.TelemetrySource.Record	(	long	generation,
		string	metric,
		double	value )

Records a finite observation without retaining raw samples.

Parameters

generation	Token captured before the measured operation.
metric	Previously defined measurement name.
value	Value in the metric's declared units.

Property Documentation

Backend

string Gondwana.Diagnostics.TelemetrySource.Backend

get

Backend label.

Definition at line 319 of file RuntimeProfiler.cs.

Id

long Gondwana.Diagnostics.TelemetrySource.Id

get

Session-local identity, unchanged by collector reset or temporary context loss.

Definition at line 315 of file RuntimeProfiler.cs.

Name

string Gondwana.Diagnostics.TelemetrySource.Name

get

Source label.

Definition at line 317 of file RuntimeProfiler.cs.