open-telemetry
/
semantic-conventions
mirror of https://github.com/open-telemetry/semantic-conventions.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update schema url to the weaver one and replace other links to build-tools (#1405) 

Co-authored-by: Joao Grassi <5938087+joaopgrassi@users.noreply.github.com>
This commit is contained in:
Liudmila Molkova 2024-09-17 04:32:05 -07:00 committed by GitHub
parent 5ca489187e
commit 0005a84772
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 9 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.vscode/settings.json vendored
View File

@ -10,7 +10,7 @@
"MD040": false, "MD040": false,
}, },
"yaml.schemas": { "yaml.schemas": {
"https://raw.githubusercontent.com/open-telemetry/build-tools/v0.24.0/semantic-conventions/semconv.schema.json": [ "https://raw.githubusercontent.com/open-telemetry/weaver/v0.9.2/schemas/semconv.schema.json": [
"model/**/*.yaml" "model/**/*.yaml"
] ]
}, },

8
CONTRIBUTING.md
View File

@ -91,7 +91,7 @@ environment configured:
### 1. Modify the YAML model ### 1. Modify the YAML model
Refer to the Refer to the
[Semantic Convention YAML Language](https://github.com/open-telemetry/build-tools/blob/v0.25.0/semantic-conventions/syntax.md) [Semantic Convention YAML Language](https://github.com/open-telemetry/weaver/blob/main/schemas/semconv-syntax.md)
to learn how to make changes to the YAML files. to learn how to make changes to the YAML files.
#### Code structure #### Code structure
@ -343,14 +343,14 @@ make markdown-link-check
### Version compatibility check ### Version compatibility check
Semantic conventions are validated for backward compatibility with last released versions. Here's [the full list of compatibility checks](https://github.com/open-telemetry/build-tools/blob/main/semantic-conventions/README.md#version-compatibility-check). Semantic conventions are validated for backward compatibility with last released versions. Here's [the full list of compatibility checks](./policies/compatibility.rego).
Removing attributes, metrics, or enum members is not allowed, they should be deprecated instead. Removing attributes, metrics, or enum members is not allowed, they should be deprecated instead.
It applies to stable and experimental conventions and prevents semantic conventions auto-generated libraries from introducing breaking changes. It applies to stable and experimental conventions and prevents semantic conventions auto-generated libraries from introducing breaking changes.
You can run backward compatibility check in all yaml files with the following command: You can run backward compatibility check (along with other policies) in all yaml files with the following command:
```bash ```bash
make compatibility-check make check-policies
``` ```
## Updating the referenced specification version ## Updating the referenced specification version

10
model/README.md
View File

@ -14,12 +14,12 @@ Semantic conventions for the spec MUST adhere to the
[attribute requirement level](../docs/general/attribute-requirement-level.md), [attribute requirement level](../docs/general/attribute-requirement-level.md),
and [metric requirement level](../docs/general/metric-requirement-level.md) conventions. and [metric requirement level](../docs/general/metric-requirement-level.md) conventions.
Refer to the [syntax](https://github.com/open-telemetry/build-tools/tree/v0.25.0/semantic-conventions/syntax.md) Refer to the [syntax](https://github.com/open-telemetry/weaver/blob/main/schemas/semconv-syntax.md)
for how to write the YAML files for semantic conventions and what the YAML properties mean. 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 A schema file for VS code is configured in the `/.vscode/settings.json` of this
repository, enabling auto-completion and additional checks. Refer to repository, enabling auto-completion and additional checks. Refer to
[the generator README](https://github.com/open-telemetry/build-tools/tree/v0.25.0/semantic-conventions/README.md) for what extension you need. [the generator README](https://github.com/open-telemetry/weaver/blob/main/schemas/semconv-syntax.md) for what extension you need.
## Generating markdown ## Generating markdown
@ -32,12 +32,10 @@ make table-generation
For more information, see the [Weaver](https://github.com/open-telemetry/weaver) For more information, see the [Weaver](https://github.com/open-telemetry/weaver)
as our code generations tool. as our code generations tool.
Using Weaver, it is also possible to generate code for use in OpenTelemetry
language projects, in addition to build-tools.
See also: See also:
* [Markdown Templates](https://github.com/open-telemetry/semantic-conventions/tree/main/templates/registry/markdown) * [Markdown Templates](../templates/registry/markdown)
* [Weaver Template Documentation](https://github.com/open-telemetry/weaver/blob/main/crates/weaver_forge/README.md) * [Weaver Template Documentation](https://github.com/open-telemetry/weaver/blob/main/crates/weaver_forge/README.md)
* [Weaver Usage Documentation](https://github.com/open-telemetry/weaver/blob/main/docs/usage.md#registry-generate) * [Weaver Usage Documentation](https://github.com/open-telemetry/weaver/blob/main/docs/usage.md#registry-generate)
* [Build Tools - Code Generator](https://github.com/open-telemetry/build-tools/tree/main/semantic-conventions#code-generator) * [Code Generator Documentation](../docs/non-normative/code-generation.md)