Microsoft/bcquality
1
0
Fork 0
mirror of https://github.com/microsoft/BCQuality.git synced 2026-08-06 17:36:53 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
bcquality/microsoft/knowledge/telemetry/choose-telemetry-scope-by-audience.md
Jesper Schulz-Wedde e81632b4be Complete AL review knowledge readiness 
Fill telemetry and Query coverage, strengthen thin review domains, correct audited content defects, and add deterministic cheap-model evaluation and reference-integrity safeguards.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 9825b012-e653-496a-9310-c1f4b6f8ac27
2026-07-15 07:19:15 +02:00

1.6 KiB
Raw Blame History

bc-version domain keywords technologies countries application-area
17..
telemetry
telemetryscope
extensionpublisher
all
audience
logmessage
application-insights
al
w1
all

Choose TelemetryScope by who must receive the signal

Description

TelemetryScope::ExtensionPublisher sends a custom trace only to the Application Insights resource configured by the extension publisher. TelemetryScope::All also sends it to the environment's telemetry, where the customer or partner operating the tenant can query it. The compiler accepts either value, so a plausible-looking scope can silently hide an actionable signal from tenant operators or expose publisher-only implementation noise to them.

Best Practice

Use ExtensionPublisher for internal diagnostics that only the app publisher can interpret, such as cache behavior or private algorithm state. Use All for signals the tenant operator can act on, such as an integration failure, quota warning, or setup problem. Decide the audience independently from DataClassification; privacy guidance still governs whether the payload may be emitted at all.

See sample: choose-telemetry-scope-by-audience.good.al.

Anti Pattern

Defaulting every call to All, including low-level implementation diagnostics, or defaulting every call to ExtensionPublisher and thereby hiding customer-actionable failures from environment telemetry. Review only when the message and surrounding branch make the intended audience clear; an ambiguous diagnostic is not enough to infer the wrong scope.

See sample: choose-telemetry-scope-by-audience.bad.al.