Skip to content

fix telemetry resource field metadata #9693

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Marina He (hemarina) wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix telemetry resource field metadata #9693

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c07d843
fix telemetry resource field metadata
hemarina Aug 22, 2026
7db0fbb
clarify telemetry metadata review
hemarina Aug 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions .github/skills/azd-code-reviewer/reviewers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -310,3 +310,13 @@ Apply your domain expertise to identify:
Use the same findings format and severity levels as the fixed lenses.
If there are no {domain}-specific concerns, contribute no findings.
```

### Observability-specific checks

When applying the Observability Expert lens to telemetry field changes:

- Verify every new or modified exported, package-level `fields.AttributeKey` sets non-empty
`Classification` and `Purpose` metadata.
- Compare each runtime key string with existing `AttributeKey` declarations. A telemetry key must be
declared exactly once; reuse its canonical declaration instead of adding an alias or duplicate,
including when `fields.ErrorKey` later prefixes the emitted key with `error.`.
18 changes: 18 additions & 0 deletions cli/azd/cmd/telemetry_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,24 @@ func TestTelemetryEventConstants(t *testing.T) {
// rejected by TestNoRawTelemetryAttributes (below).
func TestTelemetryFieldConstants(t *testing.T) {
t.Parallel()
t.Run("ResourceFields", func(t *testing.T) {
t.Parallel()
tests := []struct {
key fields.AttributeKey
expectedName string
expectedPurpose fields.Purpose
}{
{fields.ServiceNameKey, "service.name", fields.PerformanceAndHealth},
{fields.ServiceVersionKey, "service.version", fields.FeatureInsight},
{fields.OSTypeKey, "os.type", fields.FeatureInsight},
}
for _, tt := range tests {
require.Equal(t, tt.expectedName, string(tt.key.Key))
require.Equal(t, fields.SystemMetadata, tt.key.Classification)
require.Equal(t, tt.expectedPurpose, tt.key.Purpose)
}
})

// Auth command telemetry fields
t.Run("AuthFields", func(t *testing.T) {
t.Parallel()
Expand Down
8 changes: 4 additions & 4 deletions cli/azd/internal/cmd/errors.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ func classifyResponseError(respErr *azcore.ResponseError) (string, []attribute.K
attrs = append(attrs,
fields.ServiceHost.String(hostName),
fields.ServiceMethod.String(respErr.RawResponse.Request.Method),
fields.ServiceName.String(serviceName),
fields.ServiceNameKey.String(serviceName),
)
}
}
Expand All @@ -203,7 +203,7 @@ func classifyResponseError(respErr *azcore.ResponseError) (string, []attribute.K
}

func classifyArmDeployError(armDeployErr *azapi.AzureDeploymentError) (string, []attribute.KeyValue) {
attrs := []attribute.KeyValue{fields.ServiceName.String("arm")}
attrs := []attribute.KeyValue{fields.ServiceNameKey.String("arm")}
codes := []*deploymentErrorCode{}
var collect func(details []*azapi.DeploymentErrorLine, frame int)
collect = func(details []*azapi.DeploymentErrorLine, frame int) {
Expand Down Expand Up @@ -247,7 +247,7 @@ func classifyExtServiceError(extServiceErr *azdext.ServiceError) (string, []attr
var hostDomain string
serviceName, hostDomain = mapService(extServiceErr.ServiceName)
attrs = append(attrs,
fields.ServiceName.String(serviceName),
fields.ServiceNameKey.String(serviceName),
fields.ServiceHost.String(hostDomain),
)
}
Expand Down Expand Up @@ -282,7 +282,7 @@ func classifyExtLocalError(extLocalErr *azdext.LocalError) (string, []attribute.
}

func authFailedTelemetryDetails(authFailedErr *auth.AuthFailedError) []attribute.KeyValue {
errDetails := []attribute.KeyValue{fields.ServiceName.String("aad")}
errDetails := []attribute.KeyValue{fields.ServiceNameKey.String("aad")}
if authFailedErr == nil || authFailedErr.Parsed == nil {
return errDetails
}
Expand Down
14 changes: 7 additions & 7 deletions cli/azd/internal/cmd/errors_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ func Test_MapError(t *testing.T) {
},
wantErrReason: "service.arm.deployment.failed",
wantErrDetails: []attribute.KeyValue{
fields.ErrorKey(fields.ServiceName.Key).String("arm"),
fields.ErrorKey(fields.ServiceNameKey.Key).String("arm"),
fields.ErrorKey(fields.ServiceErrorCode.Key).String(mustMarshalJson(
[]map[string]any{
{
Expand Down Expand Up @@ -145,7 +145,7 @@ func Test_MapError(t *testing.T) {
},
wantErrReason: "service.arm.validate.failed",
wantErrDetails: []attribute.KeyValue{
fields.ErrorKey(fields.ServiceName.Key).String("arm"),
fields.ErrorKey(fields.ServiceNameKey.Key).String("arm"),
fields.ErrorKey(fields.ServiceErrorCode.Key).String(mustMarshalJson(
[]map[string]any{
{
Expand Down Expand Up @@ -174,7 +174,7 @@ func Test_MapError(t *testing.T) {
},
wantErrReason: "service.arm.503",
wantErrDetails: []attribute.KeyValue{
fields.ErrorKey(fields.ServiceName.Key).String("arm"),
fields.ErrorKey(fields.ServiceNameKey.Key).String("arm"),
fields.ErrorKey(fields.ServiceHost.Key).String("management.azure.com"),
fields.ErrorKey(fields.ServiceMethod.Key).String("GET"),
fields.ErrorKey(fields.ServiceErrorCode.Key).String("ServiceUnavailable"),
Expand All @@ -196,7 +196,7 @@ func Test_MapError(t *testing.T) {
},
wantErrReason: "service.aad.failed",
wantErrDetails: []attribute.KeyValue{
fields.ErrorKey(fields.ServiceName.Key).String("aad"),
fields.ErrorKey(fields.ServiceNameKey.Key).String("aad"),
fields.ErrorKey(fields.ServiceErrorCode.Key).String("50076,50078,50079"),
fields.ErrorKey(fields.ServiceStatusCode.Key).String("invalid_grant"),
fields.ErrorKey(fields.ServiceCorrelationId.Key).String("12345"),
Expand Down Expand Up @@ -226,7 +226,7 @@ func Test_MapError(t *testing.T) {
wantErrReason: "error.suggestion",
wantErrDetails: []attribute.KeyValue{
fields.ErrType.String("service.aad.failed"),
fields.ErrorKey(fields.ServiceName.Key).String("aad"),
fields.ErrorKey(fields.ServiceNameKey.Key).String("aad"),
fields.ErrorKey(fields.ServiceErrorCode.Key).String("530084"),
fields.ErrorKey(fields.ServiceStatusCode.Key).String("invalid_grant"),
fields.ErrorKey(fields.ServiceCorrelationId.Key).String("blocked-token-protection"),
Expand All @@ -250,7 +250,7 @@ func Test_MapError(t *testing.T) {
},
wantErrReason: "ext.service.create_agent.ratelimitexceeded",
wantErrDetails: []attribute.KeyValue{
fields.ErrorKey(fields.ServiceName.Key).String("openai"),
fields.ErrorKey(fields.ServiceNameKey.Key).String("openai"),
fields.ErrorKey(fields.ServiceHost.Key).String("openai.azure.com"),
fields.ErrorKey(fields.ServiceStatusCode.Key).Int(429),
fields.ErrorKey(fields.ServiceErrorCode.Key).String("create_agent.RateLimitExceeded"),
Expand All @@ -276,7 +276,7 @@ func Test_MapError(t *testing.T) {
},
wantErrReason: "ext.service.ai.500",
wantErrDetails: []attribute.KeyValue{
fields.ErrorKey(fields.ServiceName.Key).String("ai"),
fields.ErrorKey(fields.ServiceNameKey.Key).String("ai"),
fields.ErrorKey(fields.ServiceHost.Key).String("services.ai.azure.com"),
fields.ErrorKey(fields.ServiceStatusCode.Key).Int(500),
},
Expand Down
21 changes: 10 additions & 11 deletions cli/azd/internal/tracing/fields/fields.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,19 +55,25 @@ func ExtensionUsageAttribute(key string) AttributeKey {

// Application-level fields. Guaranteed to be set and available for all events.
var (
// Application name. Value is always "azd".
// Service name. The application resource uses "azd"; MapError prefixes error details as error.service.name.
ServiceNameKey = AttributeKey{
Key: semconv.ServiceNameKey, // service.name
Key: semconv.ServiceNameKey, // service.name
Classification: SystemMetadata,
Purpose: PerformanceAndHealth,
}

// Application version.
ServiceVersionKey = AttributeKey{
Key: semconv.ServiceVersionKey, // service.version
Key: semconv.ServiceVersionKey, // service.version
Classification: SystemMetadata,
Purpose: FeatureInsight,
}

// The operating system type.
OSTypeKey = AttributeKey{
Key: semconv.OSTypeKey, // os.type
Key: semconv.OSTypeKey, // os.type
Classification: SystemMetadata,
Purpose: FeatureInsight,
}

// The operating system version.
Expand Down Expand Up @@ -939,13 +945,6 @@ var (
Purpose: PerformanceAndHealth,
}

// Name of the service.
ServiceName = AttributeKey{
Key: attribute.Key("service.name"),
Classification: SystemMetadata,
Purpose: PerformanceAndHealth,
}

// Status code of a response returned by the service.
// For HTTP, this corresponds to the HTTP status code.
ServiceStatusCode = AttributeKey{
Expand Down
6 changes: 3 additions & 3 deletions docs/specs/metrics-audit/telemetry-schema.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,9 @@ These are set once at process startup via `resource.New()` and attached to every

| Field | OTel Key | Classification | Purpose | Notes |
|-------|----------|----------------|---------|-------|
| Service name | `service.name` | — | — | Always `"azd"` |
| Service version | `service.version` | — | — | Build version string |
| OS type | `os.type` | — | — | e.g. `linux`, `windows`, `darwin` |
| Service name | `service.name` | SystemMetadata | PerformanceAndHealth | Always `"azd"` |
| Service version | `service.version` | SystemMetadata | FeatureInsight | Build version string |
| OS type | `os.type` | SystemMetadata | FeatureInsight | e.g. `linux`, `windows`, `darwin` |
| OS version | `os.version` | SystemMetadata | PerformanceAndHealth | Kernel / build version |
| Host architecture | `host.arch` | SystemMetadata | PerformanceAndHealth | e.g. `amd64`, `arm64` |
| Runtime version | `process.runtime.version` | SystemMetadata | PerformanceAndHealth | Go version |
Expand Down
Loading