@twin.org/tracing-processors 0.9.2-next.3

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 IOTA Stiftung.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,21 @@
+# TWIN Tracing Processors
+
+Traces the HTTP boundary, recording spans for inbound routes and outbound REST requests and carrying the trace between services.
+
+## Installation
+
+```shell
+npm install @twin.org/tracing-processors
+```
+
+## Examples
+
+Usage of the APIs is shown in the examples [docs/examples.md](docs/examples.md)
+
+## Reference
+
+Detailed reference documentation for the API can be found in [docs/reference/index.md](docs/reference/index.md)
+
+## Changelog
+
+The changes between each version can be found in [docs/changelog.md](docs/changelog.md)

package/dist/es/index.js

@@ -0,0 +1,9 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./models/ITracingRestClientProcessorConfig.js";
+export * from "./models/ITracingRestClientProcessorConstructorOptions.js";
+export * from "./models/ITracingRouteProcessorConfig.js";
+export * from "./models/ITracingRouteProcessorConstructorOptions.js";
+export * from "./tracingRestClientProcessor.js";
+export * from "./tracingRouteProcessor.js";
+//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,+CAA+C,CAAC;AAC9D,cAAc,2DAA2D,CAAC;AAC1E,cAAc,0CAA0C,CAAC;AACzD,cAAc,sDAAsD,CAAC;AACrE,cAAc,iCAAiC,CAAC;AAChD,cAAc,4BAA4B,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./models/ITracingRestClientProcessorConfig.js\";\nexport * from \"./models/ITracingRestClientProcessorConstructorOptions.js\";\nexport * from \"./models/ITracingRouteProcessorConfig.js\";\nexport * from \"./models/ITracingRouteProcessorConstructorOptions.js\";\nexport * from \"./tracingRestClientProcessor.js\";\nexport * from \"./tracingRouteProcessor.js\";\n"]}

package/dist/es/models/ITracingRestClientProcessorConfig.js

@@ -0,0 +1,4 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=ITracingRestClientProcessorConfig.js.map

package/dist/es/models/ITracingRestClientProcessorConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ITracingRestClientProcessorConfig.js","sourceRoot":"","sources":["../../../src/models/ITracingRestClientProcessorConfig.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Configuration for the tracing REST client processor.\n */\nexport interface ITracingRestClientProcessorConfig {\n\t/**\n\t * Route templates to skip tracing.\n\t */\n\texcludePaths?: string[];\n}\n"]}

package/dist/es/models/ITracingRestClientProcessorConstructorOptions.js

@@ -0,0 +1,4 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=ITracingRestClientProcessorConstructorOptions.js.map

package/dist/es/models/ITracingRestClientProcessorConstructorOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ITracingRestClientProcessorConstructorOptions.js","sourceRoot":"","sources":["../../../src/models/ITracingRestClientProcessorConstructorOptions.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\nimport type { ITracingRestClientProcessorConfig } from \"./ITracingRestClientProcessorConfig.js\";\n\n/**\n * Options for the TracingRestClientProcessor constructor.\n */\nexport interface ITracingRestClientProcessorConstructorOptions {\n\t/**\n\t * The type for the tracing component, when absent no spans are created and no trace header is\n\t * sent.\n\t */\n\ttracingComponentType?: string;\n\n\t/**\n\t * Configuration for the processor.\n\t */\n\tconfig?: ITracingRestClientProcessorConfig;\n}\n"]}

package/dist/es/models/ITracingRouteProcessorConfig.js

@@ -0,0 +1,4 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=ITracingRouteProcessorConfig.js.map

package/dist/es/models/ITracingRouteProcessorConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ITracingRouteProcessorConfig.js","sourceRoot":"","sources":["../../../src/models/ITracingRouteProcessorConfig.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Configuration for the tracing route processor.\n */\nexport interface ITracingRouteProcessorConfig {\n\t/**\n\t * Request URL path prefixes to skip tracing.\n\t */\n\texcludePaths?: string[];\n\n\t/**\n\t * Route operation IDs to skip tracing.\n\t */\n\texcludeOperationIds?: string[];\n}\n"]}

package/dist/es/models/ITracingRouteProcessorConstructorOptions.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ITracingRouteProcessorConstructorOptions.js.map

package/dist/es/models/ITracingRouteProcessorConstructorOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ITracingRouteProcessorConstructorOptions.js","sourceRoot":"","sources":["../../../src/models/ITracingRouteProcessorConstructorOptions.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ITracingRouteProcessorConfig } from \"./ITracingRouteProcessorConfig.js\";\n\n/**\n * Options for the TracingRouteProcessor constructor.\n */\nexport interface ITracingRouteProcessorConstructorOptions {\n\t/**\n\t * The type for the tracing component.\n\t */\n\ttracingComponentType?: string;\n\n\t/**\n\t * The type for the logging component.\n\t */\n\tloggingComponentType?: string;\n\n\t/**\n\t * The configuration for the tracing route processor.\n\t */\n\tconfig?: ITracingRouteProcessorConfig;\n}\n"]}

package/dist/es/tracingRestClientProcessor.js

