@crawlee/otel 4.0.0-beta.156

package/LICENSE.md

@@ -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 2018 Apify Technologies s.r.o.
+
+   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,153 @@
+<h1 align="center">
+    <a href="https://crawlee.dev">
+        <picture>
+          <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/apify/crawlee/master/website/static/img/crawlee-dark.svg?sanitize=true" />
+          <img alt="Crawlee" src="https://raw.githubusercontent.com/apify/crawlee/master/website/static/img/crawlee-light.svg?sanitize=true" width="500" />
+        </picture>
+    </a>
+    <br />
+    <small>A web scraping and browser automation library</small>
+</h1>
+
+<p align="center">
+    <a href="https://trendshift.io/repositories/5179" target="_blank"><img src="https://trendshift.io/api/badge/repositories/5179" alt="apify%2Fcrawlee | Trendshift" width="250" height="55"/></a>
+</p>
+
+<p align="center">
+    <a href="https://www.npmjs.com/package/@crawlee/core" rel="nofollow"><img src="https://img.shields.io/npm/v/@crawlee/core.svg" alt="NPM latest version" data-canonical-src="https://img.shields.io/npm/v/@crawlee/core/next.svg" /></a>
+    <a href="https://www.npmjs.com/package/@crawlee/core" rel="nofollow"><img src="https://img.shields.io/npm/dm/@crawlee/core.svg" alt="Downloads" data-canonical-src="https://img.shields.io/npm/dm/@crawlee/core.svg" /></a>
+    <a href="https://discord.gg/jyEM2PRvMU" rel="nofollow"><img src="https://img.shields.io/discord/801163717915574323?label=discord" alt="Chat on discord" data-canonical-src="https://img.shields.io/discord/801163717915574323?label=discord" /></a>
+    <a href="https://github.com/apify/crawlee/actions/workflows/test-ci.yml"><img src="https://github.com/apify/crawlee/actions/workflows/test-ci.yml/badge.svg?branch=master" alt="Build Status" /></a>
+</p>
+
+Crawlee covers your crawling and scraping end-to-end and **helps you build reliable scrapers. Fast.**
+
+Your crawlers will appear human-like and fly under the radar of modern bot protections even with the default configuration. Crawlee gives you the tools to crawl the web for links, scrape data, and store it to disk or cloud while staying configurable to suit your project's needs.
+
+Crawlee is available as the [`crawlee`](https://www.npmjs.com/package/crawlee) NPM package.
+
+> 👉 **View full documentation, guides and examples on the [Crawlee project website](https://crawlee.dev)** 👈
+
+> Do you prefer 🐍 Python instead of JavaScript? [👉 Checkout Crawlee for Python 👈](https://github.com/apify/crawlee-python).
+
+## Installation
+
+We recommend visiting the [Introduction tutorial](https://crawlee.dev/js/docs/introduction) in Crawlee documentation for more information.
+
+> Crawlee requires **Node.js 16 or higher**.
+
+### With Crawlee CLI
+
+The fastest way to try Crawlee out is to use the **Crawlee CLI** and choose the **Getting started example**. The CLI will install all the necessary dependencies and add boilerplate code for you to play with.
+
+```bash
+npx crawlee create my-crawler
+```
+
+```bash
+cd my-crawler
+npm start
+```
+
+### Manual installation
+If you prefer adding Crawlee **into your own project**, try the example below. Because it uses `PlaywrightCrawler` we also need to install [Playwright](https://playwright.dev). It's not bundled with Crawlee to reduce install size.
+
+```bash
+npm install crawlee playwright
+```
+
+```js
+import { PlaywrightCrawler, Dataset } from 'crawlee';
+
+// PlaywrightCrawler crawls the web using a headless
+// browser controlled by the Playwright library.
+const crawler = new PlaywrightCrawler({
+    // Use the requestHandler to process each of the crawled pages.
+    async requestHandler({ request, page, enqueueLinks, log }) {
+        const title = await page.title();
+        log.info(`Title of ${request.loadedUrl} is '${title}'`);
+
+        // Save results as JSON to ./storage/datasets/default
+        await Dataset.pushData({ title, url: request.loadedUrl });
+
+        // Extract links from the current page
+        // and add them to the crawling queue.
+        await enqueueLinks();
+    },
+    // Uncomment this option to see the browser window.
+    // headless: false,
+});
+
+// Add first URL to the queue and start the crawl.
+await crawler.run(['https://crawlee.dev']);
+```
+
+By default, Crawlee stores data to `./storage` in the current working directory. You can override this directory via Crawlee configuration. For details, see [Configuration guide](https://crawlee.dev/js/docs/guides/configuration), [Request storage](https://crawlee.dev/js/docs/guides/request-storage) and [Result storage](https://crawlee.dev/js/docs/guides/result-storage).
+
+### Installing pre-release versions
+
+We provide automated beta builds for every merged code change in Crawlee. You can find them in the npm [list of releases](https://www.npmjs.com/package/crawlee?activeTab=versions). If you want to test new features or bug fixes before we release them, feel free to install a beta build like this:
+
+```bash
+npm install crawlee@next
+```
+
+If you also use the [Apify SDK](https://github.com/apify/apify-sdk-js), you need to specify dependency overrides in your `package.json` file so that you don't end up with multiple versions of Crawlee installed:
+
+```json
+{
+    "overrides": {
+       "apify": {
+           "@crawlee/core": "$crawlee",
+           "@crawlee/types": "$crawlee",
+           "@crawlee/utils": "$crawlee"
+       }
+    }
+}
+```
+
+## 🛠 Features
+
+- Single interface for **HTTP and headless browser** crawling
+- Persistent **queue** for URLs to crawl (breadth & depth first)
+- Pluggable **storage** of both tabular data and files
+- Automatic **scaling** with available system resources
+- Integrated **proxy rotation** and session management
+- Lifecycles customizable with **hooks**
+- **CLI** to bootstrap your projects
+- Configurable **routing**, **error handling** and **retries**
+- **Dockerfiles** ready to deploy
+- Written in **TypeScript** with generics
+
+### 👾 HTTP crawling
+
+- Zero config **HTTP2 support**, even for proxies
+- Automatic generation of **browser-like headers**
+- Replication of browser **TLS fingerprints**
+- Integrated fast **HTML parsers**. Cheerio and JSDOM
+- Yes, you can scrape **JSON APIs** as well
+
+### 💻 Real browser crawling
+
+- JavaScript **rendering** and **screenshots**
+- **Headless** and **headful** support
+- Zero-config generation of **human-like fingerprints**
+- Automatic **browser management**
+- Use **Playwright** and **Puppeteer** with the same interface
+- **Chrome**, **Firefox**, **Webkit** and many others
+
+## Usage on the Apify platform
+
+Crawlee is open-source and runs anywhere, but since it's developed by [Apify](https://apify.com), it's easy to set up on the Apify platform and run in the cloud. Visit the [Apify SDK website](https://sdk.apify.com) to learn more about deploying Crawlee to the Apify platform.
+
+## Support
+
+If you find any bug or issue with Crawlee, please [submit an issue on GitHub](https://github.com/apify/crawlee/issues). For questions, you can ask on [Stack Overflow](https://stackoverflow.com/questions/tagged/apify), in GitHub Discussions or you can join our [Discord server](https://discord.com/invite/jyEM2PRvMU).
+
+## Contributing
+
+Your code contributions are welcome, and you'll be praised to eternity! If you have any ideas for improvements, either submit an issue or create a pull request. For contribution guidelines and the code of conduct, see [CONTRIBUTING.md](https://github.com/apify/crawlee/blob/master/CONTRIBUTING.md).
+
+## License
+
+This project is licensed under the Apache License 2.0 - see the [LICENSE.md](https://github.com/apify/crawlee/blob/master/LICENSE.md) file for details.

package/constants.d.ts

@@ -0,0 +1,55 @@
+import { SeverityNumber } from '@opentelemetry/api-logs';
+import type { LoggerMethodDefinition } from './internal-types.js';
+import type { ClassMethodToInstrument, CrawleeInstrumentationConfig } from './types.js';
+export declare const PACKAGE_NAME = "@crawlee/otel";
+/** Used when the package version cannot be determined at runtime. */
+export declare const UNKNOWN_PACKAGE_VERSION = "0.0.0";
+/**
+ * Versions of the instrumented Crawlee packages this instrumentation knows how to patch. Methods that are missing
+ * in the resolved version are skipped with a warning instead of breaking the module load.
+ *
+ * Spelled out rather than written as `^4.0.0`, because a caret range never matches a prerelease and every published
+ * Crawlee v4 is one (`4.0.0-beta.x`, `4.0.0-rc.x`). The explicit `-0` bounds admit prereleases of 4.0.0 itself, and
+ * `includePrerelease` on the module definitions extends that to prereleases of later v4 minors.
+ *
+ * `@opentelemetry/instrumentation` only consults this when the loader hands it the module's base directory, which the
+ * ESM hook does not do - so today a wrong range here would not stop anything from being patched. It is still declared
+ * correctly rather than left as documentation: the range is what decides whether a module is patched as soon as a base
+ * directory is available, and being silently skipped is not a failure mode worth leaving armed.
+ */
+export declare const SUPPORTED_CRAWLEE_VERSIONS: string[];
+export declare const baseConfig: CrawleeInstrumentationConfig;
+export declare const requestHandlingInstrumentationMethods: ClassMethodToInstrument[];
+/**
+ * Maps Apify log levels to OpenTelemetry severity numbers.
+ * See https://github.com/apify/apify-shared-js/blob/83d46cf72a338ff671f89dcbc2b0db7dd571e29f/packages/log/src/log_consts.ts#L1
+ *
+ * ```typescript
+ * export enum LogLevel {
+ *      // Turns off logging completely
+ *      OFF = 0,
+ *      // For unexpected errors in Apify system
+ *      ERROR = 1 = SeverityNumber.ERROR,
+ *      // For situations where error is caused by user (e.g. Meteor.Error), i.e. when the error is not
+ *      // caused by Apify system, avoid the word "ERROR" to simplify searching in log
+ *      SOFT_FAIL = 2 = SeverityNumber.WARN,
+ *      WARNING = 3 = SeverityNumber.WARN,
+ *      INFO = 4 = SeverityNumber.INFO,
+ *      DEBUG = 5 = SeverityNumber.DEBUG,
+ *      // for performance stats
+ *      PERF = 6 = SeverityNumber.DEBUG,
+ * }
+ * ```
+ */
+export declare const apifyLogLevelMap: Record<number, SeverityNumber>;
+/** Human readable Apify log level names, emitted as the `severityText` of the forwarded log records. */
+export declare const apifyLogLevelNameMap: Record<number, string>;
+/**
+ * The logging methods to instrument, with the level each logs at.
+ *
+ * These live on `BaseCrawleeLogger.prototype`, which every Crawlee logger derives from, so patching them forwards logs
+ * from any logger implementation - the default Apify one as well as a Winston, Pino or hand-written adapter. Each of
+ * them dispatches straight to the abstract `logWithLevel`, which the adapter implements, so a call is only seen once.
+ * `warningOnce` and `deprecated` are covered through `warning`.
+ */
+export declare const loggerMethods: LoggerMethodDefinition[];

package/constants.js

@@ -0,0 +1,198 @@
+import { SpanKind } from '@opentelemetry/api';
+import { SeverityNumber } from '@opentelemetry/api-logs';
+import { ATTR_HTTP_REQUEST_METHOD, ATTR_URL_FULL } from '@opentelemetry/semantic-conventions';
+export const PACKAGE_NAME = '@crawlee/otel';
+/** Used when the package version cannot be determined at runtime. */
+export const UNKNOWN_PACKAGE_VERSION = '0.0.0';
+/**
+ * Versions of the instrumented Crawlee packages this instrumentation knows how to patch. Methods that are missing
+ * in the resolved version are skipped with a warning instead of breaking the module load.
+ *
+ * Spelled out rather than written as `^4.0.0`, because a caret range never matches a prerelease and every published
+ * Crawlee v4 is one (`4.0.0-beta.x`, `4.0.0-rc.x`). The explicit `-0` bounds admit prereleases of 4.0.0 itself, and
+ * `includePrerelease` on the module definitions extends that to prereleases of later v4 minors.
+ *
+ * `@opentelemetry/instrumentation` only consults this when the loader hands it the module's base directory, which the
+ * ESM hook does not do - so today a wrong range here would not stop anything from being patched. It is still declared
+ * correctly rather than left as documentation: the range is what decides whether a module is patched as soon as a base
+ * directory is available, and being silently skipped is not a failure mode worth leaving armed.
+ */
+export const SUPPORTED_CRAWLEE_VERSIONS = ['>=4.0.0-0 <5.0.0-0'];
+export const baseConfig = {
+    enabled: true,
+    requestHandlingInstrumentation: true,
+    logInstrumentation: true,
+    customInstrumentation: [],
+};
+/**
+ * Extracts span attributes from a Crawlee crawling context. Uses the stable OpenTelemetry semantic conventions where
+ * they exist, so that traces stay comparable with other instrumented HTTP clients.
+ */
+function requestAttributes(crawlingContext) {
+    const request = crawlingContext?.request;
+    // The context shape depends on the installed Crawlee version, so never assume the request is there.
+    if (!request) {
+        return {};
+    }
+    return {
+        'crawlee.request.id': request.id,
+        [ATTR_URL_FULL]: request.url,
+        [ATTR_HTTP_REQUEST_METHOD]: request.method,
+        'crawlee.request.retry_count': request.retryCount,
+    };
+}
+export const requestHandlingInstrumentationMethods = [
+    {
+        moduleName: '@crawlee/basic',
+        className: 'BasicCrawler',
+        methodName: 'run',
+        spanName: 'crawlee.crawler.run',
+        spanOptions() {
+            return {
+                attributes: {
+                    'crawlee.crawler.type': this.constructor.name,
+                },
+            };
+        },
+    },
+    {
+        moduleName: '@crawlee/basic',
+        className: 'BasicCrawler',
+        methodName: 'handleRequest',
+        spanName: 'crawlee.crawler.handleRequest',
+        // `handleRequest(crawlingContext, requestSource, request)`
+        spanOptions(crawlingContext) {
+            return { attributes: requestAttributes(crawlingContext) };
+        },
+    },
+    {
+        moduleName: '@crawlee/basic',
+        className: 'BasicCrawler',
+        methodName: 'runRequestHandler',
+        spanName: 'crawlee.crawler.runRequestHandler',
+        spanOptions(crawlingContext) {
+            return { attributes: requestAttributes(crawlingContext) };
+        },
+    },
+    {
+        // `AdaptivePlaywrightCrawler` replaces `runRequestHandler` outright instead of calling `super`, so the
+        // `BasicCrawler` patch above never fires for it. `BrowserCrawler` does call `super`, which is why it needs
+        // no entry of its own.
+        moduleName: '@crawlee/playwright',
+        className: 'AdaptivePlaywrightCrawler',
+        methodName: 'runRequestHandler',
+        spanName: 'crawlee.crawler.runRequestHandler',
+        spanOptions(crawlingContext) {
+            return { attributes: requestAttributes(crawlingContext) };
+        },
+    },
+    {
+        moduleName: '@crawlee/basic',
+        className: 'BasicCrawler',
+        methodName: 'requestFunctionErrorHandler',
+        spanName: 'crawlee.crawler.requestFunctionErrorHandler',
+        // `requestFunctionErrorHandler(error, crawlingContext, request, source)`
+        spanOptions(_error, crawlingContext) {
+            return { attributes: requestAttributes(crawlingContext) };
+        },
+    },
+    {
+        moduleName: '@crawlee/basic',
+        className: 'BasicCrawler',
+        methodName: 'handleFailedRequestHandler',
+        spanName: 'crawlee.crawler.handleFailedRequestHandler',
+        spanOptions(crawlingContext) {
+            return { attributes: requestAttributes(crawlingContext) };
+        },
+    },
+    {
+        moduleName: '@crawlee/http',
+        className: 'HttpCrawler',
+        methodName: 'makeHttpRequest',
+        spanName: 'crawlee.http.makeHttpRequest',
+        spanOptions(crawlingContext) {
+            // An outbound HTTP call, so a client span rather than the default internal one.
+            return { kind: SpanKind.CLIENT, attributes: requestAttributes(crawlingContext) };
+        },
+    },
+    {
+        moduleName: '@crawlee/browser',
+        className: 'BrowserCrawler',
+        methodName: 'navigate',
+        spanName: 'crawlee.browser.navigate',
+        spanOptions(crawlingContext) {
+            // The browser navigation is the outbound call here.
+            return { kind: SpanKind.CLIENT, attributes: requestAttributes(crawlingContext) };
+        },
+    },
+];
+/**
+ * Maps Apify log levels to OpenTelemetry severity numbers.
+ * See https://github.com/apify/apify-shared-js/blob/83d46cf72a338ff671f89dcbc2b0db7dd571e29f/packages/log/src/log_consts.ts#L1
+ *
+ * ```typescript
+ * export enum LogLevel {
+ *      // Turns off logging completely
+ *      OFF = 0,
+ *      // For unexpected errors in Apify system
+ *      ERROR = 1 = SeverityNumber.ERROR,
+ *      // For situations where error is caused by user (e.g. Meteor.Error), i.e. when the error is not
+ *      // caused by Apify system, avoid the word "ERROR" to simplify searching in log
+ *      SOFT_FAIL = 2 = SeverityNumber.WARN,
+ *      WARNING = 3 = SeverityNumber.WARN,
+ *      INFO = 4 = SeverityNumber.INFO,
+ *      DEBUG = 5 = SeverityNumber.DEBUG,
+ *      // for performance stats
+ *      PERF = 6 = SeverityNumber.DEBUG,
+ * }
+ * ```
+ */
+export const apifyLogLevelMap = {
+    1: SeverityNumber.ERROR,
+    2: SeverityNumber.WARN,
+    3: SeverityNumber.WARN,
+    4: SeverityNumber.INFO,
+    5: SeverityNumber.DEBUG,
+    6: SeverityNumber.DEBUG,
+};
+/** Human readable Apify log level names, emitted as the `severityText` of the forwarded log records. */
+export const apifyLogLevelNameMap = {
+    1: 'ERROR',
+    2: 'SOFT_FAIL',
+    3: 'WARNING',
+    4: 'INFO',
+    5: 'DEBUG',
+    6: 'PERF',
+};
+/**
+ * The logging methods to instrument, with the level each logs at.
+ *
+ * These live on `BaseCrawleeLogger.prototype`, which every Crawlee logger derives from, so patching them forwards logs
+ * from any logger implementation - the default Apify one as well as a Winston, Pino or hand-written adapter. Each of
+ * them dispatches straight to the abstract `logWithLevel`, which the adapter implements, so a call is only seen once.
+ * `warningOnce` and `deprecated` are covered through `warning`.
+ */
+export const loggerMethods = [
+    { methodName: 'error', level: 1, read: (args) => readMessageAndData(args) },
+    {
+        methodName: 'exception',
+        level: 1,
+        // `exception(exception, message, data)` - the error comes first.
+        read: (args) => ({
+            message: String(args[1] ?? ''),
+            data: { ...args[2], exception: args[0] },
+        }),
+    },
+    { methodName: 'softFail', level: 2, read: (args) => readMessageAndData(args) },
+    { methodName: 'warning', level: 3, read: (args) => readMessageAndData(args) },
+    { methodName: 'info', level: 4, read: (args) => readMessageAndData(args) },
+    { methodName: 'debug', level: 5, read: (args) => readMessageAndData(args) },
+    { methodName: 'perf', level: 6, read: (args) => readMessageAndData(args) },
+];
+/** The shape shared by every logging method except `exception`: `(message, data?)`. */
+function readMessageAndData(args) {
+    return {
+        message: String(args[0] ?? ''),
+        data: args[1],
+    };
+}

package/index.d.ts

@@ -0,0 +1,3 @@
+export { CrawleeInstrumentation } from './instrumentation.js';
+export type * from './types.js';
+export { wrapWithSpan } from './wrapWithSpan.js';

package/index.js

@@ -0,0 +1,2 @@
+export { CrawleeInstrumentation } from './instrumentation.js';
+export { wrapWithSpan } from './wrapWithSpan.js';

package/instrumentation.d.ts

@@ -0,0 +1,37 @@
+import type { TracerProvider } from '@opentelemetry/api';
+import type { InstrumentationModuleDefinition } from '@opentelemetry/instrumentation';
+import { InstrumentationBase } from '@opentelemetry/instrumentation';
+import type { CrawleeInstrumentationConfig } from './types.js';
+export declare class CrawleeInstrumentation extends InstrumentationBase<CrawleeInstrumentationConfig> {
+    constructor(config?: CrawleeInstrumentationConfig);
+    /**
+     * Shares the tracer with the exported `wrapWithSpan` helper, so that manually wrapped handlers end up in the same
+     * instrumentation scope as the automatic spans.
+     *
+     * This has to happen here rather than in the constructor. The constructor can only reach the tracer of the global
+     * API, and that is not necessarily the one this instrumentation ends up using - a `tracerProvider` passed to
+     * `registerInstrumentations` is never registered globally, and a duplicated `@opentelemetry/api` in the dependency
+     * tree has its own global. Handing over a tracer from the wrong provider silences every span, including the
+     * automatic ones, and because it is not `undefined` it also shadows the fallback in `wrapWithSpan`.
+     */
+    setTracerProvider(tracerProvider: TracerProvider): void;
+    protected init(): InstrumentationModuleDefinition[];
+    private instantiateModuleDefinitions;
+    /**
+     * Resolves the prototype holding the method to patch, warning instead of throwing when the class or the method
+     * is not there - a missing internal method must not break loading of the instrumented module.
+     */
+    private getPrototype;
+    /** Mirrors {@link getPrototype}: only methods that were actually patched are restored. */
+    private unwrapIfWrapped;
+    private applyClassMethodPatch;
+    private getLogPatch;
+    /**
+     * Emits one Crawlee log call as an OpenTelemetry log record.
+     *
+     * Everything here - reading the arguments, stringifying the message, handing the record to the SDK - runs inside
+     * the application's own call to `log.info()` and friends, so a failure anywhere in it is reported and dropped
+     * rather than raised.
+     */
+    private forwardLogRecord;
+}

package/instrumentation.js

@@ -0,0 +1,167 @@
+import { SeverityNumber } from '@opentelemetry/api-logs';
+import { InstrumentationBase, InstrumentationNodeModuleDefinition, isWrapped } from '@opentelemetry/instrumentation';
+import { ATTR_CODE_FUNCTION_NAME } from '@opentelemetry/semantic-conventions';
+import { apifyLogLevelMap, apifyLogLevelNameMap, baseConfig, loggerMethods, PACKAGE_NAME, requestHandlingInstrumentationMethods, SUPPORTED_CRAWLEE_VERSIONS, } from './constants.js';
+import { buildLogAttributes, buildModuleDefinitions, getPackageVersion } from './utilities.js';
+import { resolveSpanName, resolveSpanOptions, setSharedTracer, wrapWithSpan } from './wrapWithSpan.js';
+/**
+ * Builds a module definition for one of the instrumented Crawlee packages.
+ *
+ * `InstrumentationNodeModuleDefinition` does not take `includePrerelease` through its constructor, but
+ * `InstrumentationBase` reads it off the definition when it decides whether to patch a resolved module version, so it
+ * is set here. Without it, {@link SUPPORTED_CRAWLEE_VERSIONS} would only cover prereleases of `4.0.0` and every
+ * `4.x.0-beta` would go uninstrumented.
+ */
+function crawleeModuleDefinition(moduleName, patch, unpatch) {
+    const definition = new InstrumentationNodeModuleDefinition(moduleName, SUPPORTED_CRAWLEE_VERSIONS, patch, unpatch);
+    definition.includePrerelease = true;
+    return definition;
+}
+export class CrawleeInstrumentation extends InstrumentationBase {
+    constructor(config = {}) {
+        // Each flag is resolved on its own rather than by spreading `config` over `baseConfig`: a spread lets an
+        // explicit `undefined` - which is what `{ logInstrumentation: options.logs }` produces when `options.logs`
+        // is not set - overwrite the default with nothing and quietly disable the feature.
+        super(PACKAGE_NAME, getPackageVersion(), {
+            ...config,
+            enabled: config.enabled ?? baseConfig.enabled,
+            requestHandlingInstrumentation: config.requestHandlingInstrumentation ?? baseConfig.requestHandlingInstrumentation,
+            logInstrumentation: config.logInstrumentation ?? baseConfig.logInstrumentation,
+            customInstrumentation: config.customInstrumentation ?? baseConfig.customInstrumentation,
+        });
+    }
+    /**
+     * Shares the tracer with the exported `wrapWithSpan` helper, so that manually wrapped handlers end up in the same
+     * instrumentation scope as the automatic spans.
+     *
+     * This has to happen here rather than in the constructor. The constructor can only reach the tracer of the global
+     * API, and that is not necessarily the one this instrumentation ends up using - a `tracerProvider` passed to
+     * `registerInstrumentations` is never registered globally, and a duplicated `@opentelemetry/api` in the dependency
+     * tree has its own global. Handing over a tracer from the wrong provider silences every span, including the
+     * automatic ones, and because it is not `undefined` it also shadows the fallback in `wrapWithSpan`.
+     */
+    setTracerProvider(tracerProvider) {
+        super.setTracerProvider(tracerProvider);
+        setSharedTracer(this.tracer);
+    }
+    init() {
+        const methodsToInstrument = [...(this.getConfig().customInstrumentation ?? [])];
+        if (this.getConfig().requestHandlingInstrumentation) {
+            methodsToInstrument.push(...requestHandlingInstrumentationMethods);
+        }
+        const moduleDefinitions = buildModuleDefinitions(methodsToInstrument);
+        const definitions = this.instantiateModuleDefinitions(moduleDefinitions);
+        if (this.getConfig().logInstrumentation) {
+            definitions.push(crawleeModuleDefinition('@crawlee/core', (moduleExports) => {
+                for (const method of loggerMethods) {
+                    const prototype = this.getPrototype(moduleExports, '@crawlee/core', 'BaseCrawleeLogger', method.methodName);
+                    if (prototype) {
+                        this._wrap(prototype, method.methodName, this.getLogPatch(method));
+                    }
+                }
+                return moduleExports;
+            }, (moduleExports) => {
+                for (const method of loggerMethods) {
+                    this.unwrapIfWrapped(moduleExports?.BaseCrawleeLogger?.prototype, method.methodName);
+                }
+                return moduleExports;
+            }));
+        }
+        return definitions;
+    }
+    instantiateModuleDefinitions(moduleDefinitions) {
+        return moduleDefinitions.map((definition) => {
+            return crawleeModuleDefinition(definition.moduleName, (moduleExports) => {
+                for (const patch of definition.classMethodPatches) {
+                    const prototype = this.getPrototype(moduleExports, definition.moduleName, patch.className, patch.methodName);
+                    if (prototype) {
+                        this._wrap(prototype, patch.methodName, this.applyClassMethodPatch(patch));
+                    }
+                }
+                return moduleExports;
+            }, (moduleExports) => {
+                for (const patch of definition.classMethodPatches) {
+                    this.unwrapIfWrapped(moduleExports?.[patch.className]?.prototype, patch.methodName);
+                }
+                return moduleExports;
+            });
+        });
+    }
+    /**
+     * Resolves the prototype holding the method to patch, warning instead of throwing when the class or the method
+     * is not there - a missing internal method must not break loading of the instrumented module.
+     */
+    getPrototype(moduleExports, moduleName, className, methodName) {
+        const prototype = moduleExports?.[className]?.prototype;
+        if (typeof prototype?.[methodName] !== 'function') {
+            this._diag.warn(`Skipping instrumentation of ${moduleName}: ${className}.${methodName} was not found. ` +
+                `The installed version of ${moduleName} is probably not supported by ${PACKAGE_NAME}.`);
+            return undefined;
+        }
+        return prototype;
+    }
+    /** Mirrors {@link getPrototype}: only methods that were actually patched are restored. */
+    unwrapIfWrapped(prototype, methodName) {
+        if (prototype && isWrapped(prototype[methodName])) {
+            this._unwrap(prototype, methodName);
+        }
+    }
+    applyClassMethodPatch(patch) {
+        const { spanName, spanOptions } = patch;
+        const qualifiedName = `${patch.className}.${patch.methodName}`;
+        const codeAttributes = { [ATTR_CODE_FUNCTION_NAME]: qualifiedName };
+        // Both options are resolved through the guarded helpers, so that a throwing callback costs only what the
+        // caller supplied - the span itself, its name and the attributes added here all survive.
+        return function wrap(original) {
+            return wrapWithSpan(original, {
+                spanName(...args) {
+                    return resolveSpanName(spanName, qualifiedName, this, args);
+                },
+                spanOptions(...args) {
+                    const resolved = resolveSpanOptions(spanOptions, this, args);
+                    return { ...resolved, attributes: { ...codeAttributes, ...resolved.attributes } };
+                },
+            });
+        };
+    }
+    getLogPatch(method) {
+        // oxlint-disable-next-line no-this-alias
+        const instrumentation = this;
+        return function wrapLog(original) {
+            return function wrappedLog(...args) {
+                // The application's own logging runs first and its outcome is never affected by the forwarding,
+                // which matters most where Crawlee logs from inside a `catch` - `handleFailedRequestHandler`.
+                // These methods are synchronous and return void, so keep them that way.
+                try {
+                    original.apply(this, args);
+                }
+                finally {
+                    instrumentation.forwardLogRecord(method, args);
+                }
+            };
+        };
+    }
+    /**
+     * Emits one Crawlee log call as an OpenTelemetry log record.
+     *
+     * Everything here - reading the arguments, stringifying the message, handing the record to the SDK - runs inside
+     * the application's own call to `log.info()` and friends, so a failure anywhere in it is reported and dropped
+     * rather than raised.
+     */
+    forwardLogRecord(method, args) {
+        try {
+            const { message, data } = method.read(args);
+            // Crawlee leaves level filtering to the logging library, so everything is forwarded and the
+            // OpenTelemetry pipeline decides what to keep.
+            this.logger.emit({
+                severityNumber: apifyLogLevelMap[method.level] ?? SeverityNumber.UNSPECIFIED,
+                severityText: apifyLogLevelNameMap[method.level],
+                body: message,
+                attributes: buildLogAttributes(data),
+            });
+        }
+        catch (err) {
+            this._diag.warn(`Failed to forward a Crawlee log record to OpenTelemetry: ${err}`);
+        }
+    }
+}

package/internal-types.d.ts

@@ -0,0 +1,39 @@
+import type { ClassMethodToInstrument } from './types.js';
+/** The patches of one instrumented module, as produced by {@link buildModuleDefinitions}. */
+export interface ModuleDefinition {
+    moduleName: string;
+    classMethodPatches: ClassMethodPatchDefinition[];
+}
+/**
+ * A {@link ClassMethodToInstrument} that has already been grouped under its module, so the module name would be
+ * redundant. Derived from the public type rather than restated, so the fields and their documentation have one home.
+ */
+export type ClassMethodPatchDefinition = Omit<ClassMethodToInstrument, 'moduleName'>;
+/**
+ * The fields of a Crawlee `Request` this instrumentation reads.
+ *
+ * Deliberately structural rather than imported from `@crawlee/core`: the instrumented Crawlee version is resolved at
+ * runtime and may not be the one this package was compiled against, so every field is treated as optional.
+ */
+export interface RequestLike {
+    id?: string;
+    url?: string;
+    method?: string;
+    retryCount?: number;
+}
+/** The part of a Crawlee crawling context this instrumentation reads. */
+export interface CrawlingContextLike {
+    request?: RequestLike;
+}
+/** One of the logging methods `BaseCrawleeLogger` provides, and how to read a log record out of a call to it. */
+export interface LoggerMethodDefinition {
+    /** The method on `BaseCrawleeLogger.prototype` to patch. */
+    methodName: string;
+    /** The Crawlee log level this method logs at. */
+    level: number;
+    /** Pulls the message and the structured data out of the call arguments, which differ per method. */
+    read: (args: unknown[]) => {
+        message: string;
+        data?: Record<string, unknown>;
+    };
+}

package/internal-types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@crawlee/otel",
+  "version": "4.0.0-beta.156",
+  "description": "OpenTelemetry instrumentation for Crawlee",
+  "engines": {
+    "node": ">=22.0.0"
+  },
+  "type": "module",
+  "exports": {
+    ".": "./index.js",
+    "./package.json": "./package.json"
+  },
+  "keywords": [
+    "apify",
+    "api",
+    "otel",
+    "opentelemetry"
+  ],
+  "author": {
+    "name": "Apify",
+    "email": "support@apify.com",
+    "url": "https://apify.com"
+  },
+  "contributors": [],
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/apify/crawlee"
+  },
+  "bugs": {
+    "url": "https://github.com/apify/crawlee/issues"
+  },
+  "homepage": "https://crawlee.dev",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@opentelemetry/instrumentation": "^0.210.0",
+    "@opentelemetry/semantic-conventions": "^1.39.0"
+  },
+  "peerDependencies": {
+    "@opentelemetry/api": "^1.3.0",
+    "@opentelemetry/api-logs": "^0.210.0"
+  },
+  "devDependencies": {
+    "@opentelemetry/api": "^1.9.0",
+    "@opentelemetry/api-logs": "^0.210.0",
+    "semver": "^7.7.0"
+  },
+  "scripts": {
+    "build": "pnpm clean && pnpm compile && pnpm copy",
+    "clean": "rimraf ./dist",
+    "compile": "tsc -p tsconfig.build.json",
+    "copy": "tsx ../../scripts/copy.ts"
+  }
+}

package/types.d.ts

@@ -0,0 +1,25 @@
+import type { SpanOptions } from '@opentelemetry/api';
+import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
+export interface CrawleeInstrumentationConfig extends InstrumentationConfig {
+    requestHandlingInstrumentation?: boolean;
+    logInstrumentation?: boolean;
+    customInstrumentation?: ClassMethodToInstrument[];
+}
+/** One class method to wrap in a span, and the module that has to be loaded for it to exist. */
+export interface ClassMethodToInstrument {
+    /** The Crawlee package the class is exported from, for example `@crawlee/basic`. */
+    moduleName: string;
+    /** The class name to patch. */
+    className: string;
+    /** The method name to patch. */
+    methodName: string;
+    /**
+     * The name of the span. Defaults to `className.methodName`.
+     *
+     * When given a function, it is called with the arguments of the patched method, and `this` is the instance the
+     * method was called on. The arguments are `any` because they are whatever the patched method receives.
+     */
+    spanName?: string | ((this: any, ...args: any[]) => string);
+    /** The attributes of the span. Follows the same calling convention as {@link ClassMethodToInstrument.spanName}. */
+    spanOptions?: SpanOptions | ((this: any, ...args: any[]) => SpanOptions);
+}

package/types.js

@@ -0,0 +1 @@
+export {};

package/utilities.d.ts

@@ -0,0 +1,18 @@
+import type { LogAttributes } from '@opentelemetry/api-logs';
+import type { ModuleDefinition } from './internal-types.js';
+import type { ClassMethodToInstrument } from './types.js';
+export declare function getPackageVersion(): string;
+/**
+ * Turns the structured `data` of a Crawlee log call into OpenTelemetry log attributes.
+ *
+ * Crawlee folds a logged error into `data`, so any `Error` value found there is mapped onto the semantic convention
+ * attributes - its own properties are not enumerable and would otherwise be dropped.
+ */
+export declare function buildLogAttributes(data?: unknown): LogAttributes;
+/**
+ * Groups the methods to instrument by the module that owns them, dropping duplicates.
+ *
+ * The first definition of a method wins. `CrawleeInstrumentation` passes `customInstrumentation` ahead of the built-in
+ * list, so configuring a method that is already instrumented overrides the built-in span rather than being ignored.
+ */
+export declare function buildModuleDefinitions(methodsToInstrument: ClassMethodToInstrument[]): ModuleDefinition[];

package/utilities.js

@@ -0,0 +1,88 @@
+import { readFileSync } from 'node:fs';
+import { createRequire } from 'node:module';
+import { diag } from '@opentelemetry/api';
+import { ATTR_EXCEPTION_MESSAGE, ATTR_EXCEPTION_STACKTRACE, ATTR_EXCEPTION_TYPE, } from '@opentelemetry/semantic-conventions';
+import { PACKAGE_NAME, UNKNOWN_PACKAGE_VERSION } from './constants.js';
+let packageFile;
+function getPackageJson() {
+    if (!packageFile) {
+        try {
+            // The package is ESM, so `require` has to be recreated from the module URL.
+            const packageFilePath = createRequire(import.meta.url).resolve(`${PACKAGE_NAME}/package.json`);
+            packageFile = JSON.parse(readFileSync(packageFilePath, 'utf8'));
+        }
+        catch (err) {
+            // The version is only reported as the instrumentation scope version, so a failure here must not be fatal.
+            diag.warn(`Could not determine the ${PACKAGE_NAME} version: ${err}`);
+            packageFile = { version: UNKNOWN_PACKAGE_VERSION };
+        }
+    }
+    return packageFile;
+}
+export function getPackageVersion() {
+    return getPackageJson().version;
+}
+/**
+ * Turns the structured `data` of a Crawlee log call into OpenTelemetry log attributes.
+ *
+ * Crawlee folds a logged error into `data`, so any `Error` value found there is mapped onto the semantic convention
+ * attributes - its own properties are not enumerable and would otherwise be dropped.
+ */
+export function buildLogAttributes(data) {
+    const attributes = {};
+    if (typeof data !== 'object' || data === null || Array.isArray(data)) {
+        if (data !== undefined) {
+            attributes['crawlee.log.data'] = String(data);
+        }
+        return attributes;
+    }
+    for (const [key, value] of Object.entries(data)) {
+        if (value instanceof Error) {
+            attributes[ATTR_EXCEPTION_TYPE] = value.name;
+            attributes[ATTR_EXCEPTION_MESSAGE] = value.message;
+            if (value.stack) {
+                attributes[ATTR_EXCEPTION_STACKTRACE] = value.stack;
+            }
+        }
+        else {
+            attributes[key] = value;
+        }
+    }
+    return attributes;
+}
+/**
+ * Groups the methods to instrument by the module that owns them, dropping duplicates.
+ *
+ * The first definition of a method wins. `CrawleeInstrumentation` passes `customInstrumentation` ahead of the built-in
+ * list, so configuring a method that is already instrumented overrides the built-in span rather than being ignored.
+ */
+export function buildModuleDefinitions(methodsToInstrument) {
+    const definitions = [];
+    for (const method of methodsToInstrument) {
+        let definition = definitions.find((d) => d.moduleName === method.moduleName);
+        if (!definition) {
+            if (!method.moduleName.startsWith('@crawlee/')) {
+                diag.warn(`Module ${method.moduleName} is not a valid Crawlee module. Skipping.`);
+                continue;
+            }
+            definition = {
+                moduleName: method.moduleName,
+                classMethodPatches: [],
+            };
+            definitions.push(definition);
+        }
+        if (!definition.classMethodPatches.find((p) => p.className === method.className && p.methodName === method.methodName)) {
+            definition.classMethodPatches.push({
+                className: method.className,
+                methodName: method.methodName,
+                spanName: method.spanName,
+                spanOptions: method.spanOptions,
+            });
+        }
+        else {
+            diag.warn(`Method ${method.className}.${method.methodName} is instrumented more than once. Keeping the first ` +
+                `definition, which is the \`customInstrumentation\` entry when one exists for the method.`);
+        }
+    }
+    return definitions;
+}

package/wrapWithSpan.d.ts

@@ -0,0 +1,33 @@
+import type { SpanOptions, Tracer } from '@opentelemetry/api';
+/**
+ * Points the exported {@link wrapWithSpan} at a tracer, or back at the global API when passed `undefined`.
+ *
+ * @internal
+ */
+export declare function setSharedTracer(tracer: Tracer | undefined): void;
+/**
+ * Wraps a function with OpenTelemetry span instrumentation.
+ *
+ * `Args` and `Return` are separate generics so that the argument types flow through to the `spanName` and `spanOptions`
+ * callbacks. They are inferred from the wrapped function, so annotate its parameters when assigning the result to an
+ * option whose type is a union - `requestHandler` accepts both a router and a plain handler, and TypeScript cannot
+ * infer parameter types through a union of function types:
+ *
+ * ```ts
+ * requestHandler: wrapWithSpan(async ({ request }: CheerioCrawlingContext) => { ... })
+ * ```
+ *
+ * Synchronous functions stay synchronous, asynchronous ones keep their span open until the returned promise settles.
+ *
+ * The wrapper forwards its own `this` to the wrapped function, so a method keeps working when wrapped. An arrow
+ * function still ignores it, as arrow functions always take `this` from where they were defined.
+ */
+export declare function wrapWithSpan<Args extends unknown[], Return>(fn: (...args: Args) => Return, options?: {
+    spanName?: string | ((...args: Args) => string);
+    spanOptions?: SpanOptions | ((...args: Args) => SpanOptions);
+    tracer?: Tracer;
+}): (...args: Args) => Return;
+/** @internal Shared with `CrawleeInstrumentation`, which supplies a class qualified default. */
+export declare function resolveSpanName<Args extends unknown[]>(spanName: string | ((...args: Args) => string) | undefined, fallback: string, thisArg: unknown, args: Args): string;
+/** @internal Shared with `CrawleeInstrumentation`, which merges its own attributes into the resolved options. */
+export declare function resolveSpanOptions<Args extends unknown[]>(spanOptions: SpanOptions | ((...args: Args) => SpanOptions) | undefined, thisArg: unknown, args: Args): SpanOptions;

package/wrapWithSpan.js

@@ -0,0 +1,111 @@
+import { diag, SpanStatusCode, trace } from '@opentelemetry/api';
+import { PACKAGE_NAME } from './constants.js';
+import { getPackageVersion } from './utilities.js';
+/**
+ * The tracer `CrawleeInstrumentation` hands over once it knows which provider it ended up with, so that manually
+ * wrapped handlers share the instrumentation scope of the automatic spans.
+ *
+ * Module level state, because `wrapWithSpan` is called from user code that holds no reference to the instrumentation.
+ */
+let sharedTracer;
+/**
+ * Points the exported {@link wrapWithSpan} at a tracer, or back at the global API when passed `undefined`.
+ *
+ * @internal
+ */
+export function setSharedTracer(tracer) {
+    sharedTracer = tracer;
+}
+/**
+ * Wraps a function with OpenTelemetry span instrumentation.
+ *
+ * `Args` and `Return` are separate generics so that the argument types flow through to the `spanName` and `spanOptions`
+ * callbacks. They are inferred from the wrapped function, so annotate its parameters when assigning the result to an
+ * option whose type is a union - `requestHandler` accepts both a router and a plain handler, and TypeScript cannot
+ * infer parameter types through a union of function types:
+ *
+ * ```ts
+ * requestHandler: wrapWithSpan(async ({ request }: CheerioCrawlingContext) => { ... })
+ * ```
+ *
+ * Synchronous functions stay synchronous, asynchronous ones keep their span open until the returned promise settles.
+ *
+ * The wrapper forwards its own `this` to the wrapped function, so a method keeps working when wrapped. An arrow
+ * function still ignores it, as arrow functions always take `this` from where they were defined.
+ */
+export function wrapWithSpan(fn, options) {
+    return function (...args) {
+        // Resolving the tracer lazily lets `CrawleeInstrumentation` hand over its tracer at any point. When no
+        // instrumentation is registered, we fall back to the global API, which returns a tracer that either
+        // delegates to the globally registered provider or is a no-op - so wrapping never fails on its own.
+        const tracer = options?.tracer ?? sharedTracer ?? trace.getTracer(PACKAGE_NAME, getPackageVersion());
+        const spanName = resolveSpanName(options?.spanName, fn.name || 'anonymous', this, args);
+        const spanOptions = resolveSpanOptions(options?.spanOptions, this, args);
+        return tracer.startActiveSpan(spanName, spanOptions, (span) => {
+            let result;
+            try {
+                result = fn.apply(this, args);
+            }
+            catch (err) {
+                recordError(span, err);
+                span.end();
+                throw err;
+            }
+            // Only defer ending the span when the wrapped function is actually asynchronous, so that wrapping
+            // a synchronous function does not silently turn it into a promise-returning one.
+            if (!isPromiseLike(result)) {
+                span.end();
+                return result;
+            }
+            return Promise.resolve(result).then((value) => {
+                span.end();
+                return value;
+            }, (err) => {
+                recordError(span, err);
+                span.end();
+                throw err;
+            });
+        });
+    };
+}
+/** @internal Shared with `CrawleeInstrumentation`, which supplies a class qualified default. */
+export function resolveSpanName(spanName, fallback, thisArg, args) {
+    if (typeof spanName === 'function') {
+        return callSpanOption(spanName, fallback, thisArg, args, 'spanName');
+    }
+    return spanName ?? fallback;
+}
+/** @internal Shared with `CrawleeInstrumentation`, which merges its own attributes into the resolved options. */
+export function resolveSpanOptions(spanOptions, thisArg, args) {
+    if (typeof spanOptions === 'function') {
+        return callSpanOption(spanOptions, {}, thisArg, args, 'spanOptions');
+    }
+    return spanOptions ?? {};
+}
+/**
+ * Calls a `spanName` or `spanOptions` callback supplied by the caller.
+ *
+ * These run inside the call path of the wrapped function, so a mistake in one must not turn into a failure of the
+ * function being instrumented - the span is created with the default instead.
+ */
+function callSpanOption(callback, fallback, thisArg, args, optionName) {
+    try {
+        return callback.apply(thisArg, args);
+    }
+    catch (err) {
+        diag.warn(`The ${optionName} callback of a ${PACKAGE_NAME} span threw, using the default instead: ${err}`);
+        return fallback;
+    }
+}
+function isPromiseLike(value) {
+    return typeof value?.then === 'function';
+}
+function recordError(span, err) {
+    span.recordException(err);
+    // Per the OpenTelemetry specification, instrumentation only sets the status on failure and leaves successful
+    // spans `UNSET` - marking them `OK` would prevent consumers from overriding the status themselves.
+    span.setStatus({
+        code: SpanStatusCode.ERROR,
+        message: err instanceof Error ? err.message : String(err),
+    });
+}