bullmq-otel 1.0.0

package/.github/workflows/release.yml

@@ -0,0 +1,36 @@
+name: Release
+on:
+  push:
+    branches:
+      - main
+
+env:
+  HUSKY: 0
+
+jobs:
+  release:
+    permissions:
+      contents: write # for release publishing
+
+    name: Release
+    env:
+      commitmsg: ${{ github.event.head_commit.message }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: lts/*
+          cache: 'yarn'
+      - name: Install dependencies Node
+        run: npm install --frozen-lockfile --non-interactive
+      - run: npm run build
+      - name: Release Node
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npx semantic-release

package/.prettierrc.js

@@ -0,0 +1,8 @@
+module.exports = {
+  singleQuote: true,
+  trailingComma: "all",
+  tabWidth: 2,
+  printWidth: 80,
+  semi: true,
+  arrowParens: "avoid",
+};

package/CHANGELOG.md

@@ -0,0 +1,15 @@
+# 1.0.0 (2024-11-01)
+
+
+### Bug Fixes
+
+* **package.json:** typedoc and typscript to devDependencies ([15c2302](https://github.com/taskforcesh/bullmq-otel/commit/15c23026aa58dd0264f20f3b0b12b4f8ffbfe75f))
+
+
+### Features
+
+* **BullMQOtel:** rename Otel to BullMQOtel and add devDependencies ([417fe82](https://github.com/taskforcesh/bullmq-otel/commit/417fe8269b42036cf7b41ce81ad9468be90dcaa8))
+* implemente interface based on changes in BullMQ telemetry interface ([51d8ddd](https://github.com/taskforcesh/bullmq-otel/commit/51d8ddde968f11f860c29d033b6d10f7db519703))
+* **Otel:** create first version of Otel interface ([9e5211d](https://github.com/taskforcesh/bullmq-otel/commit/9e5211d31b106d7a180339f778313a2852a15fb6))
+* **Otel:** create first version of Otel interface ([85ee824](https://github.com/taskforcesh/bullmq-otel/commit/85ee8248b72b5e98630ca68a5e95ed25c5ea6485))
+* **package.json:** add entrypoints for package ([4531b49](https://github.com/taskforcesh/bullmq-otel/commit/4531b49b2a59ca1a10a53981daf8f250e54c58fa))

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at admin@taskforce.sh. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 BullForce Labs AB
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,7 @@
+# OpenTelemetry add-on for BullMQ
+
+This module provides an OpenTelemetry implementation of BullMQ's telemetry interface.
+
+## Quick Guide
+
+For information on how to use this module, please refer to the [Telemetry](https://docs.bullmq.io/guide/telemetry) section of the BullMQ documentation.

package/package.json

@@ -0,0 +1,99 @@
+{
+  "name": "bullmq-otel",
+  "version": "1.0.0",
+  "description": "OpenTelemetry add-on for BullMQ",
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/esm/index.d.ts",
+  "source": "./src/index.ts",
+  "scripts": {
+    "build": "tsc && tsc -p tsconfig-cjs.json",
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "prepublishOnly": "npm run build",
+    "semantic-release": "semantic-release"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/taskforcesh/bullmq-otel.git"
+  },
+  "keywords": [
+    "telemetry",
+    "opentelemetry",
+    "otel",
+    "bullmq"
+  ],
+  "author": "BullForce Labs AB",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/taskforcesh/bullmq-otel/issues"
+  },
+  "homepage": "https://github.com/taskforcesh/bullmq-otel#readme",
+  "dependencies": {
+    "@opentelemetry/api": "^1.9.0",
+    "bullmq": "^5.22.0"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^19.4.1",
+    "@commitlint/config-conventional": "^19.4.1",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/commit-analyzer": "^13.0.0",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/github": "^10.1.7",
+    "@semantic-release/npm": "^12.0.1",
+    "@semantic-release/release-notes-generator": "^14.0.1",
+    "tslib": "^2.8.0",
+    "typedoc": "^0.26.6",
+    "typescript": "^5.5.4"
+  },
+  "config": {
+    "commitizen": {
+      "path": "node_modules/cz-conventional-changelog"
+    }
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "release": {
+    "plugins": [
+      [
+        "@semantic-release/commit-analyzer",
+        {
+          "releaseRules": [
+            {
+              "message": "*\\[python\\]*",
+              "release": false
+            }
+          ]
+        }
+      ],
+      "@semantic-release/release-notes-generator",
+      [
+        "@semantic-release/changelog",
+        {
+          "changelogFile": "CHANGELOG.md"
+        }
+      ],
+      [
+        "@semantic-release/npm",
+        {
+          "npmPublish": true
+        }
+      ],
+      "@semantic-release/github",
+      [
+        "@semantic-release/git",
+        {
+          "assets": [
+            "package.json",
+            "yarn.lock",
+            "CHANGELOG.md",
+            "docs/gitbook/api/**"
+          ],
+          "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
+        }
+      ]
+    ]
+  }
+}

package/src/bullMQOtel.ts

@@ -0,0 +1,98 @@
+import {
+  trace,
+  Tracer as OtelTracer,
+  ContextAPI,
+  context,
+  propagation,
+  Context as OtelContext,
+  Span as OtelSpan,
+} from '@opentelemetry/api';
+
+import {
+  ContextManager,
+  Telemetry,
+  Tracer,
+  Span,
+  AttributeValue,
+  Attributes,
+  Time,
+  Exception,
+} from 'bullmq';
+
+class BullMQOTelContextManager implements ContextManager<OtelContext> {
+  private contextAPI: ContextAPI = context;
+
+  getMetadata(ctx: OtelContext): string {
+    const metadata = {};
+    propagation.inject(ctx, metadata);
+    return JSON.stringify(metadata);
+  }
+
+  fromMetadata(activeCtx: OtelContext, metadata: string) {
+    const metadataObj = JSON.parse(metadata);
+    const ctx = propagation.extract(activeCtx, metadataObj);
+    return ctx;
+  }
+
+  with<A extends (...args: any[]) => any>(
+    ctx: OtelContext,
+    fn: A,
+  ): ReturnType<A> {
+    return this.contextAPI.with(ctx, fn);
+  }
+
+  active(): OtelContext {
+    return this.contextAPI.active();
+  }
+}
+
+class BullMQOtelTracer implements Tracer {
+  constructor(private tracer: OtelTracer) {}
+
+  startSpan(
+    name: string,
+    options?: any,
+    context?: OtelContext,
+  ): Span<OtelContext> {
+    const span = this.tracer.startSpan(name, options, context);
+    return new BullMQOTelSpan(span);
+  }
+}
+
+export class BullMQOTelSpan implements Span<OtelContext> {
+  constructor(public span: OtelSpan) {}
+
+  setSpanOnContext(ctx: OtelContext): OtelContext {
+    return trace.setSpan(ctx, this.span);
+  }
+
+  setAttribute(key: string, value: AttributeValue): void {
+    this.span.setAttribute(key, value);
+  }
+
+  setAttributes(attributes: Attributes): void {
+    this.span.setAttributes(attributes);
+  }
+
+  addEvent(name: string, attributes?: Attributes, time?: Time): void {
+    this.span.addEvent(name, attributes, time);
+  }
+
+  recordException(exception: Exception, time?: Time): void {
+    this.span.recordException(exception, time);
+  }
+
+  end(): void {
+    this.span.end();
+  }
+}
+
+export class BullMQOtel implements Telemetry<OtelContext> {
+  tracer: BullMQOtelTracer;
+  contextManager: BullMQOTelContextManager;
+
+  constructor(tracerName: string, version?: string) {
+    this.tracer = new BullMQOtelTracer(trace.getTracer(tracerName, version));
+    this.contextManager = new BullMQOTelContextManager();
+  }
+}

package/src/index.ts

@@ -0,0 +1 @@
+export * from './bullMQOtel';

package/tsconfig-cjs.json

@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "module": "node16",
+    "outDir": "dist/cjs",
+    "declaration": false,
+    "declarationDir": null,
+    "moduleResolution": "node16"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,27 @@
+{
+  "compilerOptions": {
+    "types": ["node"],
+    "target": "ES2017",
+    "module": "ES2020",
+    "incremental": true,
+    "declaration": true,
+    "outDir": "dist/esm",
+    "sourceMap": true,
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "strict": true,
+    "jsx": "preserve",
+    "importHelpers": true,
+    "moduleResolution": "node",
+    "esModuleInterop": false,
+    "allowSyntheticDefaultImports": false,
+    "strictNullChecks": false,
+    "baseUrl": ".",
+    "paths": {
+      "@src/*": ["src/*"]
+    },
+    "lib": ["esnext", "DOM"]
+  },
+  "include": ["src"],
+  "exclude": ["node_modules", "dist", "tests/*", "src/commands/*.ts"]
+}