@@ -0,0 +1,66 @@
+import { ComponentFactory, Is } from "@twin.org/core";
+import { SpanKind, TraceparentHelper, TracingHelper } from "@twin.org/tracing-models";
+import { HttpStatusCode } from "@twin.org/web";
+/**
+ * Records a span for each outbound REST request and carries the trace via traceparent header.
+ */
+export class TracingRestClientProcessor {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "TracingRestClientProcessor";
+    /**
+     * The component recording the spans.
+     * @internal
+     */
+    _tracing;
+    /**
+     * Route templates to skip tracing.
+     * @internal
+     */
+    _excludeRouteTemplates;
+    /**
+     * Create a new instance of TracingRestClientProcessor.
+     * @param options Options for the processor.
+     */
+    constructor(options) {
+        this._tracing = ComponentFactory.getIfExists(options?.tracingComponentType);
+        this._excludeRouteTemplates = options?.config?.excludePaths ?? [];
+    }
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return TracingRestClientProcessor.CLASS_NAME;
+    }
+    /**
+     * Wrap the request in a client span, sending the current span as the traceparent so the
+     * receiving service continues this trace.
+     * @param context The details of the request being made.
+     * @param next Performs the request.
+     * @returns The response.
+     */
+    async pre(context, next) {
+        if (Is.empty(this._tracing) || this._excludeRouteTemplates.includes(context.routeTemplate)) {
+            return next();
+        }
+        return TracingHelper.withSpan(this._tracing, `${context.restClientClassName}${context.route.startsWith("/") ? "" : "/"}${context.route}`, {
+            kind: SpanKind.Client,
+            attributes: { "http.method": context.method, "http.route": context.route }
+        }, async (span) => {
+            if (!Is.empty(span)) {
+                context.headers[TraceparentHelper.HEADER_NAME] = TraceparentHelper.format(span.context);
+            }
+            const response = await next();
+            if (!Is.empty(span)) {
+                span.attributes = {
+                    ...span.attributes,
+                    "http.status_code": response.status ?? HttpStatusCode.ok
+                };
+            }
+            return response;
+        });
+    }
+}
+//# sourceMappingURL=tracingRestClientProcessor.js.map

package/dist/es/tracingRestClientProcessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tracingRestClientProcessor.js","sourceRoot":"","sources":["../../src/tracingRestClientProcessor.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,gBAAgB,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AAEtD,OAAO,EACN,QAAQ,EACR,iBAAiB,EACjB,aAAa,EAEb,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAG/C;;GAEG;AACH,MAAM,OAAO,0BAA0B;IACtC;;OAEG;IACI,MAAM,CAAU,UAAU,gCAAgD;IAEjF;;;OAGG;IACc,QAAQ,CAAqB;IAE9C;;;OAGG;IACc,sBAAsB,CAAW;IAElD;;;OAGG;IACH,YAAY,OAAuD;QAClE,IAAI,CAAC,QAAQ,GAAG,gBAAgB,CAAC,WAAW,CAAC,OAAO,EAAE,oBAAoB,CAAC,CAAC;QAC5E,IAAI,CAAC,sBAAsB,GAAG,OAAO,EAAE,MAAM,EAAE,YAAY,IAAI,EAAE,CAAC;IACnE,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,0BAA0B,CAAC,UAAU,CAAC;IAC9C,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,GAAG,CACf,OAAoC,EACpC,IAA6B;QAE7B,IAAI,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,sBAAsB,CAAC,QAAQ,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC;YAC5F,OAAO,IAAI,EAAE,CAAC;QACf,CAAC;QAED,OAAO,aAAa,CAAC,QAAQ,CAC5B,IAAI,CAAC,QAAQ,EACb,GAAG,OAAO,CAAC,mBAAmB,GAAG,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,OAAO,CAAC,KAAK,EAAE,EAC3F;YACC,IAAI,EAAE,QAAQ,CAAC,MAAM;YACrB,UAAU,EAAE,EAAE,aAAa,EAAE,OAAO,CAAC,MAAM,EAAE,YAAY,EAAE,OAAO,CAAC,KAAK,EAAE;SAC1E,EACD,KAAK,EAAC,IAAI,EAAC,EAAE;YACZ,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;gBACrB,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC,WAAW,CAAC,GAAG,iBAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACzF,CAAC;YAED,MAAM,QAAQ,GAAG,MAAM,IAAI,EAAE,CAAC;YAE9B,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;gBACrB,IAAI,CAAC,UAAU,GAAG;oBACjB,GAAG,IAAI,CAAC,UAAU;oBAClB,kBAAkB,EAAE,QAAQ,CAAC,MAAM,IAAI,cAAc,CAAC,EAAE;iBACxD,CAAC;YACH,CAAC;YAED,OAAO,QAAQ,CAAC;QACjB,CAAC,CACD,CAAC;IACH,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IRestClientProcessor, IRestClientProcessorContext } from \"@twin.org/api-models\";\nimport { ComponentFactory, Is } from \"@twin.org/core\";\nimport { nameof } from \"@twin.org/nameof\";\nimport {\n\tSpanKind,\n\tTraceparentHelper,\n\tTracingHelper,\n\ttype ITracingComponent\n} from \"@twin.org/tracing-models\";\nimport { HttpStatusCode } from \"@twin.org/web\";\nimport type { ITracingRestClientProcessorConstructorOptions } from \"./models/ITracingRestClientProcessorConstructorOptions.js\";\n\n/**\n * Records a span for each outbound REST request and carries the trace via traceparent header.\n */\nexport class TracingRestClientProcessor implements IRestClientProcessor {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<TracingRestClientProcessor>();\n\n\t/**\n\t * The component recording the spans.\n\t * @internal\n\t */\n\tprivate readonly _tracing?: ITracingComponent;\n\n\t/**\n\t * Route templates to skip tracing.\n\t * @internal\n\t */\n\tprivate readonly _excludeRouteTemplates: string[];\n\n\t/**\n\t * Create a new instance of TracingRestClientProcessor.\n\t * @param options Options for the processor.\n\t */\n\tconstructor(options?: ITracingRestClientProcessorConstructorOptions) {\n\t\tthis._tracing = ComponentFactory.getIfExists(options?.tracingComponentType);\n\t\tthis._excludeRouteTemplates = options?.config?.excludePaths ?? [];\n\t}\n\n\t/**\n\t * Returns the class name of the component.\n\t * @returns The class name of the component.\n\t */\n\tpublic className(): string {\n\t\treturn TracingRestClientProcessor.CLASS_NAME;\n\t}\n\n\t/**\n\t * Wrap the request in a client span, sending the current span as the traceparent so the\n\t * receiving service continues this trace.\n\t * @param context The details of the request being made.\n\t * @param next Performs the request.\n\t * @returns The response.\n\t */\n\tpublic async pre(\n\t\tcontext: IRestClientProcessorContext,\n\t\tnext: () => Promise<Response>\n\t): Promise<Response> {\n\t\tif (Is.empty(this._tracing) || this._excludeRouteTemplates.includes(context.routeTemplate)) {\n\t\t\treturn next();\n\t\t}\n\n\t\treturn TracingHelper.withSpan(\n\t\t\tthis._tracing,\n\t\t\t`${context.restClientClassName}${context.route.startsWith(\"/\") ? \"\" : \"/\"}${context.route}`,\n\t\t\t{\n\t\t\t\tkind: SpanKind.Client,\n\t\t\t\tattributes: { \"http.method\": context.method, \"http.route\": context.route }\n\t\t\t},\n\t\t\tasync span => {\n\t\t\t\tif (!Is.empty(span)) {\n\t\t\t\t\tcontext.headers[TraceparentHelper.HEADER_NAME] = TraceparentHelper.format(span.context);\n\t\t\t\t}\n\n\t\t\t\tconst response = await next();\n\n\t\t\t\tif (!Is.empty(span)) {\n\t\t\t\t\tspan.attributes = {\n\t\t\t\t\t\t...span.attributes,\n\t\t\t\t\t\t\"http.status_code\": response.status ?? HttpStatusCode.ok\n\t\t\t\t\t};\n\t\t\t\t}\n\n\t\t\t\treturn response;\n\t\t\t}\n\t\t);\n\t}\n}\n"]}

