Skip to content

Commit f517fd3

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

File tree

19 files changed

+241
-1076
lines changed

19 files changed

+241
-1076
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/code/README.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ This document defines semantic conventions for source code.
2323
| [`code.file.path`](/docs/registry/attributes/code.md) | string | The source code file name that identifies the code unit as uniquely as possible (preferably an absolute file path). This attribute MUST NOT be used on the Profile signal since the data is already captured in 'message Function'. This constraint is imposed to prevent redundancy and maintain data integrity. | `/usr/local/MyApplication/content_root/app/index.php` | `Recommended` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
2424
| [`code.function.name`](/docs/registry/attributes/code.md) | string | The method or function fully-qualified name without arguments. The value should fit the natural representation of the language runtime, which is also likely the same used within `code.stacktrace` attribute value. This attribute MUST NOT be used on the Profile signal since the data is already captured in 'message Function'. This constraint is imposed to prevent redundancy and maintain data integrity. [1] | `com.example.MyHttpService.serveRequest`; `GuzzleHttp\Client::transfer`; `fopen` | `Recommended` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
2525
| [`code.line.number`](/docs/registry/attributes/code.md) | int | The line number in `code.file.path` best representing the operation. It SHOULD point within the code unit named in `code.function.name`. This attribute MUST NOT be used on the Profile signal since the data is already captured in 'message Line'. This constraint is imposed to prevent redundancy and maintain data integrity. | `42` | `Recommended` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
26-
| [`code.stacktrace`](/docs/registry/attributes/code.md) | string | A stacktrace as a string in the natural representation for the language runtime. The representation is identical to [`exception.stacktrace`](/docs/exceptions/exceptions-spans.md#stacktrace-representation). This attribute MUST NOT be used on the Profile signal since the data is already captured in 'message Location'. This constraint is imposed to prevent redundancy and maintain data integrity. | `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)` | `Opt-In` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
26+
| [`code.stacktrace`](/docs/registry/attributes/code.md) | string | A stacktrace as a string in the natural representation for the language runtime. This attribute MUST NOT be used on the Profile signal since the data is already captured in 'message Location'. This constraint is imposed to prevent redundancy and maintain data integrity. [2] | `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)` | `Opt-In` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
2727

2828
**[1] `code.function.name`:** Values and format depends on each language runtime, thus it is impossible to provide an exhaustive list of examples.
2929
The values are usually the same (or prefixes of) the ones found in native stack trace representation stored in
@@ -41,6 +41,38 @@ Examples:
4141
* Rust: `playground::my_module::my_cool_func`
4242
* C function: `fopen`
4343

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

‎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

0 commit comments

Comments
 (0)