docs: Add docs for Time to Interactive #471
Conversation
docs/configuration.md
Outdated
| #### What is Time to interactive (TTI)? | ||
|
|
||
| Time to interactive (TTI) is a measure of how long a page takes till it is interactive. AWS RUM Web Client provides a plugin you can use to record this measurement. |
There was a problem hiding this comment.
| Time to interactive (TTI) is a measure of how long a page takes till it is interactive. AWS RUM Web Client provides a plugin you can use to record this measurement. | |
| Time to interactive (TTI) is a measure of how long a page takes until it is interactive. AWS RUM Web Client provides a plugin you can use to record this measurement. |
docs/configuration.md
Outdated
| The web client TTI plugin implements the [*Boomerang TTI algorithm*](https://akamai.github.io/boomerang/oss/BOOMR.plugins.Continuity.html#toc11__anchor), with some modifications. | ||
|
|
||
| _Steps to TTI calculation:_ |
There was a problem hiding this comment.
| _Steps to TTI calculation:_ | |
| _Steps to calculate TTI:_ |
docs/configuration.md
Outdated
| 3) TTI is recorded as visually ready timestamp + time from visually ready to the start of the quiet window. | ||
|
|
||
| Note: TTI can be measured using the plugin only when running in a browser that supports [*Long Tasks*](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceLongTaskTiming). |
There was a problem hiding this comment.
suggestion: move browser support to its own section
| eventPluginsToLoad: [new TTIPlugin(true)], | ||
| ``` | ||
| Note: You must enable enable custom events to ingest TTI events in your application monitor settings. See |
There was a problem hiding this comment.
Question: Why are custom events required? My understanding was that TTI is not a custom event.
Recording TTI events may incur Cloudwatch RUM extra charges.
Could you explain what might cause extra charges? e.g. Recording TTI events will incur the cost of roughly one RUM (or custom?) event per user session
docs/configuration.md
Outdated
| #### How is TTI measured by the AWS RUM web client? | ||
|
|
||
| The web client TTI plugin implements the [*Boomerang TTI algorithm*](https://akamai.github.io/boomerang/oss/BOOMR.plugins.Continuity.html#toc11__anchor), with some modifications. |
There was a problem hiding this comment.
with some modifications
suggestion: explicitly state that we have omitted page busy metrics from the boomerang algorithm for performance concerns
|
Suggestion: CDN example? |
| ``` | ||
|
|
||
| ## Time to Interactive (TTI) |
There was a problem hiding this comment.
suggestion: Mention TTI in eventPluginsToLoad, otherwise this section is dangling, while every other section is referenced from the Configuration Options section. For example:
- The set of custom plugins to load. See [usage examples](examples.md#record-custom-events-using-a-plugin).
+ The set of custom plugins to load, including [time to interactive (TTI)](examples.md#record-time-to-interactive). See [usage examples](examples.md#record-custom-events-using-a-plugin).|
|
||
| ## Time to Interactive (TTI) | ||
|
|
There was a problem hiding this comment.
issue: This section isn't structurally consistent with the other sections. Specifically, sections in this doc follow the following format:
- (Optional) A short description of the configuration option, or plugin.
- A table which lists configuration options.
- A usage example.
| Time to interactive (TTI) is a measure of how long a page takes until it is interactive. AWS RUM Web Client provides a plugin you can use to record this measurement. | ||
|
|
||
| #### How is TTI measured by the AWS RUM web client? |
There was a problem hiding this comment.
suggestion: Omit this section's information. Because this file focuses on documenting how to configure the web client, if we want to document how TTI is defined, I think we should do it elsewhere.
|
i am getting plugin type error when i am trying to upgrade the version |
Will follow up in the Github issue you created |
This change adds docs on Time to interactive (TTI).
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.