Microsoft/bcquality
1
0
Fork 0
mirror of https://github.com/microsoft/BCQuality.git synced 2026-08-06 09:26:52 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
bcquality/microsoft/knowledge/telemetry/feature-usage-only-after-success.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.3 KiB
Raw Permalink Blame History

bc-version domain keywords technologies countries application-area
18..
telemetry
featuretelemetry
logusage
logerror
success
tryfunction
feature-usage
al
w1
all

Call FeatureTelemetry.LogUsage only after successful use

Description

FeatureTelemetry.LogUsage means that a user successfully used the feature. An attempt belongs in the uptake funnel, while a failed operation belongs in LogError. Logging usage before checking the result inflates adoption metrics with failed attempts and makes usage telemetry disagree with the actual business outcome.

Best Practice

Call LogUsage only after the operation has completed successfully. On a failure path, call LogError with the captured error text and call stack when the failure must be emitted explicitly. Use a past-tense event name for usage and a present-tense scenario name for errors.

See sample: feature-usage-only-after-success.good.al.

Anti Pattern

Calling LogUsage before a Boolean result, TryFunction, Codeunit.Run, or HTTP status has been checked, or calling it in both success and failure branches. Do not flag an attempt recorded with LogUptake(...Used); unlike LogUsage, that state intentionally records an attempt.

See sample: feature-usage-only-after-success.bad.al.