@contrail/telemetry 2.0.11-alpha-semantic-convention.1 → 2.0.11

package/CHANGELOG.md

@@ -9,7 +9,7 @@ Versioning follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ### Added
 
-- **`buildContrailAttrName` helper** — Centralizes the `contrail.*` namespace prefix for custom OTel attributes. Returns a typed template literal (`contrail.${T}`) and enforces lowercase input at compile time. Existing constants (`ATTR_CONTRAIL_SYSTEM`, `ATTR_CONTRAIL_USER`, `ATTR_LOG_MESSAGE`, `ATTR_LOG_BODY`, `ATTR_LOG_PAYLOAD`) now use this helper instead of hardcoded strings.
+- **`buildContrailAttributeName` helper** — Centralizes the `contrail.*` namespace prefix for custom OTel attributes. Returns a typed template literal (`contrail.${T}`) and enforces lowercase for string literals at compile time. Existing constants (`ATTR_CONTRAIL_SYSTEM`, `ATTR_CONTRAIL_USER`, `ATTR_LOG_MESSAGE`, `ATTR_LOG_BODY`, `ATTR_LOG_PAYLOAD`) now use this helper instead of hardcoded strings.
 
 ## [2.0.10] - 2026-04-21
 

package/lib/logger/semantic-conventions.js

@@ -8,13 +8,13 @@ const semantic_conventions_1 = require("../semantic-conventions");
 /**
  * Attribute key for the log message body.
  */
-exports.ATTR_LOG_MESSAGE = (0, semantic_conventions_1.buildContrailAttrName)('message');
+exports.ATTR_LOG_MESSAGE = (0, semantic_conventions_1.buildContrailAttributeName)('message');
 /**
  * Custom attribute that duplicates the log body so it is available for
  * grouping / filtering in observability UIs that only expose custom attributes.
  */
-exports.ATTR_LOG_BODY = (0, semantic_conventions_1.buildContrailAttrName)('log.body');
+exports.ATTR_LOG_BODY = (0, semantic_conventions_1.buildContrailAttributeName)('log.body');
 /**
  * Attribute key for user-provided log payload objects.
  */
-exports.ATTR_LOG_PAYLOAD = (0, semantic_conventions_1.buildContrailAttrName)('payload');
+exports.ATTR_LOG_PAYLOAD = (0, semantic_conventions_1.buildContrailAttributeName)('payload');

package/lib/semantic-conventions.d.ts

@@ -23,10 +23,11 @@ export declare const ATTR_USER_ROLES: "user.roles";
  */
 export declare const ATTR_DEPLOYMENT_ENVIRONMENT_NAME: "deployment.environment.name";
 /**
- * Builds a custom attribute name with the platform namespace prefix.
- * @example buildContrailAttrName('event_workflow.task.id') // => 'contrail.event_workflow.task.id'
+ * Builds a custom attribute name with the `contrail.*` namespace prefix.
+ * Enforces lowercase for string literals at compile time; runtime values are not validated.
+ * @example buildContrailAttributeName('event_workflow.task.id') // => 'contrail.event_workflow.task.id'
  */
-export declare function buildContrailAttrName<T extends string>(name: T & Lowercase<T>): `contrail.${T}`;
+export declare function buildContrailAttributeName<T extends string>(name: T & Lowercase<T>): `contrail.${T}`;
 /**
  * Namespace for Contrail platform context.
  */

package/lib/semantic-conventions.js

@@ -9,7 +9,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ATTR_CONTRAIL_USER = exports.ATTR_CONTRAIL_SYSTEM = exports.ATTR_DEPLOYMENT_ENVIRONMENT_NAME = exports.ATTR_USER_ROLES = exports.ATTR_USER_EMAIL = exports.ATTR_USER_ID = void 0;
-exports.buildContrailAttrName = buildContrailAttrName;
+exports.buildContrailAttributeName = buildContrailAttributeName;
 // ---------------------------------------------------------------------------
 // OTel-spec attributes not yet in the SDK
 // ---------------------------------------------------------------------------
@@ -33,17 +33,18 @@ exports.ATTR_DEPLOYMENT_ENVIRONMENT_NAME = 'deployment.environment.name';
 // Contrail-custom attributes
 // ---------------------------------------------------------------------------
 /**
- * Builds a custom attribute name with the platform namespace prefix.
- * @example buildContrailAttrName('event_workflow.task.id') // => 'contrail.event_workflow.task.id'
+ * Builds a custom attribute name with the `contrail.*` namespace prefix.
+ * Enforces lowercase for string literals at compile time; runtime values are not validated.
+ * @example buildContrailAttributeName('event_workflow.task.id') // => 'contrail.event_workflow.task.id'
  */
-function buildContrailAttrName(name) {
+function buildContrailAttributeName(name) {
     return `contrail.${name}`;
 }
 /**
  * Namespace for Contrail platform context.
  */
-exports.ATTR_CONTRAIL_SYSTEM = buildContrailAttrName('system');
+exports.ATTR_CONTRAIL_SYSTEM = buildContrailAttributeName('system');
 /**
  * Namespace for Contrail-custom user attributes (not in OTel spec).
  */
-exports.ATTR_CONTRAIL_USER = buildContrailAttrName('user');
+exports.ATTR_CONTRAIL_USER = buildContrailAttributeName('user');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrail/telemetry",
-  "version": "2.0.11-alpha-semantic-convention.1",
+  "version": "2.0.11",
   "description": "Telemetry and monitoring utilities for contrail services",
   "main": "lib/index.js",
   "browser": "lib/index.browser.js",