API reference
API reference
Select your platform
No SDKs available
No versions available

TelemetryChannel Class

The telemetry channel represents a target for telemetry. The default implementation sends live telemetry to Meta.

Overview

Properties

static long

Object Data

int
StartEvent
( TelemetryEventId eventId )
Logs an event as started.
void
LogInstantEvent
( TelemetryEventId eventId,
Dictionary< AnnotationKey, string > annotations )
Logs an instantaneous event that happens at one point in time (as opposed to one with a start and end).
void
AnnotateEvent
( int instanceKey,
AnnotationKey key,
string value )
Annotates an event that has started but did not end yet.
void
EndEvent
( int instanceKey,
ResultType result )
Logs an event as ended.

Public Member Functions

Details

Properties

long Meta.Voice.TelemetryUtilities.Telemetry.TelemetryChannel.ElapsedMilliseconds
No description available.

Object Data

virtual int Meta.Voice.TelemetryUtilities.Telemetry.TelemetryChannel.StartEvent
( TelemetryEventId eventId )
Logs an event as started.
Parameters
eventId
The ID of the event that just started.
Returns
Instance key identifying this specific occurrence of the event.
virtual void Meta.Voice.TelemetryUtilities.Telemetry.TelemetryChannel.LogInstantEvent
( TelemetryEventId eventId,
Dictionary< AnnotationKey, string > annotations )
Logs an instantaneous event that happens at one point in time (as opposed to one with a start and end).
Parameters
eventId
The ID of the event.
annotations
Optional annotations to add to the event.
Returns
Instance key identifying this specific occurrence of the event.
virtual void Meta.Voice.TelemetryUtilities.Telemetry.TelemetryChannel.AnnotateEvent
( int instanceKey,
AnnotationKey key,
string value )
Annotates an event that has started but did not end yet.
Parameters
eventId
The ID of the event. Should already have started but not ended already.
instanceKey
The instance key of the event. Must match the one used starting the event.
key
The annotation key.
value
The annotation value.
virtual void Meta.Voice.TelemetryUtilities.Telemetry.TelemetryChannel.EndEvent
( int instanceKey,
ResultType result )
Logs an event as ended.
Parameters
eventId
The ID of the event. Should already have started but not ended already.
instanceKey
The instance key of the event. Must match the one used starting the event.
result
The result of the event.
Returns
Instance key.

Member Functions

void Meta.Voice.TelemetryUtilities.Telemetry.TelemetryChannel.ShutdownTelemetry ( )
No description available.
Did you find this page helpful?
Thumbs up icon
Thumbs down icon