Add Browser UserAction Event #1941
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| # Use this changelog template to create an entry for release notes. | ||
| # | ||
| # If your change doesn't affect end users you should instead start | ||
| # your pull request title with [chore] or use the "Skip Changelog" label. | ||
|
|
||
| # One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' | ||
| change_type: new_component | ||
|
|
||
| # The name of the area of concern in the attributes-registry, (e.g. http, cloud, db) | ||
| component: browser | ||
|
|
||
| # A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). | ||
| note: Add `browser.user_action` event. | ||
|
|
||
| # Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. | ||
| # The values here must be integers. | ||
| issues: [1941] | ||
|
|
||
| # (Optional) One or more lines of additional information to render under the primary note. | ||
| # These lines will be padded with 2 spaces and then inserted directly into the document. | ||
| # Use pipe (|) for multiline entries. | ||
| subtext: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -52,3 +52,95 @@ groups: | |
| brief: A unique ID representing this particular metric instance. | ||
| requirement_level: required | ||
| examples: ["v3-1677874579383-6381583661209"] | ||
| - id: event.browser.user_action | ||
|
There was a problem hiding this comment. Would like to see the id/name be related to the group they come from with the list defined at: https://www.w3schools.com/jsref/obj_events.asp that way we can have a more tailored body/attributes. |
||
| stability: development | ||
| type: event | ||
| name: browser.user_action | ||
breedx-splk marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| brief: > | ||
| This event describes actions performed by the user such as click, scroll, zoom, resize, etc. | ||
| body: | ||
trask marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| id: browser.user_action | ||
| requirement_level: required | ||
| stability: development | ||
| type: map | ||
| fields: | ||
| - id: tag_name | ||
| type: string | ||
| stability: development | ||
| brief: Target element tag name and it is obtained via `event.target.tagName`. | ||
| requirement_level: recommended | ||
| examples: ["BUTTON"] | ||
|
Comment on lines
+67
to
+72
There was a problem hiding this comment. Feel that this should be an attribute |
||
| - id: xpath | ||
trask marked this conversation as resolved.
Show resolved
Hide resolved
trask marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| type: string | ||
| stability: development | ||
| brief: > | ||
| Target element xpath by using [XPathExpression](https://developer.mozilla.org/en-US/docs/Web/API/XPathExpression). | ||
| see [xpath](https://www.w3.org/TR/xpath/). | ||
| requirement_level: recommended | ||
| examples: ["//*[@id='testBtn']"] | ||
| - id: type | ||
| type: enum | ||
Karlie-777 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| members: | ||
| - id: click.left | ||
| value: "click.left" | ||
| stability: development | ||
| brief: An element is left clicked by a user. | ||
| - id: click.right | ||
| value: "click.right" | ||
| stability: development | ||
| brief: An element is right clicked by a user. | ||
| - id: click.middle | ||
| value: "click.middle" | ||
| stability: development | ||
| brief: An element is middle clicked by a user. | ||
| - id: scroll | ||
| value: "scroll" | ||
| stability: development | ||
| brief: An element is scrolled by a user. | ||
| - id: zoom | ||
| value: "zoom" | ||
| stability: development | ||
| brief: An element is zoomed by a user. | ||
| - id: resize | ||
| value: "resize" | ||
| stability: development | ||
| brief: An element is resized by a user. | ||
| - id: keyboard.enter | ||
| value: "keyboard.enter" | ||
| stability: development | ||
| brief: An element is entered via keyboard by a user. | ||
|
There was a problem hiding this comment. This description is not clear to me. is that similar to If so I wonder why we want to differentiate between these two keys. |
||
| - id: keyboard.space | ||
| value: "keyboard.space" | ||
| stability: development | ||
| brief: A space is entered via keyboard by a user. | ||
| - id: other | ||
|
There was a problem hiding this comment. another interesting event IMHO is input |
||
| value: "other" | ||
| stability: development | ||
| brief: User actions that are not listed above. | ||
| stability: development | ||
| brief: > | ||
| Type of interaction. | ||
| See enum [here](https://github.com/microsoft/ApplicationInsights-JS/blob/main/extensions/applicationinsights-clickanalytics-js/src/Enums.ts) for potential values we could add support for. | ||
| requirement_level: required | ||
| examples: ["click.right"] | ||
|
Comment on lines
+81
to
+125
There was a problem hiding this comment. Feel that these should be attributes. |
||
| - id: page.x | ||
| type: int | ||
| stability: development | ||
| brief: Click x(horizontal) coordinates(in pixels) relative to the entire document. | ||
| requirement_level: recommended | ||
| examples: | ||
| - 10 | ||
| - id: page.y | ||
| type: int | ||
| stability: development | ||
| brief: Click y(vertical) coordinates(in pixels) relative to the entire document. | ||
| requirement_level: recommended | ||
| examples: | ||
| - 10 | ||
|
Comment on lines
+126
to
+139
There was a problem hiding this comment. Could we use the There was a problem hiding this comment. #1941 (comment) and #2070 should already cover the app click events |
||
| - id: tags | ||
| type: string[] | ||
| stability: development | ||
| brief: Grab data from data-otel-* attributes in tree. | ||
| requirement_level: recommended | ||
| examples: | ||
| - ["id", "name"] | ||
|
Comment on lines
+140
to
+146
There was a problem hiding this comment. Attributes should be set as attributes on the event and don't think that these need to be defined here. |
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.