Skip to content

Commit 42a3207

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

File tree

16 files changed

+143
-1073
lines changed

16 files changed

+143
-1073
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/README.md

Lines changed: 0 additions & 16 deletions
This file was deleted.

‎docs/azure/events.md

Lines changed: 0 additions & 64 deletions
This file was deleted.

‎docs/browser/events.md

Lines changed: 0 additions & 54 deletions
This file was deleted.

‎docs/exceptions/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ linkTitle: Exceptions
88

99
Semantic conventions for Exceptions are defined for the following signals:
1010

11-
* [Exceptions on spans](exceptions-spans.md): Semantic Conventions for Exceptions associated with *spans*.
11+
* Events: is described in the namespace registry
1212
* [Exceptions in logs](exceptions-logs.md): Semantic Conventions for Exceptions recorded in *logs*.
1313

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

‎docs/exceptions/exceptions-logs.md

Lines changed: 33 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,6 @@ This document defines semantic conventions for recording exceptions on
1010
[logs](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.46.0/specification/logs/api.md#emit-a-logrecord)
1111
emitted through the [Logger API](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.46.0/specification/logs/api.md#logger).
1212

13-
<!-- toc -->
14-
15-
- [Recording an exception](#recording-an-exception)
16-
- [Attributes](#attributes)
17-
- [Stacktrace representation](#stacktrace-representation)
18-
19-
<!-- tocstop -->
20-
2113
## Recording an exception
2214

2315
Exceptions SHOULD be recorded as attributes on the
@@ -46,20 +38,47 @@ The table below indicates which attributes should be added to the
4638
|---|---|---|---|---|---|
4739
| [`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) |
4840
| [`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) |
41+
| [`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) |
5042

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

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

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

60-
### Stacktrace representation
61-
62-
Same as [Trace Semantic Conventions for Exceptions - Stacktrace
63-
Representation](exceptions-spans.md#stacktrace-representation).
64-
6584
[DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status

0 commit comments

Comments
 (0)