package/dist/es/tracingRouteProcessor.js

@@ -0,0 +1,144 @@
+import { BaseError, Coerce, ComponentFactory, Is } from "@twin.org/core";
+import { SpanKind, SpanStatus, TraceparentHelper, TracingHelper } from "@twin.org/tracing-models";
+import { HttpStatusCode } from "@twin.org/web";
+/**
+ * Process the REST request and record it as a span.
+ */
+export class TracingRouteProcessor {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "TracingRouteProcessor";
+    /**
+     * The key the span is stored under while it is handed between the processor phases.
+     * @internal
+     */
+    static _STATE_KEY = "tracingProcessorSpan";
+    /**
+     * The component for recording the spans.
+     * @internal
+     */
+    _tracing;
+    /**
+     * The component for logging failures.
+     * @internal
+     */
+    _logging;
+    /**
+     * Request URL path prefixes to skip tracing, defaults to ["/tracing"].
+     * @internal
+     */
+    _excludePaths;
+    /**
+     * Route operation IDs to skip tracing.
+     * @internal
+     */
+    _excludeOperationIds;
+    /**
+     * Create a new instance of TracingRouteProcessor.
+     * @param options Options for the processor.
+     */
+    constructor(options) {
+        this._tracing = ComponentFactory.getIfExists(options?.tracingComponentType);
+        this._logging = ComponentFactory.getIfExists(options?.loggingComponentType);
+        this._excludePaths = options?.config?.excludePaths ?? ["/tracing"];
+        this._excludeOperationIds = options?.config?.excludeOperationIds ?? [];
+    }
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return TracingRouteProcessor.CLASS_NAME;
+    }
+    /**
+     * Pre process the REST request for the specified route, opening the span for the request.
+     * @param request The incoming request.
+     * @param response The outgoing response.
+     * @param route The route to process.
+     * @param contextIds The context IDs of the request.
+     * @param processorState The state handed through the processors.
+     * @returns A promise that resolves when the span has been started.
+     */
+    async pre(request, response, route, contextIds, processorState) {
+        if (Is.empty(this._tracing)) {
+            return;
+        }
+        if (Is.stringValue(route?.path) && this._excludePaths.includes(route.path)) {
+            return;
+        }
+        if (Is.stringValue(route?.operationId) &&
+            this._excludeOperationIds.includes(route.operationId)) {
+            return;
+        }
+        const parentContext = TraceparentHelper.parse(Coerce.string(request.headers?.[TraceparentHelper.HEADER_NAME]));
+        const span = await this._tracing.startSpan(this.spanName(request, route), {
+            kind: SpanKind.Server,
+            parentContext,
+            attributes: this.requestAttributes(request, route)
+        });
+        processorState[TracingRouteProcessor._STATE_KEY] = span;
+        Object.assign(contextIds, TracingHelper.spanContextToContextIds(span.context));
+    }
+    /**
+     * Post process the REST request for the specified route, ending the span for the request.
+     * @param request The incoming request.
+     * @param response The outgoing response.
+     * @param route The route to process.
+     * @param contextIds The context IDs of the request.
+     * @param processorState The state handed through the processors.
+     * @returns A promise that resolves when the span has been ended.
+     */
+    async post(request, response, route, contextIds, processorState) {
+        const span = processorState[TracingRouteProcessor._STATE_KEY];
+        if (Is.empty(this._tracing) || !Is.object(span)) {
+            return;
+        }
+        delete processorState[TracingRouteProcessor._STATE_KEY];
+        try {
+            const statusCode = Is.number(response.statusCode) ? response.statusCode : HttpStatusCode.ok;
+            span.attributes = { ...span.attributes, "http.status_code": statusCode };
+            await this._tracing.endSpan(span, statusCode >= HttpStatusCode.badRequest ? SpanStatus.Error : SpanStatus.Ok);
+        }
+        catch (err) {
+            await this._logging?.log({
+                level: "error",
+                source: TracingRouteProcessor.CLASS_NAME,
+                ts: Date.now(),
+                message: "endSpanFailed",
+                error: BaseError.fromError(err)
+            });
+        }
+    }
+    /**
+     * Build the name for the span.
+     * @param request The incoming request.
+     * @param route The route to process.
+     * @returns The span name.
+     * @internal
+     */
+    spanName(request, route) {
+        const routeName = route?.operationId ?? route?.path;
+        return Is.stringValue(routeName)
+            ? routeName
+            : `${request.method ?? "UNKNOWN"} ${TracingRouteProcessor.CLASS_NAME}`;
+    }
+    /**
+     * Build the attributes describing the request.
+     * @param request The incoming request.
+     * @param route The route to process.
+     * @returns The attributes.
+     * @internal
+     */
+    requestAttributes(request, route) {
+        const attributes = {};
+        if (Is.stringValue(request.method)) {
+            attributes["http.method"] = request.method;
+        }
+        if (Is.stringValue(route?.path)) {
+            attributes["http.route"] = route.path;
+        }
+        return attributes;
+    }
+}
+//# sourceMappingURL=tracingRouteProcessor.js.map

