Skip to content

Commit 1240a6d

Browse files
thompson-tomothompson-tomo
committed
Removal of events to identify gap
1 parent 996f804 commit 1240a6d

File tree

13 files changed

+150
-971
lines changed

13 files changed

+150
-971
lines changed

‎docs/app/app.md

Lines changed: 2 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -9,76 +9,9 @@ linkTitle: App
99
This document defines events related to client-side applications
1010
(e.g. web apps or mobile apps).
1111

12-
<!-- toc -->
12+
## Events
1313

14-
- [Click Events](#click-events)
15-
- [Event: `app.screen.click`](#event-appscreenclick)
16-
- [Event: `app.widget.click`](#event-appwidgetclick)
17-
- [Attributes](#attributes)
18-
19-
<!-- tocstop -->
20-
21-
## Click Events
22-
23-
### Event: `app.screen.click`
24-
25-
<!-- semconv event.app.screen.click -->
26-
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
27-
<!-- see templates/registry/markdown/snippet.md.j2 -->
28-
<!-- prettier-ignore-start -->
29-
<!-- markdownlint-capture -->
30-
<!-- markdownlint-disable -->
31-
32-
**Status:** ![Development](https://img.shields.io/badge/-development-blue)
33-
34-
The event name MUST be `app.screen.click`.
35-
36-
This event represents an instantaneous click on the screen of an application.
37-
38-
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.
39-
40-
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
41-
|---|---|---|---|---|---|
42-
| [`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) |
43-
| [`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) |
44-
45-
<!-- markdownlint-restore -->
46-
<!-- prettier-ignore-end -->
47-
<!-- END AUTOGENERATED TEXT -->
48-
<!-- endsemconv -->
49-
50-
### Event: `app.widget.click`
51-
52-
<!-- semconv event.app.widget.click -->
53-
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
54-
<!-- see templates/registry/markdown/snippet.md.j2 -->
55-
<!-- prettier-ignore-start -->
56-
<!-- markdownlint-capture -->
57-
<!-- markdownlint-disable -->
58-
59-
**Status:** ![Development](https://img.shields.io/badge/-development-blue)
60-
61-
The event name MUST be `app.widget.click`.
62-
63-
This event indicates that an application widget has been clicked.
64-
65-
Use this event to indicate that visual application component has been clicked, typically through a user's manual interaction.
66-
67-
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
68-
|---|---|---|---|---|---|
69-
| [`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) |
70-
| [`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) |
71-
| [`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) |
72-
| [`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) |
73-
74-
**[1] `app.widget.id`:** A widget is an application component, typically an on-screen visual GUI element.
75-
76-
**[2] `app.widget.name`:** A widget is an application component, typically an on-screen visual GUI element.
77-
78-
<!-- markdownlint-restore -->
79-
<!-- prettier-ignore-end -->
80-
<!-- END AUTOGENERATED TEXT -->
81-
<!-- endsemconv -->
14+
Is now described in the namespace registry.
8215

8316
## Attributes
8417

‎docs/azure/events.md

Lines changed: 2 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -9,56 +9,8 @@ linkTitle: Events
99
This document defines semantic conventions for instrumentations that emit Azure
1010
Resource Log events.
1111

12-
## Azure Resource Log
12+
## Events
1313

14-
<!-- semconv event.azure.resource.log -->
15-
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
16-
<!-- see templates/registry/markdown/snippet.md.j2 -->
17-
<!-- prettier-ignore-start -->
18-
<!-- markdownlint-capture -->
19-
<!-- markdownlint-disable -->
20-
21-
**Status:** ![Development](https://img.shields.io/badge/-development-blue)
22-
23-
The event name MUST be `azure.resource.log`.
24-
25-
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.
26-
27-
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
28-
|---|---|---|---|---|---|
29-
| [`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) |
30-
| [`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) |
31-
32-
**Body fields:**
33-
34-
:warning: Body fields will be moved to complex attributes once the
35-
semantic convention tooling supports complex attributes
36-
(see [#1870](https://github.com/open-telemetry/semantic-conventions/issues/1870)).
37-
38-
| Body Field | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
39-
|---|---|---|---|---|---|
40-
| `category` | string | The Azure category of the log entry. | `AuditEvent`; `GatewayLogs`; `ApplicationGatewayAccessLog` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
41-
| `correlation.id` | string | The correlation ID of the log entry. | `607964b6-41a5-4e24-a5db-db7aab3b9b34` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
42-
| `duration` | int | The duration of the operations in milliseconds. | `1000` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
43-
| `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) |
44-
| `operation.name` | string | The name of the operation. | `SecretGet`; `Microsoft.ApiManagement/GatewayLogs`; `ApplicationGatewayAccess` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
45-
| `operation.version` | string | The version of the operation. | `1.0` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
46-
| `properties` | undefined | The properties provided in the Azure Resource Log. | | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
47-
| `result.description` | string | The description of the result. | `The operation was successful`; `The operation failed` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
48-
| `result.signature` | string | The substatus of associated with the logged event. | `OK` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
49-
| `result.type` | string | The status associated with the logged event. | `Succeeded`; `Failed`; `Started` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
50-
| `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) |
51-
52-
**[1]:** Typically, this field includes the authorization and claims or JWT token from Active Directory.
53-
54-
> [!Warning]
55-
> This field contains sensitive (PII) information.
56-
57-
**[2] `tenant.id`:** if the event is tied to an Active Directory tenant.
58-
59-
<!-- markdownlint-restore -->
60-
<!-- prettier-ignore-end -->
61-
<!-- END AUTOGENERATED TEXT -->
62-
<!-- endsemconv -->
14+
Is now described in the namespace registry.
6315

6416
[DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status

‎docs/browser/events.md

Lines changed: 2 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -9,46 +9,8 @@ linkTitle: Events
99
This document defines semantic conventions for browser (web) instrumentations
1010
that emit events.
1111

12-
## WebVital Event
12+
## Events
1313

14-
<!-- semconv event.browser.web_vital -->
15-
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
16-
<!-- see templates/registry/markdown/snippet.md.j2 -->
17-
<!-- prettier-ignore-start -->
18-
<!-- markdownlint-capture -->
19-
<!-- markdownlint-disable -->
20-
21-
**Status:** ![Development](https://img.shields.io/badge/-development-blue)
22-
23-
The event name MUST be `browser.web_vital`.
24-
25-
This event describes the website performance metrics introduced by Google, See [web vitals](https://web.dev/vitals).
26-
27-
**Body fields:**
28-
29-
:warning: Body fields will be moved to complex attributes once the
30-
semantic convention tooling supports complex attributes
31-
(see [#1870](https://github.com/open-telemetry/semantic-conventions/issues/1870)).
32-
33-
| Body Field | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
34-
|---|---|---|---|---|---|
35-
| `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) |
36-
| `id` | string | A unique ID representing this particular metric instance. | `v3-1677874579383-6381583661209` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
37-
| `name` | enum | Name of the web vital. | `cls` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
38-
| `value` | double | Value of the web vital. | `1.0` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
39-
40-
`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.
41-
42-
| Value | Description | Stability |
43-
|---|---|---|
44-
| `cls` | Cumulative Layout Shift. See [cls](https://web.dev/articles/cls). | ![Development](https://img.shields.io/badge/-development-blue) |
45-
| `fid` | First Input Delay. See [fid](https://web.dev/articles/fid). | ![Development](https://img.shields.io/badge/-development-blue) |
46-
| `inp` | Interation to Next Paint. See [inp](https://web.dev/articles/inp). | ![Development](https://img.shields.io/badge/-development-blue) |
47-
| `lcp` | Largest Contentful Paint. See [lcp](https://web.dev/articles/lcp). | ![Development](https://img.shields.io/badge/-development-blue) |
48-
49-
<!-- markdownlint-restore -->
50-
<!-- prettier-ignore-end -->
51-
<!-- END AUTOGENERATED TEXT -->
52-
<!-- endsemconv -->
14+
Is now described in the namespace registry.
5315

5416
[DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status

‎docs/exceptions/exceptions-logs.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,12 +46,44 @@ The table below indicates which attributes should be added to the
4646
|---|---|---|---|---|---|
4747
| [`exception.message`](/docs/registry/attributes/exception.md) | string | The exception message. | `Division by zero`; `Can't convert 'int' object to str implicitly` | `Conditionally Required` [1] | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
4848
| [`exception.type`](/docs/registry/attributes/exception.md) | 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` | `Conditionally Required` [2] | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
49-
| [`exception.stacktrace`](/docs/registry/attributes/exception.md) | 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` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
49+
| [`exception.stacktrace`](/docs/registry/attributes/exception.md) | 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. [3] | `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` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
5050

5151
**[1] `exception.message`:** Required if `exception.type` is not set, recommended otherwise.
5252

5353
**[2] `exception.type`:** Required if `exception.message` is not set, recommended otherwise.
5454

55+
**[3] `exception.stacktrace`:** The table below, adapted from [Google Cloud][gcp-error-reporting], includes
56+
possible representations of stacktraces in various languages. The table is not
57+
meant to be a recommendation for any particular language, although SIGs are free
58+
to adopt them if they see fit.
59+
60+
| Language | Format |
61+
| ---------- | ------------------------------------------------------------------- |
62+
| C# | the return value of [Exception.ToString()][csharp-stacktrace] |
63+
| Elixir | the return value of [Exception.format/3][elixir-stacktrace] |
64+
| Erlang | the return value of [`erl_error:format`][erlang-stacktrace] |
65+
| Go | the return value of [runtime.Stack][go-stacktrace] |
66+
| Java | the contents of [Throwable.printStackTrace()][java-stacktrace] |
67+
| Javascript | the return value of [error.stack][js-stacktrace] as returned by V8 |
68+
| Python | the return value of [traceback.format_exc()][python-stacktrace] |
69+
| Ruby | the return value of [Exception.full_message][ruby-full-message] |
70+
71+
Backends can use the language specified methodology for generating a stacktrace
72+
combined with platform information from the
73+
[telemetry sdk resource][telemetry-sdk-resource] in order to extract more fine
74+
grained information from a stacktrace, if necessary.
75+
76+
[gcp-error-reporting]: https://cloud.google.com/error-reporting/reference/rest/v1beta1/projects.events/report
77+
[java-stacktrace]: https://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html#printStackTrace%28%29
78+
[python-stacktrace]: https://docs.python.org/3/library/traceback.html#traceback.format_exc
79+
[js-stacktrace]: https://v8.dev/docs/stack-trace-api
80+
[ruby-full-message]: https://docs.ruby-lang.org/en/3.4/Exception.html#method-i-full_message
81+
[csharp-stacktrace]: https://docs.microsoft.com/dotnet/api/system.exception.tostring
82+
[go-stacktrace]: https://pkg.go.dev/runtime/debug#Stack
83+
[telemetry-sdk-resource]: ../resource/README.md#telemetry-sdk
84+
[erlang-stacktrace]: https://www.erlang.org/doc/apps/stdlib/erl_error.html#format_exception/3
85+
[elixir-stacktrace]: https://hexdocs.pm/elixir/1.14.3/Exception.html#format/3
86+
5587
<!-- markdownlint-restore -->
5688
<!-- prettier-ignore-end -->
5789
<!-- END AUTOGENERATED TEXT -->

0 commit comments

Comments
 (0)