ITelemetryContext Interface

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

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/runtime-definitions/legacy.

For more information about our API support guarantees, see here.

Signature

export interface ITelemetryContext

Method	Alerts	Return Type	Description
set(prefix, property, value)	`Alpha`	void	Sets value for telemetry data being tracked.
setMultiple(prefix, property, values)	`Alpha`	void	Sets multiple values for telemetry data being tracked.

Sets value for telemetry data being tracked.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/runtime-definitions/alpha.

For more information about our API support guarantees, see here.

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

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

Sets multiple values for telemetry data being tracked.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/runtime-definitions/alpha.

For more information about our API support guarantees, see here.

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

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.