Skip to content

Commit 06aaa4a

Browse files
thompson-tomothompson-tomo
committed
create an event registry #2382
Signed-off-by: James Thompson <[email protected]>
1 parent b32b0d9 commit 06aaa4a

File tree

14 files changed

+1046
-0
lines changed

14 files changed

+1046
-0
lines changed

‎docs/registry/events/README.md

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
<!--- Hugo front matter used to generate the website version of this page:
2+
linkTitle:Events
3+
--->
4+
5+
<!-- NOTE: THIS FILE IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
6+
<!-- see templates/registry/markdown/entity_readme.md.j2 -->
7+
8+
# Event registry
9+
10+
The event registry is the catalog of available Events.
11+
12+
> [!WARNING]
13+
>
14+
> The following registry overview is a work in progress.
15+
16+
Currently, the following namespaces exist:
17+
<table>
18+
<thead>
19+
<tr>
20+
<th>Namespace</th>
21+
<th>Event</th>
22+
<th>Stability</th>
23+
</tr>
24+
</thead>
25+
<tbody>
26+
<tr>
27+
<td>App</td><td></td><td></td>
28+
</tr><tr>
29+
<td></td>
30+
<td><a href="app.md#app-screen-click">app.screen.click</a></td>
31+
<td><img src="https://img.shields.io/badge/-development-blue" alt="Development"/></td>
32+
</tr><tr>
33+
<td></td>
34+
<td><a href="app.md#app-widget-click">app.widget.click</a></td>
35+
<td><img src="https://img.shields.io/badge/-development-blue" alt="Development"/></td>
36+
</tr><tr>
37+
<td>Az</td><td></td><td></td>
38+
</tr><tr>
39+
<td></td>
40+
<td><a href="az.md#az-resource-log">az.resource.log</a></td>
41+
<td><img src="https://img.shields.io/badge/-deprecated-red" alt="Deprecated"/></td>
42+
</tr><tr>
43+
<td>Azure</td><td></td><td></td>
44+
</tr><tr>
45+
<td></td>
46+
<td><a href="azure.md#azure-resource-log">azure.resource.log</a></td>
47+
<td><img src="https://img.shields.io/badge/-development-blue" alt="Development"/></td>
48+
</tr><tr>
49+
<td>Browser</td><td></td><td></td>
50+
</tr><tr>
51+
<td></td>
52+
<td><a href="browser.md#browser-web-vital">browser.web_vital</a></td>
53+
<td><img src="https://img.shields.io/badge/-development-blue" alt="Development"/></td>
54+
</tr><tr>
55+
<td>Device</td><td></td><td></td>
56+
</tr><tr>
57+
<td></td>
58+
<td><a href="device.md#device-app-lifecycle">device.app.lifecycle</a></td>
59+
<td><img src="https://img.shields.io/badge/-development-blue" alt="Development"/></td>
60+
</tr><tr>
61+
<td>Exception</td><td></td><td></td>
62+
</tr><tr>
63+
<td></td>
64+
<td><a href="exception.md#exception">exception</a></td>
65+
<td><img src="https://img.shields.io/badge/-stable-lightgreen" alt="Stable"/></td>
66+
</tr><tr>
67+
<td>Feature Flag</td><td></td><td></td>
68+
</tr><tr>
69+
<td></td>
70+
<td><a href="feature-flag.md#feature-flag-evaluation">feature_flag.evaluation</a></td>
71+
<td><img src="https://img.shields.io/badge/-rc-mediumorchid" alt="Release Candidate"/></td>
72+
</tr><tr>
73+
<td>Gen AI</td><td></td><td></td>
74+
</tr><tr>
75+
<td></td>
76+
<td><a href="gen-ai.md#gen-ai-assistant-message">gen_ai.assistant.message</a></td>
77+
<td><img src="https://img.shields.io/badge/-development-blue" alt="Development"/></td>
78+
</tr><tr>
79+
<td></td>
80+
<td><a href="gen-ai.md#gen-ai-choice">gen_ai.choice</a></td>
81+
<td><img src="https://img.shields.io/badge/-development-blue" alt="Development"/></td>
82+
</tr><tr>
83+
<td></td>
84+
<td><a href="gen-ai.md#gen-ai-system-message">gen_ai.system.message</a></td>
85+
<td><img src="https://img.shields.io/badge/-development-blue" alt="Development"/></td>
86+
</tr><tr>
87+
<td></td>
88+
<td><a href="gen-ai.md#gen-ai-tool-message">gen_ai.tool.message</a></td>
89+
<td><img src="https://img.shields.io/badge/-development-blue" alt="Development"/></td>
90+
</tr><tr>
91+
<td></td>
92+
<td><a href="gen-ai.md#gen-ai-user-message">gen_ai.user.message</a></td>
93+
<td><img src="https://img.shields.io/badge/-development-blue" alt="Development"/></td>
94+
</tr><tr>
95+
<td>RPC</td><td></td><td></td>
96+
</tr><tr>
97+
<td></td>
98+
<td><a href="rpc.md#rpc-message">rpc.message</a></td>
99+
<td><img src="https://img.shields.io/badge/-development-blue" alt="Development"/></td>
100+
</tr><tr>
101+
<td>Session</td><td></td><td></td>
102+
</tr><tr>
103+
<td></td>
104+
<td><a href="session.md#session-end">session.end</a></td>
105+
<td><img src="https://img.shields.io/badge/-development-blue" alt="Development"/></td>
106+
</tr><tr>
107+
<td></td>
108+
<td><a href="session.md#session-start">session.start</a></td>
109+
<td><img src="https://img.shields.io/badge/-development-blue" alt="Development"/></td>
110+
</tr>
111+
</tbody>
112+
</table>

