fix: use url.path || http.target for sampling decision (#258)

closes #255

CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
+## Version 1.1.1 - 2024-11-28
+
+### Fixed
+
+- Use attribute `url.path` (with fallback to deprecated `http.target`) for sampling decision
+
 ## Version 1.1.0 - 2024-11-27
 
 ### Added

lib/tracing/index.js

@@ -24,9 +24,9 @@ function _getSampler() {
   else {
     // eslint-disable-next-line no-unused-vars
     _shouldSample = (_context, _traceId, _name, _spanKind, attributes, _links) => {
-      const originalUrl = attributes?.['http.originalUrl']
-      if (!originalUrl) return true
-      return !ignoreIncomingPaths.some(p => originalUrl.startsWith(p))
+      const url_path = attributes?.['url.path'] || attributes?.['http.target'] //> http.target is deprecated
+      if (!url_path) return true
+      return !ignoreIncomingPaths.some(p => url_path.startsWith(p))
     }
   }
 

lib/tracing/trace.js

@@ -203,7 +203,13 @@ function trace(name, fn, targetObj, args, options = {}) {
     kind: _determineKind(targetObj, name?.phase, isAsync, options)
   }
   // needed for sampling decision (cf. shouldSample)
-  if (cds.context?.http?.req) spanOptions.attributes = { 'http.originalUrl': cds.context.http?.req.originalUrl }
+  if (cds.context?.http?.req) {
+    const url_path = cds.context.http.req.baseUrl + cds.context.http.req.path
+    spanOptions.attributes = {
+      'url.path': url_path,
+      'http.target': url_path //> http.target is deprecated
+    }
+  }
   if (HRTIME) spanOptions.startTime = _hrnow()
   if (isAsync) {
     spanOptions.links = [{ context: parentSpan.spanContext() }]

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cap-js/telemetry",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "CDS plugin providing observability features, incl. automatic OpenTelemetry instrumentation.",
   "repository": {
     "type": "git",