Add generated modules that output const &str for tracing compatibility

Author: kriswuollett

opentelemetry-semantic-conventions/scripts/generate-consts-from-spec.sh

@@ -31,6 +31,17 @@ docker run --rm \
 	--output /output/trace.rs \
 	--parameters conventions=trace
 
+docker run --rm \
+	-v "${CRATE_DIR}/semantic-conventions/model:/source" \
+	-v "${CRATE_DIR}/scripts/templates:/templates" \
+	-v "${CRATE_DIR}/src/semconv:/output" \
+	otel/semconvgen:$SEMCOVGEN_VERSION \
+  --only span,event,attribute_group,scope \
+  -f /source code \
+	--template /templates/semconv_semantic_attributes.rs.j2 \
+	--output /output/trace.rs \
+	--parameters conventions=trace
+
 docker run --rm \
 	-v "${CRATE_DIR}/semantic-conventions/model:/source" \
 	-v "${CRATE_DIR}/scripts/templates:/templates" \
@@ -42,6 +53,18 @@ docker run --rm \
 	--output /output/resource.rs \
 	--parameters conventions=resource
 
+docker run --rm \
+	-v "${CRATE_DIR}/semantic-conventions/model:/source" \
+	-v "${CRATE_DIR}/scripts/templates:/templates" \
+	-v "${CRATE_DIR}/src/semconv:/output" \
+	otel/semconvgen:$SEMCOVGEN_VERSION \
+  --only resource \
+  -f /source code \
+	--template /templates/semconv_semantic_attributes.rs.j2 \
+	--output /output/resource.rs \
+	--parameters conventions=resource
+
+
 # Keep `SCHEMA_URL` key in sync with spec version
 sed -i "s/\(opentelemetry.io\/schemas\/\)[^\"]*\"/\1$SPEC_VERSION\"/" src/lib.rs
 

opentelemetry-semantic-conventions/scripts/templates/semconv_header_resource.rs

@@ -0,0 +1,20 @@
+//! # Resource Semantic Conventions
+//!
+//! The [resource semantic conventions] define a set of standardized attributes
+//! to be used in `Resource`s.
+//!
+//! [resource semantic conventions]: https://github.com/open-telemetry/semantic-conventions/tree/main/model/resource
+//!
+//! ## Usage
+//!
+//! ```
+//! use opentelemetry_semantic_conventions::semconv;
+//! use tracing::span;
+//!
+//! let span = span!(
+//!     LEVEL::INFO,
+//!     "handle_request",
+//!     { semconv::resource::SERVICE_NAME = "my-service" },
+//!     { semconv::resource::SERVICE_NAMESPACE = "my-namespace" }
+//! );
+//! ```

opentelemetry-semantic-conventions/scripts/templates/semconv_header_trace.rs

@@ -0,0 +1,20 @@
+//! # Trace Semantic Conventions
+//!
+//! The [trace semantic conventions] define a set of standardized attributes to
+//! be used in `Span`s.
+//!
+//! [trace semantic conventions]: https://github.com/open-telemetry/semantic-conventions/tree/main/model/trace
+//!
+//! ## Usage
+//!
+//! ```
+//! use opentelemetry_semantic_conventions::semconv;
+//! use tracing::span;
+//!
+//! let span = span!(
+//!     LEVEL::INFO,
+//!     "handle_request",
+//!     { semconv::trace::NET_PEER_NAME = "example.org" },
+//!     { semconv::trace::NET_PEER_PORT = 80 }
+//! );
+//! ```

opentelemetry-semantic-conventions/scripts/templates/semconv_semantic_attributes.rs.j2

@@ -0,0 +1,30 @@
+// DO NOT EDIT, this is an auto-generated file
+//
+// If you want to update the file:
+// - Edit the template at scripts{{template}}
+// - Run the script at scripts/generate-consts-from-spec.sh
+
+{% include 'semconv_header_' + conventions + '.rs' %}
+
+{%- for attribute in attributes if attribute.is_local and not attribute.ref %}
+
+/// {% filter escape %}{{attribute.brief | to_doc_brief}}.{% endfilter %}
+{%- if attribute.note %}
+///
+{%- for line in attribute.note.split('\n') %}
+/// {% filter escape %}{{line}}{% endfilter %}
+{%- endfor %}
+{%- endif %}
+{%- if attribute.examples %}
+///
+/// # Examples
+///
+{%- for example in attribute.examples %}
+/// - `{{example}}`
+{%- endfor %}
+{%- endif %}
+{%- if (attribute.stability | string()) == "StabilityLevel.DEPRECATED"  %}
+#[deprecated]
+{%- endif %}
+pub const {{attribute.fqn | to_const_name}}: &str = "{{attribute.fqn}}";
+{%- endfor %}

opentelemetry-semantic-conventions/src/semconv/mod.rs

@@ -0,0 +1,2 @@
+pub mod resource;
+pub mod trace;