package/dist/es/tracingRouteProcessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tracingRouteProcessor.js","sourceRoot":"","sources":["../../src/tracingRouteProcessor.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,gBAAgB,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AAGzE,OAAO,EACN,QAAQ,EACR,UAAU,EACV,iBAAiB,EACjB,aAAa,EAGb,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAG/C;;GAEG;AACH,MAAM,OAAO,qBAAqB;IACjC;;OAEG;IACI,MAAM,CAAU,UAAU,2BAA2C;IAE5E;;;OAGG;IACK,MAAM,CAAU,UAAU,GAAW,sBAAsB,CAAC;IAEpE;;;OAGG;IACc,QAAQ,CAAqB;IAE9C;;;OAGG;IACc,QAAQ,CAAqB;IAE9C;;;OAGG;IACc,aAAa,CAAW;IAEzC;;;OAGG;IACc,oBAAoB,CAAW;IAEhD;;;OAGG;IACH,YAAY,OAAkD;QAC7D,IAAI,CAAC,QAAQ,GAAG,gBAAgB,CAAC,WAAW,CAAC,OAAO,EAAE,oBAAoB,CAAC,CAAC;QAC5E,IAAI,CAAC,QAAQ,GAAG,gBAAgB,CAAC,WAAW,CAAC,OAAO,EAAE,oBAAoB,CAAC,CAAC;QAC5E,IAAI,CAAC,aAAa,GAAG,OAAO,EAAE,MAAM,EAAE,YAAY,IAAI,CAAC,UAAU,CAAC,CAAC;QACnE,IAAI,CAAC,oBAAoB,GAAG,OAAO,EAAE,MAAM,EAAE,mBAAmB,IAAI,EAAE,CAAC;IACxE,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,qBAAqB,CAAC,UAAU,CAAC;IACzC,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,GAAG,CACf,OAA2B,EAC3B,QAAuB,EACvB,KAA6B,EAC7B,UAAuB,EACvB,cAAyC;QAEzC,IAAI,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC7B,OAAO;QACR,CAAC;QAED,IAAI,EAAE,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;YAC5E,OAAO;QACR,CAAC;QACD,IACC,EAAE,CAAC,WAAW,CAAC,KAAK,EAAE,WAAW,CAAC;YAClC,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,EACpD,CAAC;YACF,OAAO;QACR,CAAC;QAED,MAAM,aAAa,GAAG,iBAAiB,CAAC,KAAK,CAC5C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC,CAC/D,CAAC;QAEF,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE;YACzE,IAAI,EAAE,QAAQ,CAAC,MAAM;YACrB,aAAa;YACb,UAAU,EAAE,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,KAAK,CAAC;SAClD,CAAC,CAAC;QAEH,cAAc,CAAC,qBAAqB,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;QAExD,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,aAAa,CAAC,uBAAuB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,IAAI,CAChB,OAA2B,EAC3B,QAAuB,EACvB,KAA6B,EAC7B,UAAuB,EACvB,cAAyC;QAEzC,MAAM,IAAI,GAAG,cAAc,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC;QAE9D,IAAI,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAQ,IAAI,CAAC,EAAE,CAAC;YACxD,OAAO;QACR,CAAC;QAED,OAAO,cAAc,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC;QAExD,IAAI,CAAC;YACJ,MAAM,UAAU,GAAG,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,cAAc,CAAC,EAAE,CAAC;YAE5F,IAAI,CAAC,UAAU,GAAG,EAAE,GAAG,IAAI,CAAC,UAAU,EAAE,kBAAkB,EAAE,UAAU,EAAE,CAAC;YAEzE,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,CAC1B,IAAI,EACJ,UAAU,IAAI,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,EAAE,CAC1E,CAAC;QACH,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACd,MAAM,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC;gBACxB,KAAK,EAAE,OAAO;gBACd,MAAM,EAAE,qBAAqB,CAAC,UAAU;gBACxC,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE;gBACd,OAAO,EAAE,eAAe;gBACxB,KAAK,EAAE,SAAS,CAAC,SAAS,CAAC,GAAG,CAAC;aAC/B,CAAC,CAAC;QACJ,CAAC;IACF,CAAC;IAED;;;;;;OAMG;IACK,QAAQ,CAAC,OAA2B,EAAE,KAA6B;QAC1E,MAAM,SAAS,GAAG,KAAK,EAAE,WAAW,IAAI,KAAK,EAAE,IAAI,CAAC;QAEpD,OAAO,EAAE,CAAC,WAAW,CAAC,SAAS,CAAC;YAC/B,CAAC,CAAC,SAAS;YACX,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,IAAI,SAAS,IAAI,qBAAqB,CAAC,UAAU,EAAE,CAAC;IACzE,CAAC;IAED;;;;;;OAMG;IACK,iBAAiB,CACxB,OAA2B,EAC3B,KAA6B;QAE7B,MAAM,UAAU,GAA+B,EAAE,CAAC;QAElD,IAAI,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YACpC,UAAU,CAAC,aAAa,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;QAC5C,CAAC;QACD,IAAI,EAAE,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC;YACjC,UAAU,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC;QACvC,CAAC;QAED,OAAO,UAAU,CAAC;IACnB,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type {\n\tIBaseRoute,\n\tIBaseRouteProcessor,\n\tIHttpResponse,\n\tIHttpServerRequest\n} from \"@twin.org/api-models\";\nimport type { IContextIds } from \"@twin.org/context\";\nimport { BaseError, Coerce, ComponentFactory, Is } from \"@twin.org/core\";\nimport type { ILoggingComponent } from \"@twin.org/logging-models\";\nimport { nameof } from \"@twin.org/nameof\";\nimport {\n\tSpanKind,\n\tSpanStatus,\n\tTraceparentHelper,\n\tTracingHelper,\n\ttype ISpan,\n\ttype ITracingComponent\n} from \"@twin.org/tracing-models\";\nimport { HttpStatusCode } from \"@twin.org/web\";\nimport type { ITracingRouteProcessorConstructorOptions } from \"./models/ITracingRouteProcessorConstructorOptions.js\";\n\n/**\n * Process the REST request and record it as a span.\n */\nexport class TracingRouteProcessor implements IBaseRouteProcessor {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<TracingRouteProcessor>();\n\n\t/**\n\t * The key the span is stored under while it is handed between the processor phases.\n\t * @internal\n\t */\n\tprivate static readonly _STATE_KEY: string = \"tracingProcessorSpan\";\n\n\t/**\n\t * The component for recording the spans.\n\t * @internal\n\t */\n\tprivate readonly _tracing?: ITracingComponent;\n\n\t/**\n\t * The component for logging failures.\n\t * @internal\n\t */\n\tprivate readonly _logging?: ILoggingComponent;\n\n\t/**\n\t * Request URL path prefixes to skip tracing, defaults to [\"/tracing\"].\n\t * @internal\n\t */\n\tprivate readonly _excludePaths: string[];\n\n\t/**\n\t * Route operation IDs to skip tracing.\n\t * @internal\n\t */\n\tprivate readonly _excludeOperationIds: string[];\n\n\t/**\n\t * Create a new instance of TracingRouteProcessor.\n\t * @param options Options for the processor.\n\t */\n\tconstructor(options?: ITracingRouteProcessorConstructorOptions) {\n\t\tthis._tracing = ComponentFactory.getIfExists(options?.tracingComponentType);\n\t\tthis._logging = ComponentFactory.getIfExists(options?.loggingComponentType);\n\t\tthis._excludePaths = options?.config?.excludePaths ?? [\"/tracing\"];\n\t\tthis._excludeOperationIds = options?.config?.excludeOperationIds ?? [];\n\t}\n\n\t/**\n\t * Returns the class name of the component.\n\t * @returns The class name of the component.\n\t */\n\tpublic className(): string {\n\t\treturn TracingRouteProcessor.CLASS_NAME;\n\t}\n\n\t/**\n\t * Pre process the REST request for the specified route, opening the span for the request.\n\t * @param request The incoming request.\n\t * @param response The outgoing response.\n\t * @param route The route to process.\n\t * @param contextIds The context IDs of the request.\n\t * @param processorState The state handed through the processors.\n\t * @returns A promise that resolves when the span has been started.\n\t */\n\tpublic async pre(\n\t\trequest: IHttpServerRequest,\n\t\tresponse: IHttpResponse,\n\t\troute: IBaseRoute | undefined,\n\t\tcontextIds: IContextIds,\n\t\tprocessorState: { [id: string]: unknown }\n\t): Promise<void> {\n\t\tif (Is.empty(this._tracing)) {\n\t\t\treturn;\n\t\t}\n\n\t\tif (Is.stringValue(route?.path) && this._excludePaths.includes(route.path)) {\n\t\t\treturn;\n\t\t}\n\t\tif (\n\t\t\tIs.stringValue(route?.operationId) &&\n\t\t\tthis._excludeOperationIds.includes(route.operationId)\n\t\t) {\n\t\t\treturn;\n\t\t}\n\n\t\tconst parentContext = TraceparentHelper.parse(\n\t\t\tCoerce.string(request.headers?.[TraceparentHelper.HEADER_NAME])\n\t\t);\n\n\t\tconst span = await this._tracing.startSpan(this.spanName(request, route), {\n\t\t\tkind: SpanKind.Server,\n\t\t\tparentContext,\n\t\t\tattributes: this.requestAttributes(request, route)\n\t\t});\n\n\t\tprocessorState[TracingRouteProcessor._STATE_KEY] = span;\n\n\t\tObject.assign(contextIds, TracingHelper.spanContextToContextIds(span.context));\n\t}\n\n\t/**\n\t * Post process the REST request for the specified route, ending the span for the request.\n\t * @param request The incoming request.\n\t * @param response The outgoing response.\n\t * @param route The route to process.\n\t * @param contextIds The context IDs of the request.\n\t * @param processorState The state handed through the processors.\n\t * @returns A promise that resolves when the span has been ended.\n\t */\n\tpublic async post(\n\t\trequest: IHttpServerRequest,\n\t\tresponse: IHttpResponse,\n\t\troute: IBaseRoute | undefined,\n\t\tcontextIds: IContextIds,\n\t\tprocessorState: { [id: string]: unknown }\n\t): Promise<void> {\n\t\tconst span = processorState[TracingRouteProcessor._STATE_KEY];\n\n\t\tif (Is.empty(this._tracing) || !Is.object<ISpan>(span)) {\n\t\t\treturn;\n\t\t}\n\n\t\tdelete processorState[TracingRouteProcessor._STATE_KEY];\n\n\t\ttry {\n\t\t\tconst statusCode = Is.number(response.statusCode) ? response.statusCode : HttpStatusCode.ok;\n\n\t\t\tspan.attributes = { ...span.attributes, \"http.status_code\": statusCode };\n\n\t\t\tawait this._tracing.endSpan(\n\t\t\t\tspan,\n\t\t\t\tstatusCode >= HttpStatusCode.badRequest ? SpanStatus.Error : SpanStatus.Ok\n\t\t\t);\n\t\t} catch (err) {\n\t\t\tawait this._logging?.log({\n\t\t\t\tlevel: \"error\",\n\t\t\t\tsource: TracingRouteProcessor.CLASS_NAME,\n\t\t\t\tts: Date.now(),\n\t\t\t\tmessage: \"endSpanFailed\",\n\t\t\t\terror: BaseError.fromError(err)\n\t\t\t});\n\t\t}\n\t}\n\n\t/**\n\t * Build the name for the span.\n\t * @param request The incoming request.\n\t * @param route The route to process.\n\t * @returns The span name.\n\t * @internal\n\t */\n\tprivate spanName(request: IHttpServerRequest, route: IBaseRoute | undefined): string {\n\t\tconst routeName = route?.operationId ?? route?.path;\n\n\t\treturn Is.stringValue(routeName)\n\t\t\t? routeName\n\t\t\t: `${request.method ?? \"UNKNOWN\"} ${TracingRouteProcessor.CLASS_NAME}`;\n\t}\n\n\t/**\n\t * Build the attributes describing the request.\n\t * @param request The incoming request.\n\t * @param route The route to process.\n\t * @returns The attributes.\n\t * @internal\n\t */\n\tprivate requestAttributes(\n\t\trequest: IHttpServerRequest,\n\t\troute: IBaseRoute | undefined\n\t): { [key: string]: unknown } {\n\t\tconst attributes: { [key: string]: unknown } = {};\n\n\t\tif (Is.stringValue(request.method)) {\n\t\t\tattributes[\"http.method\"] = request.method;\n\t\t}\n\t\tif (Is.stringValue(route?.path)) {\n\t\t\tattributes[\"http.route\"] = route.path;\n\t\t}\n\n\t\treturn attributes;\n\t}\n}\n"]}

