Help us shape the future of Go! Take the 2026 Go Developer Survey

telemetry

package
v1.37.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 20, 2026 License: MIT Imports: 11 Imported by: 0

Documentation

Overview

Package telemetry declares the classification metadata for attributes emitted by first-party azd extensions and verifies, at test time, that every attribute an extension reports is declared here.

Extensions record usage by constructing a telemetry payload — a foundry telemetry Event or an azdext ReportUsageRequest — with an inline Attributes map. scanExtensionTelemetry parses extension source with go/parser (it never executes extension code), finds those payload literals, and collects their attribute keys; validateExtensionTelemetryUsages then checks each key against the declarations in this file.

Index

Constants

This section is empty.

Variables

View Source
var (
	// DemoMode records the fixed mode used by the demo extension telemetry example.
	DemoMode = fields.AttributeKey{
		Key:            attribute.Key("ext.demo.mode"),
		Classification: fields.SystemMetadata,
		Purpose:        fields.FeatureInsight,
		Endpoint:       "N/A",
	}

	// DemoOutcome records the fixed outcome used by the demo extension telemetry example.
	DemoOutcome = fields.AttributeKey{
		Key:            attribute.Key("ext.demo.outcome"),
		Classification: fields.SystemMetadata,
		Purpose:        fields.FeatureInsight,
		Endpoint:       "N/A",
	}

	// AgentKind records the bounded agent kind resolved by azure.ai.agents.
	AgentKind = fields.AttributeKey{
		Key:            attribute.Key("ext.agent.kind"),
		Classification: fields.SystemMetadata,
		Purpose:        fields.FeatureInsight,
		Endpoint:       "N/A",
	}

	// AgentHarness records the bounded agent harness classification resolved by azure.ai.agents.
	AgentHarness = fields.AttributeKey{
		Key:            attribute.Key("ext.agent.harness"),
		Classification: fields.SystemMetadata,
		Purpose:        fields.FeatureInsight,
		Endpoint:       "N/A",
	}

	// AgentOperation records the fixed extension command path associated with an agent context.
	AgentOperation = fields.AttributeKey{
		Key:            attribute.Key("ext.agent.operation"),
		Classification: fields.SystemMetadata,
		Purpose:        fields.FeatureInsight,
		Endpoint:       "N/A",
	}

	// AgentInvokeProtocol records the selected remote hosted-agent invocation protocol.
	AgentInvokeProtocol = fields.AttributeKey{
		Key:            attribute.Key("ext.agent.invoke.protocol"),
		Classification: fields.SystemMetadata,
		Purpose:        fields.FeatureInsight,
		Endpoint:       "N/A",
	}

	// AgentInvokeLongRunning records whether the remote invoke requested background execution.
	AgentInvokeLongRunning = fields.AttributeKey{
		Key:            attribute.Key("ext.agent.invoke.long_running"),
		Classification: fields.SystemMetadata,
		Purpose:        fields.FeatureInsight,
		Endpoint:       "N/A",
	}

	// AgentInvokeNoWait records whether the remote invoke returns after receiving its ID.
	AgentInvokeNoWait = fields.AttributeKey{
		Key:            attribute.Key("ext.agent.invoke.no_wait"),
		Classification: fields.SystemMetadata,
		Purpose:        fields.FeatureInsight,
		Endpoint:       "N/A",
	}

	// AgentContainerMode records the effective hosted-agent container or code mode.
	AgentContainerMode = fields.AttributeKey{
		Key:            attribute.Key("ext.agent.container.mode"),
		Classification: fields.SystemMetadata,
		Purpose:        fields.FeatureInsight,
		Endpoint:       "N/A",
	}

	// LocalClientRoute records the bounded local-client route selected by azure.ai.agents.
	LocalClientRoute = fields.AttributeKey{
		Key:            attribute.Key("ext.route"),
		Classification: fields.SystemMetadata,
		Purpose:        fields.FeatureInsight,
		Endpoint:       "N/A",
	}

	// InspectorFunnelStage records the bounded Agent Inspector funnel stage.
	InspectorFunnelStage = fields.AttributeKey{
		Key:            attribute.Key("ext.stage"),
		Classification: fields.SystemMetadata,
		Purpose:        fields.FeatureInsight,
		Endpoint:       "N/A",
	}

	// InspectorFunnelOutcome records the bounded Agent Inspector funnel outcome.
	InspectorFunnelOutcome = fields.AttributeKey{
		Key:            attribute.Key("ext.outcome"),
		Classification: fields.SystemMetadata,
		Purpose:        fields.FeatureInsight,
		Endpoint:       "N/A",
	}

	// DatasetOperation records the bounded publish operation reported by azure.ai.dataset.
	DatasetOperation = fields.AttributeKey{
		Key:            attribute.Key("ext.operation"),
		Classification: fields.SystemMetadata,
		Purpose:        fields.FeatureInsight,
		Endpoint:       "N/A",
	}

	// EvaluationsInitSource records the bounded init source reported by azure.ai.evaluations.
	EvaluationsInitSource = fields.AttributeKey{
		Key:            attribute.Key("ext.source"),
		Classification: fields.SystemMetadata,
		Purpose:        fields.FeatureInsight,
		Endpoint:       "N/A",
	}
)

Functions

This section is empty.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL