Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upgrade to semantic convention generator with event name (0.8.0) #1928

Closed
wants to merge 2 commits into from
+12 −13
Closed

Upgrade to semantic convention generator with event name (0.8.0) #1928

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
18dadfe
Upgrade to semantic convention generator 0.7.0
Oberon00 Sep 15, 2021
fee7644
Merge branch 'main' into feature/semconv-0.7.0
Oberon00 Sep 17, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions semantic_conventions/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ i.e.:
Semantic conventions for the spec MUST adhere to the
[attribute naming conventions](../specification/common/attribute-naming.md).

Refer to the [syntax](https://github.com/open-telemetry/build-tools/tree/v0.6.0/semantic-conventions/syntax.md)
Refer to the [syntax](https://github.com/open-telemetry/build-tools/tree/v0.7.0/semantic-conventions/syntax.md)
for how to write the YAML files for semantic conventions and what the YAML properties mean.

A schema file for VS code is configured in the `/.vscode/settings.json` of this
repository, enabling auto-completion and additional checks. Refer to
[the generator README](https://github.com/open-telemetry/build-tools/tree/v0.6.0/semantic-conventions/README.md) for what extension you need.
[the generator README](https://github.com/open-telemetry/build-tools/tree/v0.7.0/semantic-conventions/README.md) for what extension you need.

## Generating markdown

Expand All @@ -33,7 +33,7 @@ formatted Markdown tables for all semantic conventions in the specification. Run
make table-generation
```

For more information, see the [semantic convention generator](https://github.com/open-telemetry/build-tools/tree/v0.6.0/semantic-conventions)
For more information, see the [semantic convention generator](https://github.com/open-telemetry/build-tools/tree/v0.7.0/semantic-conventions)
in the OpenTelemetry build tools repository.
Using this build tool, it is also possible to generate code for use in OpenTelemetry
language projects.
Expand Down
15 changes: 7 additions & 8 deletions specification/trace/semantic_conventions/exceptions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,16 @@ exceptions.

<!-- toc -->

- [Recording an Exception](#recording-an-exception)
- [Attributes](#attributes)
- [Stacktrace Representation](#stacktrace-representation)
- [Semantic Conventions for Exceptions](#semantic-conventions-for-exceptions)
- [Recording an Exception](#recording-an-exception)
- [Semantic definitions and attributes](#semantic-definitions-and-attributes)
- [Stacktrace Representation](#stacktrace-representation)

<!-- tocstop -->

## Recording an Exception

An exception SHOULD be recorded as an `Event` on the span during which it occurred.
The name of the event MUST be `"exception"`.

<a name="exception-end-example"></a>

Expand All @@ -36,12 +36,11 @@ try {
}
```

## Attributes

The table below indicates which attributes should be added to the `Event` and
their types.
## Semantic definitions and attributes

<!-- semconv exception -->
The event name MUST be `exception`.

| Attribute | Type | Description | Examples | Required |
|---|---|---|---|---|
| `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` | See below |
Expand Down
4 changes: 2 additions & 2 deletions specification/trace/semantic_conventions/rpc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,9 +150,9 @@ client and server spans SHOULD be created. In case of
unary calls only one sent and one received message will be recorded for both
client and server spans.

The event name MUST be `"message"`.

<!-- semconv rpc.grpc.message -->
The event name MUST be `message`.

| Attribute | Type | Description | Examples | Required |
|---|---|---|---|---|
| `message.type` | string | Whether this is a received or sent message. | `SENT` | No |
Expand Down