‎docs/registry/events/app.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
<!-- NOTE: THIS FILE IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
2+
<!-- see templates/registry/markdown/entity_namespace.md.j2 -->
3+
<!-- markdownlint-capture -->
4+
<!-- markdownlint-disable -->
5+
6+
# App
7+
8+
## App Screen Click
9+
10+
**Status:** ![Development](https://img.shields.io/badge/-development-blue)
11+
12+
**Event Name:** `app.screen.click`
13+
14+
**Summary:** This event represents an instantaneous click on the screen of an application.
15+
16+
17+
**Description:** The `app.screen.click` event can be used to indicate that a user has clicked or tapped on the screen portion of an application. Clicks outside of an application's active area SHOULD NOT generate this event. This event does not differentiate between touch/mouse down and touch/mouse up. Implementations SHOULD give preference to generating this event at the time the click is complete, typically on touch release or mouse up. The location of the click event MUST be provided in absolute screen pixels.
18+
19+
### Attributes:
20+
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
21+
|---|---|---|---|---|---|
22+
| [`app.screen.coordinate.x`](/docs/registry/attributes/app.md) | int | The x (horizontal) coordinate of a screen coordinate, in screen pixels. | `0`; `131` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
23+
| [`app.screen.coordinate.y`](/docs/registry/attributes/app.md) | int | The y (vertical) component of a screen coordinate, in screen pixels. | `12`; `99` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
24+
25+
## App Widget Click
26+
27+
**Status:** ![Development](https://img.shields.io/badge/-development-blue)
28+
29+
**Event Name:** `app.widget.click`
30+
31+
**Summary:** This event indicates that an application widget has been clicked.
32+
33+
34+
**Description:** Use this event to indicate that visual application component has been clicked, typically through a user's manual interaction.
35+
36+
### Attributes:
37+
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
38+
|---|---|---|---|---|---|
39+
| [`app.widget.id`](/docs/registry/attributes/app.md) | string | An identifier that uniquely differentiates this widget from other widgets in the same application. [1] | `f9bc787d-ff05-48ad-90e1-fca1d46130b3`; `submit_order_1829` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
40+
| [`app.screen.coordinate.x`](/docs/registry/attributes/app.md) | int | The x (horizontal) coordinate of a screen coordinate, in screen pixels. | `0`; `131` | `Opt-In` | ![Development](https://img.shields.io/badge/-development-blue) |
41+
| [`app.screen.coordinate.y`](/docs/registry/attributes/app.md) | int | The y (vertical) component of a screen coordinate, in screen pixels. | `12`; `99` | `Opt-In` | ![Development](https://img.shields.io/badge/-development-blue) |
42+
| [`app.widget.name`](/docs/registry/attributes/app.md) | string | The name of an application widget. [2] | `submit`; `attack`; `Clear Cart` | `Opt-In` | ![Development](https://img.shields.io/badge/-development-blue) |
43+
44+
**[1] `app.widget.id`:** A widget is an application component, typically an on-screen visual GUI element.
45+
46+
**[2] `app.widget.name`:** A widget is an application component, typically an on-screen visual GUI element.
47+
48+
<!-- markdownlint-restore -->

‎docs/registry/events/az.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<!-- NOTE: THIS FILE IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
2+
<!-- see templates/registry/markdown/entity_namespace.md.j2 -->
3+
<!-- markdownlint-capture -->
4+
<!-- markdownlint-disable -->
5+
6+
# Az
7+
8+
## Az Resource Log
9+
10+
**Status:** ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `azure.resource.log`.
11+
12+
**Event Name:** `az.resource.log`
13+
14+
**Summary:** Deprecated. Use `azure.resource.log` instead.
15+
16+
17+
### Attributes:
18+
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
19+
|---|---|---|---|---|---|
20+
| [`az.service_request_id`](/docs/registry/attributes/azure.md) | string | Deprecated, use `azure.service.request.id` instead. | `00000000-0000-0000-0000-000000000000` | `Recommended` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `azure.service.request.id`. |
21+
| [`cloud.resource_id`](/docs/registry/attributes/cloud.md) | string | The [Fully Qualified Azure Resource ID](https://learn.microsoft.com/rest/api/resources/resources/get-by-id) the log is emitted for. | `arn:aws:lambda:REGION:ACCOUNT_ID:function:my-function`; `//run.googleapis.com/projects/PROJECT_ID/locations/LOCATION_ID/services/SERVICE_ID`; `/subscriptions/<SUBSCRIPTION_GUID>/resourceGroups/<RG>/providers/Microsoft.Web/sites/<FUNCAPP>/functions/<FUNC>` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
22+
### Body fields:
23+
24+
**Status:** ![Development](https://img.shields.io/badge/-development-blue)
25+
26+
**requirement:** `Recommended`
27+
28+
29+
30+
:warning: Body fields will be moved to complex attributes once the
31+
semantic convention tooling supports complex attributes
32+
(see [#1870](https://github.com/open-telemetry/semantic-conventions/issues/1870)).
33+
34+
<!-- markdownlint-restore -->

‎docs/registry/events/azure.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
<!-- NOTE: THIS FILE IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
2+
<!-- see templates/registry/markdown/entity_namespace.md.j2 -->
3+
<!-- markdownlint-capture -->
4+
<!-- markdownlint-disable -->
5+
6+
# Azure
7+
8+
## Azure Resource Log
9+
10+
**Status:** ![Development](https://img.shields.io/badge/-development-blue)
11+
12+
**Event Name:** `azure.resource.log`
13+
14+
**Summary:** Describes Azure Resource Log event, see [Azure Resource Log Top-level Schema](https://learn.microsoft.com/azure/azure-monitor/essentials/resource-logs-schema#top-level-common-schema) for more details.
15+
16+
17+
### Attributes:
18+
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
19+
|---|---|---|---|---|---|
20+
| [`azure.service.request.id`](/docs/registry/attributes/azure.md) | string | The unique identifier of the service request. It's generated by the Azure service and returned with the response. | `00000000-0000-0000-0000-000000000000` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
21+
| [`cloud.resource_id`](/docs/registry/attributes/cloud.md) | string | The [Fully Qualified Azure Resource ID](https://learn.microsoft.com/rest/api/resources/resources/get-by-id) the log is emitted for. | `arn:aws:lambda:REGION:ACCOUNT_ID:function:my-function`; `//run.googleapis.com/projects/PROJECT_ID/locations/LOCATION_ID/services/SERVICE_ID`; `/subscriptions/<SUBSCRIPTION_GUID>/resourceGroups/<RG>/providers/Microsoft.Web/sites/<FUNCAPP>/functions/<FUNC>` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
22+
### Body fields:
23+
24+
**Status:** ![Development](https://img.shields.io/badge/-development-blue)
25+
26+
**requirement:** `Recommended`
27+
28+
29+
30+
:warning: Body fields will be moved to complex attributes once the
31+
semantic convention tooling supports complex attributes
32+
(see [#1870](https://github.com/open-telemetry/semantic-conventions/issues/1870)).
33+
| Body Field | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
34+
|---|---|---|---|---|---|
35+
| `category` | string | The Azure category of the log entry. | `AuditEvent`; `GatewayLogs`; `ApplicationGatewayAccessLog` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
36+
| `correlation.id` | string | The correlation ID of the log entry. | `607964b6-41a5-4e24-a5db-db7aab3b9b34` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
37+
| `duration` | int | The duration of the operations in milliseconds. | `1000` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
38+
| `identity` | undefined | "A JSON blob that describes the identity of the user or application that performed the operation." [1] | | `Opt-In` | ![Development](https://img.shields.io/badge/-development-blue) |
39+
| `operation.name` | string | The name of the operation. | `SecretGet`; `Microsoft.ApiManagement/GatewayLogs`; `ApplicationGatewayAccess` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
40+
| `operation.version` | string | The version of the operation. | `1.0` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
41+
| `properties` | undefined | The properties provided in the Azure Resource Log. | | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
42+
| `result.description` | string | The description of the result. | `The operation was successful`; `The operation failed` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
43+
| `result.signature` | string | The substatus of associated with the logged event. | `OK` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
44+
| `result.type` | string | The status associated with the logged event. | `Succeeded`; `Failed`; `Started` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
45+
| `tenant.id` | string | The tenant ID of the Active Directory tenant that this event is tied to. | `00000000-0000-0000-0000-000000000000` | `Conditionally Required` [2] | ![Development](https://img.shields.io/badge/-development-blue) |
46+
47+
**[1]:** Typically, this field includes the authorization and claims or JWT token from Active Directory.
48+
49+
> [!Warning]
50+
> This field contains sensitive (PII) information.
51+
52+
**[2] `tenant.id`:** if the event is tied to an Active Directory tenant.
53+
54+
55+
<!-- markdownlint-restore -->

‎docs/registry/events/browser.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
<!-- NOTE: THIS FILE IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
2+
<!-- see templates/registry/markdown/entity_namespace.md.j2 -->
3+
<!-- markdownlint-capture -->
4+
<!-- markdownlint-disable -->
5+
6+
# Browser
7+
8+
## Browser Web Vital
9+
10+
**Status:** ![Development](https://img.shields.io/badge/-development-blue)
11+
12+
**Event Name:** `browser.web_vital`
13+
14+
**Summary:** This event describes the website performance metrics introduced by Google, See [web vitals](https://web.dev/vitals).
15+
16+
17+
### Body fields:
18+
19+
**Status:** ![Development](https://img.shields.io/badge/-development-blue)
20+
21+
**requirement:** `Required`
22+
23+
24+
25+
:warning: Body fields will be moved to complex attributes once the
26+
semantic convention tooling supports complex attributes
27+
(see [#1870](https://github.com/open-telemetry/semantic-conventions/issues/1870)).
28+
| Body Field | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
29+
|---|---|---|---|---|---|
30+
| `delta` | double | The delta between the current value and the last-reported value. See [delta](https://github.com/GoogleChrome/web-vitals?tab=readme-ov-file#report-only-the-delta-of-changes). | `0.2` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
31+
| `id` | string | A unique ID representing this particular metric instance. | `v3-1677874579383-6381583661209` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
32+
| `name` | enum | Name of the web vital. | `cls` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
33+
| `value` | double | Value of the web vital. | `1.0` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
34+
35+
`name` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
36+
37+
| Value | Description | Stability |
38+
|---|---|---|
39+
| `cls` | Cumulative Layout Shift. See [cls](https://web.dev/articles/cls). | ![Development](https://img.shields.io/badge/-development-blue) |
40+
| `fid` | First Input Delay. See [fid](https://web.dev/articles/fid). | ![Development](https://img.shields.io/badge/-development-blue) |
41+
| `inp` | Interation to Next Paint. See [inp](https://web.dev/articles/inp). | ![Development](https://img.shields.io/badge/-development-blue) |
42+
| `lcp` | Largest Contentful Paint. See [lcp](https://web.dev/articles/lcp). | ![Development](https://img.shields.io/badge/-development-blue) |
43+
44+
45+
<!-- markdownlint-restore -->

0 commit comments

Comments
 (0)