Skip to content

Commit

Permalink
Address md lint issues
Browse files Browse the repository at this point in the history
  • Loading branch information
scheler committed Mar 30, 2023
1 parent 97c1b54 commit 5b435fb
Showing 1 changed file with 11 additions and 20 deletions.
31 changes: 11 additions & 20 deletions specification/logs/events/semantic_conventions/browser.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

**Status**: [Experimental](../../../document-status.md)


<details>
<summary>Table of Contents</summary>
<!-- Re-generate TOC with `markdown-toc --no-first-h1 -i` -->
Expand All @@ -24,10 +23,9 @@

</details>


This document describes the semantic conventions for browser events.

# Events
## Events

The events may be represented either as Span Events or Log Events.

Expand All @@ -39,7 +37,7 @@ All events have the following three high-level attributes. The event name is spe
| `event.name` | string | Described in each section below||Required|
| `event.data` | map | A map of key/value pairs, with the keys for each event described in following sections||Recommended|

## PageView
### PageView

**Event name**: `page_view`.

Expand All @@ -60,7 +58,6 @@ All events have the following three high-level attributes. The event name is spe
| `0` | physical_page |
| `1` | virtual_page |


<details>
<summary>Sample PageView Event</summary>

Expand Down Expand Up @@ -114,11 +111,11 @@ All events have the following three high-level attributes. The event name is spe
}
]
}

```

</details>

## PageLoad
### PageLoad

**Event name**:`page_load`.

Expand All @@ -129,7 +126,7 @@ All events have the following three high-level attributes. The event name is spe
**[1]:** Alias for [`http.url`](../../../trace/semantic_conventions/http.md)
**[2]:** The URL fragment may be included for virtual pages

## PageNavigationTiming
### PageNavigationTiming

**Event name**:`page_navigation_timing`

Expand All @@ -147,12 +144,10 @@ All events have the following three high-level attributes. The event name is spe
| firstPaint | long | || Recommended |
| firstContentfulPaint | long | || Recommended |


## ResourceTiming
### ResourceTiming

**Event name**:`resource_timing`


| Key | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
|fetchStart | long | || Recommended |
Expand All @@ -165,8 +160,7 @@ All events have the following three high-level attributes. The event name is spe
|responseStart | long | || Recommended |
|responseEnd | long | || Recommended |


## HTTP
### HTTP

**Event name**:`HTTP`

Expand Down Expand Up @@ -201,11 +195,10 @@ All events have the following three high-level attributes. The event name is spe
| `1` | xhr |
| `2` | send_beacon |

## HttpRequestTiming
### HttpRequestTiming

**Event name**:`http_request_timing`


| Key | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
| open | long | || Recommended |
Expand All @@ -220,8 +213,7 @@ All events have the following three high-level attributes. The event name is spe
| responseEnd | long | || Recommended |
| loaded | long | || Recommended |


## Exception
### Exception

**Event name**:`exception`

Expand All @@ -234,7 +226,7 @@ All events have the following three high-level attributes. The event name is spe
| `exception.stacktrace` | string | A stacktrace as a string in the natural representation for the language runtime. The representation is to be determined and documented by each language SIG. | `Exception in thread "main" java.lang.RuntimeException: Test exception\n at com.example.GenerateTrace.methodB(GenerateTrace.java:13)\n at com.example.GenerateTrace.methodA(GenerateTrace.java:9)\n at com.example.GenerateTrace.main(GenerateTrace.java:5)` | Recommended |
| `exception.type` | string | The type of the exception (its fully-qualified class name, if applicable). The dynamic type of the exception should be preferred over the static type in languages that support it. | `java.net.ConnectException`; `OSError` | Recommended |

## UserAction
### UserAction

**Event name**:`user_action`

Expand All @@ -252,11 +244,10 @@ All events have the following three high-level attributes. The event name is spe
|---|---|
| `click` | click |

## WebVital
### WebVital

**Event name**:`web_vital`


| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
| `name` | string | name of the web vital | `CLS` | Required |
Expand Down

0 comments on commit 5b435fb

Please sign in to comment.