package/dist/types/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./models/ITracingRestClientProcessorConfig.js";
+export * from "./models/ITracingRestClientProcessorConstructorOptions.js";
+export * from "./models/ITracingRouteProcessorConfig.js";
+export * from "./models/ITracingRouteProcessorConstructorOptions.js";
+export * from "./tracingRestClientProcessor.js";
+export * from "./tracingRouteProcessor.js";

package/dist/types/models/ITracingRestClientProcessorConfig.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Configuration for the tracing REST client processor.
+ */
+export interface ITracingRestClientProcessorConfig {
+    /**
+     * Route templates to skip tracing.
+     */
+    excludePaths?: string[];
+}

package/dist/types/models/ITracingRestClientProcessorConstructorOptions.d.ts

@@ -0,0 +1,15 @@
+import type { ITracingRestClientProcessorConfig } from "./ITracingRestClientProcessorConfig.js";
+/**
+ * Options for the TracingRestClientProcessor constructor.
+ */
+export interface ITracingRestClientProcessorConstructorOptions {
+    /**
+     * The type for the tracing component, when absent no spans are created and no trace header is
+     * sent.
+     */
+    tracingComponentType?: string;
+    /**
+     * Configuration for the processor.
+     */
+    config?: ITracingRestClientProcessorConfig;
+}

