Microsoft/bcquality
1
0
Fork 0
mirror of https://github.com/microsoft/BCQuality.git synced 2026-10-05 06:36:55 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
bcquality/microsoft/knowledge/telemetry/feature-usage-only-after-success.md
Jesper Schulz-Wedde 2b5550c346
Some checks failed
Validate knowledge index / validate-index (push) Has been cancelled
Details
Validate AL review fixtures / validate-review-fixtures (push) Has been cancelled
Details
Validate frontmatter and structure / validate (push) Has been cancelled
Details
Improve partner onboarding and documentation navigation (#174) 
Lead with a complete plugin quick start and add task-oriented usage, troubleshooting, customization, and contribution guides. Preserve the broader plugin framing, correct conflicting contract guidance, support Agents folder reviews, and align repository validation. Convert existing sample references to clickable links without changing knowledge rules.

Co-authored-by: Jesper Schulz-Wedde <jesper.schulzwedde@microsoft.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
2026-09-09 17:31:03 +02:00

1.4 KiB
Raw 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.