Skip to content

Commit

Permalink
[editorial] Move supplementary-guidelines into docs
Browse files Browse the repository at this point in the history
  • Loading branch information
chalin committed Jul 25, 2024
1 parent c22cd95 commit 5f34f03
Show file tree
Hide file tree
Showing 7 changed files with 33 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/cloud-providers/aws-sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Some descriptions are also provided for populating general OpenTelemetry semanti

## Context Propagation

See [compatibility](../../supplementary-guidelines/compatibility/aws.md#context-propagation).
See [compatibility](../non-normative/compatibility/aws.md#context-propagation).

## Common Attributes

Expand Down
4 changes: 2 additions & 2 deletions docs/faas/aws-lambda.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ For every message in the event, the [message system attributes][] (not message a
the user) SHOULD be checked for the key `AWSTraceHeader`. If it is present, an OpenTelemetry `Context` SHOULD be
parsed from the value of the attribute using the [AWS X-Ray Propagator](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.33.0/specification/context/api-propagators.md) and
added as a link to the span. This means the span may have as many links as messages in the batch.
See [compatibility](../../supplementary-guidelines/compatibility/aws.md#context-propagation) for more info.
See [compatibility](../non-normative/compatibility/aws.md#context-propagation) for more info.

- [`faas.trigger`][faas] MUST be set to `pubsub`.
- [`messaging.operation.type`](/docs/messaging/messaging-spans.md) MUST be set to `process`.
Expand All @@ -181,7 +181,7 @@ corresponding to the SQS event. The [message system attributes][] (not message a
the user) SHOULD be checked for the key `AWSTraceHeader`. If it is present, an OpenTelemetry `Context` SHOULD be
parsed from the value of the attribute using the [AWS X-Ray Propagator](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.33.0/specification/context/api-propagators.md) and
added as a link to the span.
See [compatibility](../../supplementary-guidelines/compatibility/aws.md#context-propagation) for more info.
See [compatibility](../non-normative/compatibility/aws.md#context-propagation) for more info.

- [`faas.trigger`][faas] MUST be set to `pubsub`.
- [`messaging.operation.type`](/docs/messaging/messaging-spans.md#messaging-attributes) MUST be set to `process`.
Expand Down
11 changes: 11 additions & 0 deletions docs/non-normative/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: Non-normative
path_base_for_github_subdir:
from: tmp/semconv/docs/non-normative/_index.md
to: non-normative/README.md
--->

# Non-normative supplementary information

The pages in this section are **non-normative**, most are supplementary
guidelines.
7 changes: 7 additions & 0 deletions docs/non-normative/compatibility/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<!--- Hugo front matter used to generate the website version of this page:
path_base_for_github_subdir:
from: tmp/semconv/docs/non-normative/compatibility/_index.md
to: non-normative/compatibility/README.md
--->

# Compatibility
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: AWS
--->

# Compatibility Considerations for AWS

This document highlights compatibility considerations for OpenTelemetry
This page highlights compatibility considerations for OpenTelemetry
instrumentations when interacting with AWS managed services using an aws-sdk,
a third-party library, or a direct HTTP request.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: Libraries
# Renamed from: semantic_conventions_code_generation
--->

# Semantic convention libraries

<!-- toc -->
Expand Down Expand Up @@ -115,4 +120,4 @@ Code-generation usually involves several steps which could be semi-automated:
5. Fix lint violations in the auto-generated code (if any)
6. Send the PR with new code to the corresponding repository

Here're the examples of how steps 2-5 are implemented for [Java](https://github.com/open-telemetry/semantic-conventions-java/blob/7da24068eea69dff11a78d59750b115dc4c5854d/build.gradle.kts#L55-L137) and [Python](https://github.com/open-telemetry/opentelemetry-python/blob/397e357dfad3e6ff42c09c74d5945dfdcad24bdd/scripts/semconv/generate.sh).
Here are examples of how steps 2-5 are implemented for [Java](https://github.com/open-telemetry/semantic-conventions-java/blob/7da24068eea69dff11a78d59750b115dc4c5854d/build.gradle.kts#L55-L137) and [Python](https://github.com/open-telemetry/opentelemetry-python/blob/397e357dfad3e6ff42c09c74d5945dfdcad24bdd/scripts/semconv/generate.sh).
2 changes: 1 addition & 1 deletion internal/tools/update_specification_version.sh
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ fix_file() {
"$1"
}

important_files=("docs" "model" "README.md" "supplementary-guidelines")
important_files=("docs" "model" "README.md")

# TODO - limit to markdown/yaml files?
find "${important_files[@]}" -type f -not -path '*/.*' -print0 | while read -d $'\0' file; do
Expand Down

0 comments on commit 5f34f03

Please sign in to comment.