package/dist/types/models/ITracingRouteProcessorConfig.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Configuration for the tracing route processor.
+ */
+export interface ITracingRouteProcessorConfig {
+    /**
+     * Request URL path prefixes to skip tracing.
+     */
+    excludePaths?: string[];
+    /**
+     * Route operation IDs to skip tracing.
+     */
+    excludeOperationIds?: string[];
+}

package/dist/types/models/ITracingRouteProcessorConstructorOptions.d.ts

@@ -0,0 +1,18 @@
+import type { ITracingRouteProcessorConfig } from "./ITracingRouteProcessorConfig.js";
+/**
+ * Options for the TracingRouteProcessor constructor.
+ */
+export interface ITracingRouteProcessorConstructorOptions {
+    /**
+     * The type for the tracing component.
+     */
+    tracingComponentType?: string;
+    /**
+     * The type for the logging component.
+     */
+    loggingComponentType?: string;
+    /**
+     * The configuration for the tracing route processor.
+     */
+    config?: ITracingRouteProcessorConfig;
+}

package/dist/types/tracingRestClientProcessor.d.ts

@@ -0,0 +1,29 @@
+import type { IRestClientProcessor, IRestClientProcessorContext } from "@twin.org/api-models";
+import type { ITracingRestClientProcessorConstructorOptions } from "./models/ITracingRestClientProcessorConstructorOptions.js";
+/**
+ * Records a span for each outbound REST request and carries the trace via traceparent header.
+ */
+export declare class TracingRestClientProcessor implements IRestClientProcessor {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of TracingRestClientProcessor.
+     * @param options Options for the processor.
+     */
+    constructor(options?: ITracingRestClientProcessorConstructorOptions);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
+    /**
+     * Wrap the request in a client span, sending the current span as the traceparent so the
+     * receiving service continues this trace.
+     * @param context The details of the request being made.
+     * @param next Performs the request.
+     * @returns The response.
+     */
+    pre(context: IRestClientProcessorContext, next: () => Promise<Response>): Promise<Response>;
+}

package/dist/types/tracingRouteProcessor.d.ts

@@ -0,0 +1,46 @@
+import type { IBaseRoute, IBaseRouteProcessor, IHttpResponse, IHttpServerRequest } from "@twin.org/api-models";
+import type { IContextIds } from "@twin.org/context";
+import type { ITracingRouteProcessorConstructorOptions } from "./models/ITracingRouteProcessorConstructorOptions.js";
+/**
+ * Process the REST request and record it as a span.
+ */
+export declare class TracingRouteProcessor implements IBaseRouteProcessor {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of TracingRouteProcessor.
+     * @param options Options for the processor.
+     */
+    constructor(options?: ITracingRouteProcessorConstructorOptions);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
+    /**
+     * Pre process the REST request for the specified route, opening the span for the request.
+     * @param request The incoming request.
+     * @param response The outgoing response.
+     * @param route The route to process.
+     * @param contextIds The context IDs of the request.
+     * @param processorState The state handed through the processors.
+     * @returns A promise that resolves when the span has been started.
+     */
+    pre(request: IHttpServerRequest, response: IHttpResponse, route: IBaseRoute | undefined, contextIds: IContextIds, processorState: {
+        [id: string]: unknown;
+    }): Promise<void>;
+    /**
+     * Post process the REST request for the specified route, ending the span for the request.
+     * @param request The incoming request.
+     * @param response The outgoing response.
+     * @param route The route to process.
+     * @param contextIds The context IDs of the request.
+     * @param processorState The state handed through the processors.
+     * @returns A promise that resolves when the span has been ended.
+     */
+    post(request: IHttpServerRequest, response: IHttpResponse, route: IBaseRoute | undefined, contextIds: IContextIds, processorState: {
+        [id: string]: unknown;
+    }): Promise<void>;
+}

