{"id":15177376,"url":"https://github.com/open-telemetry/semantic-conventions-java","last_synced_at":"2025-04-11T23:17:00.622Z","repository":{"id":187747812,"uuid":"677496181","full_name":"open-telemetry/semantic-conventions-java","owner":"open-telemetry","description":"Java generated classes for semantic conventions","archived":false,"fork":false,"pushed_at":"2025-04-11T22:00:23.000Z","size":724,"stargazers_count":24,"open_issues_count":6,"forks_count":27,"subscribers_count":17,"default_branch":"main","last_synced_at":"2025-04-11T23:16:54.296Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/open-telemetry.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-08-11T18:09:58.000Z","updated_at":"2025-04-11T22:00:27.000Z","dependencies_parsed_at":"2023-08-12T02:09:57.928Z","dependency_job_id":"b322583a-6759-4d91-a2d8-d5a31c8e2990","html_url":"https://github.com/open-telemetry/semantic-conventions-java","commit_stats":null,"previous_names":["open-telemetry/semantic-conventions-java"],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-telemetry%2Fsemantic-conventions-java","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-telemetry%2Fsemantic-conventions-java/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-telemetry%2Fsemantic-conventions-java/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-telemetry%2Fsemantic-conventions-java/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/open-telemetry","download_url":"https://codeload.github.com/open-telemetry/semantic-conventions-java/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248492885,"owners_count":21113163,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-09-27T14:21:49.025Z","updated_at":"2025-04-11T23:17:00.615Z","avatar_url":"https://github.com/open-telemetry.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OpenTelemetry Semantic Conventions for Java\n\n[![Release](https://img.shields.io/github/v/release/open-telemetry/semantic-conventions-java?include_prereleases\u0026style=)](https://github.com/open-telemetry/semantic-conventions-java/releases/)\n[![FOSSA License Status](https://app.fossa.com/api/projects/custom%2B162%2Fgithub.com%2Fopen-telemetry%2Fsemantic-conventions-java.svg?type=shield\u0026issueType=license)](https://app.fossa.com/projects/custom%2B162%2Fgithub.com%2Fopen-telemetry%2Fsemantic-conventions-java?ref=badge_shield\u0026issueType=license)\n[![FOSSA Security Status](https://app.fossa.com/api/projects/custom%2B162%2Fgithub.com%2Fopen-telemetry%2Fsemantic-conventions-java.svg?type=shield\u0026issueType=security)](https://app.fossa.com/projects/custom%2B162%2Fgithub.com%2Fopen-telemetry%2Fsemantic-conventions-java?ref=badge_shield\u0026issueType=security)\n[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/open-telemetry/semantic-conventions-java/badge)](https://scorecard.dev/viewer/?uri=github.com/open-telemetry/semantic-conventions-java)\n[![Slack](https://img.shields.io/badge/slack-@cncf/otel--java-blue.svg?logo=slack)](https://cloud-native.slack.com/archives/C014L2KCTE3)\n\nJava code-generation for the [OpenTelemetry Semantic Conventions](https://github.com/open-telemetry/semantic-conventions).\n\n## Published releases\n\nPublished releases are available on maven central. Replace `{{version}}` with the latest released version:\n\n| Artifact `{group}:{artifactId}:{version}`                                     | Latest Version                           | Description                                                                                                                                                                                                                                                                                      |\n|-------------------------------------------------------------------------------|------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `io.opentelemetry.semconv:opentelemetry-semconv:{{version}}`                  | ![Maven Central][maven-badge-stable]     | Generated code for stable semantic conventions.                                                                                                                                                                                                                                                  |        \n| `io.opentelemetry.semconv:opentelemetry-semconv-incubating:{{version}}-alpha` | ![Maven Central][maven-badge-incubating] | Generated code for experimental semantic conventions.\u003c/br\u003e**NOTE:** This artifact has the [-alpha][versioning] and comes with no compatibility guarantees. Libraries can use this for testing, but should make copies of the attributes to avoid possible runtime errors from version conflicts. |        \n\n\n### Maven\n\n```xml\n\u003cproject\u003e\n  \u003cdependencies\u003e\n    \u003cdependency\u003e\n      \u003cgroupId\u003eio.opentelemetry.semconv\u003c/groupId\u003e\n      \u003cartifactId\u003eopentelemetry-semconv\u003c/artifactId\u003e\n      \u003cversion\u003e{{version}}\u003c/version\u003e\n    \u003c/dependency\u003e\n    \u003c!-- Incubating semantic conventions. Breaking changes expected. Library instrumentation SHOULD NOT depend on this. --\u003e\n    \u003cdependency\u003e\n      \u003cgroupId\u003eio.opentelemetry.semconv\u003c/groupId\u003e\n      \u003cartifactId\u003eopentelemetry-semconv-incubating\u003c/artifactId\u003e\n      \u003cversion\u003e{{version}}-alpha\u003c/version\u003e\n    \u003c/dependency\u003e\n  \u003c/dependencies\u003e\n\u003c/project\u003e\n```\n\n### Gradle\n\n```groovy\ndependencies {\n  implementation \"io.opentelemetry.semconv:opentelemetry-semconv:{{version}}\"\n  // Incubating semantic conventions. Breaking changes expected. Library instrumentation SHOULD NOT depend on this.\n  implementation \"io.opentelemetry.semconv:opentelemetry-semconv-incubating:{{version}}-alpha\"\n}\n```\n\n## Requirements\n\nJava 17 or higher is required to build the projects in this repository. The built artifacts can be\nused on Java 8 or higher.\n\nTo use these artifacts, you must also depend on `io.opentelemetry:opentelemetry-api:{{version}}`.\nSee [opentelemetry-java releases](https://github.com/open-telemetry/opentelemetry-java#releases) for\nmore information.\n\n## Android Requirements\n\nAn additional requirement for apps supporting older versions of Android on top of \n[desugaring](https://github.com/open-telemetry/opentelemetry-java/blob/main/VERSIONING.md#language-version-compatibility) \nis the need to set the Gradle property `android.useFullClasspathForDexingTransform` for debug \nbuilds. Please see [this](https://github.com/open-telemetry/opentelemetry-android/pull/309) \npull request on the OpenTelemetry Android Extension for details.\n\n## Compatibility\n\nArtifacts from this repository follow semantic versioning, mirroring the versions of the upstream [semantic-conventions](https://github.com/open-telemetry/semantic-conventions) repository. If a patch release is needed for logic in this repository, a release will be published with a fourth version component (i.e. `1.30.0.1` to patch an issue with `1.30.0`).  \n\nStable artifacts (i.e. artifacts without `-alpha` version suffix) come with strong backwards compatibility guarantees for public APIs.\n\nCompatibility guarantees are inherited from [opentelemetry-java][versioning].\n\n## Generating semantic conventions\n\nRequires docker.\n\nIn a shell, execute the following gradle tasks:\n\n```shell\n./gradlew clean generateSemanticConventions --console=plain\n./gradlew spotlessApply\n```\n\nThis will download the version\nof [open-telemetry/semantic-conventions](https://github.com/open-telemetry/semantic-conventions)\ndefined in the `semanticConventionsVersion` variable of [build.gradle.kts](./build.gradle.kts) and\ngenerate semantic conventions classes from the release contents.\n\n## Contributing\n\nBefore you start - see OpenTelemetry\ngeneral [contributing](https://github.com/open-telemetry/community/tree/main/guides/contributor)\nrequirements and recommendations.\n\nMake sure to review the projects [license](LICENSE) and sign\nthe [CNCF CLA](https://identity.linuxfoundation.org/projects/cncf). A signed CLA will be enforced by\nan automatic check once you submit a PR, but you can also sign it after opening your PR.\n\nThis repository is an extension\nof [open-telemetry/opentelemetry-java](https://github.com/open-telemetry/opentelemetry-java).\nSee [opentelemetry-java contributors](https://github.com/open-telemetry/opentelemetry-java#contributing)\nfor code owners.\n\n[maven-badge-stable]: https://img.shields.io/maven-central/v/io.opentelemetry.semconv/opentelemetry-semconv\n[maven-badge-incubating]: https://img.shields.io/maven-central/v/io.opentelemetry.semconv/opentelemetry-semconv-incubating\n\n[versioning]: https://github.com/open-telemetry/opentelemetry-java/blob/main/VERSIONING.md\n\nTODO(jack-berg): add code coverage badge?\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopen-telemetry%2Fsemantic-conventions-java","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopen-telemetry%2Fsemantic-conventions-java","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopen-telemetry%2Fsemantic-conventions-java/lists"}