Skip to content

Commit c63b371

Browse files
doc: Update description on module load/open (#994)
## Problem ## Solution <!--- REMINDER: - Read CONTRIBUTING.md first. - Add test coverage for your changes. - Link to related issues/commits. - Testing: how did you test your changes? - Screenshots if applicable --> ## License By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license. Signed-off-by: nkomonen-amazon <[email protected]>
1 parent da08d3c commit c63b371

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

telemetry/definitions/commonDefinitions.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7136,7 +7136,7 @@
71367136
},
71377137
{
71387138
"name": "toolkit_didLoadModule",
7139-
"description": "The module has loaded, i.e it has rendered/resolved/finished. Use this after `toolkit_willOpenModule` to indicate success.",
7139+
"description": "The module has loaded, i.e it has rendered/resolved/finished. You can use this metric by itself, OR after `toolkit_willOpenModule` + `traceId` to close the loop on an asynchronous operation.",
71407140
"metadata": [
71417141
{
71427142
"type": "attempts",
@@ -7338,7 +7338,7 @@
73387338
},
73397339
{
73407340
"name": "toolkit_willOpenModule",
7341-
"description": "The opening of a module **started**. This does not imply it successfully finished, use `toolkit_didLoadModule` for that. The open/load separation exists because it may be difficult to capture then entire process in a single metric. A 'module' is a general term that represents things like: a view, feature, resource, ... ",
7341+
"description": "Indicates a module opening attempt began, not its successful completion. For load confirmation, use `toolkit_didLoadModule` with matching `traceId`. This separation handles asynchronous processes that can't be captured in a single metric. 'Module' refers to components like views, features, resources, etc.",
73427342
"metadata": [
73437343
{
73447344
"type": "module",

0 commit comments

Comments
 (0)