package/docs/changelog.md

@@ -0,0 +1,17 @@
+# Changelog
+
+## [0.9.2-next.3](https://github.com/iotaledger/twin-tracing/compare/tracing-processors-v0.9.2-next.2...tracing-processors-v0.9.2-next.3) (2026-08-17)
+
+
+### Features
+
+* tracing processors ([#9](https://github.com/iotaledger/twin-tracing/issues/9)) ([e5f5d16](https://github.com/iotaledger/twin-tracing/commit/e5f5d1616992440d067830965372d32fc34a939d))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/tracing-models bumped from 0.9.2-next.2 to 0.9.2-next.3
+
+## Changelog

package/docs/examples.md

@@ -0,0 +1,88 @@
+# Tracing Processors Examples
+
+These two processors trace the HTTP boundary. Together they join the spans of separate services
+into a single trace, via W3C `traceparent` header: the client processor sends the span it
+opens, and the route processor on the receiving side continues from it.
+
+## Tracing inbound requests
+
+`TracingRouteProcessor` records a span for each request the server handles. Register it and add it
+to the route processor types of the server.
+
+```typescript
+import { ComponentFactory } from '@twin.org/core';
+import { TracingRouteProcessor } from '@twin.org/tracing-processors';
+
+ComponentFactory.register(
+  'tracing-route-processor',
+  () => new TracingRouteProcessor({ tracingComponentType: 'tracing' })
+);
+```
+
+The span is named from the route `operationId`, falling back to its path, and carries `http.method`,
+`http.route` and `http.status_code` attributes. A status of 400 or above ends the span with an error
+status.
+
+Without a `tracingComponentType` which resolves, the processor does nothing, so it is safe to
+register unconditionally.
+
+## Continuing a trace from the caller
+
+When the request arrives with a `traceparent` header, the span becomes a child of the caller's span
+and stays in the same trace. A missing or malformed header starts a new trace.
+
+The span ids are written into the request `contextIds`, so anything the handler does through
+`TracingHelper.withSpan` nests underneath the request span automatically.
+
+## Excluding paths
+
+Requests to the tracing API itself are skipped by default, otherwise reading spans would create
+spans. Supply `excludePaths` to change this.
+
+```typescript
+new TracingRouteProcessor({
+  tracingComponentType: 'tracing',
+  config: { excludePaths: ['/tracing', '/health'] }
+});
+```
+
+## Tracing outbound requests
+
+`TracingRestClientProcessor` records a span for each request a REST client makes, and sends the
+`traceparent` header so the service being called continues the same trace.
+
+```typescript
+import { RestClientProcessorFactory } from '@twin.org/api-models';
+import { TracingRestClientProcessor } from '@twin.org/tracing-processors';
+
+RestClientProcessorFactory.register(
+  'tracing-client-processor',
+  () => new TracingRestClientProcessor({ tracingComponentType: 'tracing' })
+);
+```
+
+Then name it in the configuration of any client which should be traced.
+
+```typescript
+const client = new BlobStorageClient({
+  endpoint: 'https://example.com',
+  processorTypes: ['tracing-client-processor']
+});
+```
+
+## Avoiding a loop when the tracing client is itself traced
+
+A REST client which reports spans over HTTP must not be traced, or recording a span would make
+another request, which would record another span. A client is only traced when it names a processor
+type, so leaving `processorTypes` off the tracing client is all that is needed.
+
+## The two ends together
+
+With both processors in place, a request arriving at service A and passed on to service B produces
+one trace with a server span in A, a client span beneath it, and a server span in B beneath that.
+
+```text
+GET /blob                       (A, server)
+└── BlobStorageClient/blob      (A, client)
+    └── blobStorageGet          (B, server)
+```

package/docs/reference/classes/TracingRestClientProcessor.md

@@ -0,0 +1,86 @@
+# Class: TracingRestClientProcessor
+
+Records a span for each outbound REST request and carries the trace via traceparent header.
+
+## Implements
+
+- `IRestClientProcessor`
+
+## Constructors
+
+### Constructor
+
+> **new TracingRestClientProcessor**(`options?`): `TracingRestClientProcessor`
+
+Create a new instance of TracingRestClientProcessor.
+
+#### Parameters
+
+##### options?
+
+[`ITracingRestClientProcessorConstructorOptions`](../interfaces/ITracingRestClientProcessorConstructorOptions.md)
+
+Options for the processor.
+
+#### Returns
+
+`TracingRestClientProcessor`
+
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### className() {#classname}
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IRestClientProcessor.className`
+
+***
+
+### pre() {#pre}
+
+> **pre**(`context`, `next`): `Promise`\<`Response`\>
+
+Wrap the request in a client span, sending the current span as the traceparent so the
+receiving service continues this trace.
+
+#### Parameters
+
+##### context
+
+`IRestClientProcessorContext`
+
+The details of the request being made.
+
+##### next
+
+() => `Promise`\<`Response`\>
+
+Performs the request.
+
+#### Returns
+
+`Promise`\<`Response`\>
+
+The response.
+
+#### Implementation of
+
+`IRestClientProcessor.pre`

package/docs/reference/classes/TracingRouteProcessor.md

@@ -0,0 +1,149 @@
+# Class: TracingRouteProcessor
+
+Process the REST request and record it as a span.
+
+## Implements
+
+- `IBaseRouteProcessor`
+
+## Constructors
+
+### Constructor
+
+> **new TracingRouteProcessor**(`options?`): `TracingRouteProcessor`
+
+Create a new instance of TracingRouteProcessor.
+
+#### Parameters
+
+##### options?
+
+[`ITracingRouteProcessorConstructorOptions`](../interfaces/ITracingRouteProcessorConstructorOptions.md)
+
+Options for the processor.
+
+#### Returns
+
+`TracingRouteProcessor`
+
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### className() {#classname}
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IBaseRouteProcessor.className`
+
+***
+
+### pre() {#pre}
+
+> **pre**(`request`, `response`, `route`, `contextIds`, `processorState`): `Promise`\<`void`\>
+
+Pre process the REST request for the specified route, opening the span for the request.
+
+#### Parameters
+
+##### request
+
+`IHttpServerRequest`
+
+The incoming request.
+
+##### response
+
+`IHttpResponse`
+
+The outgoing response.
+
+##### route
+
+`IBaseRoute` \| `undefined`
+
+The route to process.
+
+##### contextIds
+
+`IContextIds`
+
+The context IDs of the request.
+
+##### processorState
+
+The state handed through the processors.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the span has been started.
+
+#### Implementation of
+
+`IBaseRouteProcessor.pre`
+
+***
+
+### post() {#post}
+
+> **post**(`request`, `response`, `route`, `contextIds`, `processorState`): `Promise`\<`void`\>
+
+Post process the REST request for the specified route, ending the span for the request.
+
+#### Parameters
+
+##### request
+
+`IHttpServerRequest`
+
+The incoming request.
+
+##### response
+
+`IHttpResponse`
+
+The outgoing response.
+
+##### route
+
+`IBaseRoute` \| `undefined`
+
+The route to process.
+
+##### contextIds
+
+`IContextIds`
+
+The context IDs of the request.
+
+##### processorState
+
+The state handed through the processors.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the span has been ended.
+
+#### Implementation of
+
+`IBaseRouteProcessor.post`

package/docs/reference/index.md

@@ -0,0 +1,13 @@
+# @twin.org/tracing-processors
+
+## Classes
+
+- [TracingRestClientProcessor](classes/TracingRestClientProcessor.md)
+- [TracingRouteProcessor](classes/TracingRouteProcessor.md)
+
+## Interfaces
+
+- [ITracingRestClientProcessorConfig](interfaces/ITracingRestClientProcessorConfig.md)
+- [ITracingRestClientProcessorConstructorOptions](interfaces/ITracingRestClientProcessorConstructorOptions.md)
+- [ITracingRouteProcessorConfig](interfaces/ITracingRouteProcessorConfig.md)
+- [ITracingRouteProcessorConstructorOptions](interfaces/ITracingRouteProcessorConstructorOptions.md)

package/docs/reference/interfaces/ITracingRestClientProcessorConfig.md

@@ -0,0 +1,11 @@
+# Interface: ITracingRestClientProcessorConfig
+
+Configuration for the tracing REST client processor.
+
+## Properties
+
+### excludePaths? {#excludepaths}
+
+> `optional` **excludePaths?**: `string`[]
+
+Route templates to skip tracing.

package/docs/reference/interfaces/ITracingRestClientProcessorConstructorOptions.md

@@ -0,0 +1,20 @@
+# Interface: ITracingRestClientProcessorConstructorOptions
+
+Options for the TracingRestClientProcessor constructor.
+
+## Properties
+
+### tracingComponentType? {#tracingcomponenttype}
+
+> `optional` **tracingComponentType?**: `string`
+
+The type for the tracing component, when absent no spans are created and no trace header is
+sent.
+
+***
+
+### config? {#config}
+
+> `optional` **config?**: [`ITracingRestClientProcessorConfig`](ITracingRestClientProcessorConfig.md)
+
+Configuration for the processor.

package/docs/reference/interfaces/ITracingRouteProcessorConfig.md

@@ -0,0 +1,19 @@
+# Interface: ITracingRouteProcessorConfig
+
+Configuration for the tracing route processor.
+
+## Properties
+
+### excludePaths? {#excludepaths}
+
+> `optional` **excludePaths?**: `string`[]
+
+Request URL path prefixes to skip tracing.
+
+***
+
+### excludeOperationIds? {#excludeoperationids}
+
+> `optional` **excludeOperationIds?**: `string`[]
+
+Route operation IDs to skip tracing.

package/docs/reference/interfaces/ITracingRouteProcessorConstructorOptions.md

@@ -0,0 +1,27 @@
+# Interface: ITracingRouteProcessorConstructorOptions
+
+Options for the TracingRouteProcessor constructor.
+
+## Properties
+
+### tracingComponentType? {#tracingcomponenttype}
+
+> `optional` **tracingComponentType?**: `string`
+
+The type for the tracing component.
+
+***
+
+### loggingComponentType? {#loggingcomponenttype}
+
+> `optional` **loggingComponentType?**: `string`
+
+The type for the logging component.
+
+***
+
+### config? {#config}
+
+> `optional` **config?**: [`ITracingRouteProcessorConfig`](ITracingRouteProcessorConfig.md)
+
+The configuration for the tracing route processor.

package/locales/.validate-ignore

@@ -0,0 +1,3 @@
+http.method
+http.route
+http.status_code

package/locales/en.json

@@ -0,0 +1,7 @@
+{
+	"error": {
+		"tracingRouteProcessor": {
+			"endSpanFailed": "The span for the request could not be ended"
+		}
+	}
+}

package/package.json

@@ -0,0 +1,54 @@
+{
+	"name": "@twin.org/tracing-processors",
+	"version": "0.9.2-next.3",
+	"description": "Processors which record spans for inbound and outbound REST requests.",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/iotaledger/twin-tracing.git",
+		"directory": "packages/tracing-processors"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"dependencies": {
+		"@twin.org/api-models": "next",
+		"@twin.org/context": "next",
+		"@twin.org/core": "next",
+		"@twin.org/logging-models": "next",
+		"@twin.org/nameof": "next",
+		"@twin.org/tracing-models": "0.9.2-next.3",
+		"@twin.org/web": "next"
+	},
+	"main": "./dist/es/index.js",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/types/index.d.ts",
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
+		},
+		"./locales/*.json": "./locales/*.json"
+	},
+	"files": [
+		"dist/es",
+		"dist/types",
+		"locales",
+		"docs"
+	],
+	"keywords": [
+		"twin",
+		"iota",
+		"framework",
+		"tracing",
+		"spans",
+		"observability",
+		"processors"
+	],
+	"bugs": {
+		"url": "git+https://github.com/iotaledger/twin-tracing/issues"
+	},
+	"homepage": "https://twindev.org"
+}