ITelemetryContext Interface

Contains telemetry data relevant to summarization workflows. This object is expected to be modified directly by various summarize methods.

Signature

export interface ITelemetryContext

Methods

Method	Alerts	Return Type	Description
get(prefix, property)	`DEPRECATED`	TelemetryBaseEventPropertyType	Get the telemetry data being tracked
serialize()	`DEPRECATED`	string	Returns a serialized version of all the telemetry data. Should be used when logging in telemetry events.
set(prefix, property, value)		void	Sets value for telemetry data being tracked.
setMultiple(prefix, property, values)		void	Sets multiple values for telemetry data being tracked.

Method Details

get

Get the telemetry data being tracked

API This

This interface should only be used for instrumenting, not for attempting to read already-set telemetry data.

Signature

get(prefix: string, property: string): TelemetryBaseEventPropertyType;

Parameters

Parameter	Type	Description
prefix	string	unique prefix for this data (ex: "fluid:map:")
property	string	property name of the telemetry data being tracked (ex: "DirectoryCount")

Returns

undefined if item not found

Return type: TelemetryBaseEventPropertyType

serialize

Returns a serialized version of all the telemetry data. Should be used when logging in telemetry events.

API This

This interface should only be used for instrumenting. A concrete implementation will likely have a serialize function but this functionality should not be used by other code being given an ITelemetryContext.

Signature

serialize(): string;

Returns

Return type: string

set

Sets value for telemetry data being tracked.

Signature

set(prefix: string, property: string, value: TelemetryBaseEventPropertyType): void;

Parameters

Parameter	Type	Description
prefix	string	unique prefix to tag this data with (ex: "fluid:map:")
property	string	property name of the telemetry data being tracked (ex: "DirectoryCount")
value	TelemetryBaseEventPropertyType	value to attribute to this summary telemetry data

setMultiple

Sets multiple values for telemetry data being tracked.

Signature

setMultiple(prefix: string, property: string, values: Record<string, TelemetryBaseEventPropertyType>): void;

Parameters

Parameter	Type	Description
prefix	string	unique prefix to tag this data with (ex: "fluid:summarize:")
property	string	property name of the telemetry data being tracked (ex: "Options")
values	Record<string, TelemetryBaseEventPropertyType>	A set of values to attribute to this summary telemetry data.