feat(cucumber): add instrumentation for @cucumber/cucumber (#1252)

* feat(cucumber): add instrumentation for @cucumber/cucumber

* fix(cucumber): rename plugin directory

* chore(cucumber): add to release-please-config

* chore(cucumber): add Ugzuzg to component_owners

* fix(cucumber): add @opentelemetry/semantic-conventions to dependencies

* fix(cucumber): only instrument ^8

* fix(cucumber): use bound diag logger

* fix(cucumber): add tags as string[] to attributes

* fix(cucumber): extract attribute names into enum

* fix(cucumber): recordException as string for step statuses

* docs(auto-instrumentation-node): add cucumber instrumentation to readme

* fix(cucumber): remove unnecessary isEnabled checks

* fix(cucumber): get rid of @cucumber/cucumber imports in compiled files

* fix(cucumber): remove newline character from span name

* fix(cucumber): set step status as an attribute

* chore(cucumber): update homepage path

Co-authored-by: Amir Blum <[email protected]>

* fix(cucumber): get status enum from cucumber module

* fix(cucumber): mention why isEnabled is needed

* chore(cucumber): add package to release-please-manifset

* feat: wrap runAttempt

* fix: match versions in package.json and auto

* feat: instrument cucumber@9

* fix: wrap typeof in parens

---------

Co-authored-by: Amir Blum <[email protected]>

.github/component_owners.yml

@@ -38,6 +38,8 @@ components:
     - blumamir
   plugins/node/instrumentation-amqplib:
     - blumamir
+  plugins/node/instrumentation-cucumber:
+    - Ugzuzg
   plugins/node/instrumentation-dataloader:
     - henrinormak
   plugins/node/instrumentation-fs:

.release-please-manifest.json

@@ -1 +1 @@
-{"detectors/node/opentelemetry-resource-detector-alibaba-cloud":"0.28.0","detectors/node/opentelemetry-resource-detector-aws":"1.3.0","detectors/node/opentelemetry-resource-detector-container":"0.3.0","detectors/node/opentelemetry-resource-detector-gcp":"0.29.0","detectors/node/opentelemetry-resource-detector-github":"0.28.0","detectors/node/opentelemetry-resource-detector-instana":"0.5.0","metapackages/auto-instrumentations-node":"0.38.0","metapackages/auto-instrumentations-web":"0.33.0","packages/opentelemetry-host-metrics":"0.33.0","packages/opentelemetry-id-generator-aws-xray":"1.2.0","packages/opentelemetry-propagation-utils":"0.30.0","packages/opentelemetry-redis-common":"0.36.0","packages/opentelemetry-sql-common":"0.40.0","packages/opentelemetry-test-utils":"0.34.0","plugins/node/instrumentation-amqplib":"0.33.0","plugins/node/instrumentation-dataloader":"0.5.0","plugins/node/instrumentation-fs":"0.8.0","plugins/node/instrumentation-lru-memoizer":"0.33.0","plugins/node/instrumentation-mongoose":"0.33.0","plugins/node/instrumentation-socket.io":"0.34.0","plugins/node/instrumentation-tedious":"0.6.0","plugins/node/opentelemetry-instrumentation-aws-lambda":"0.36.0","plugins/node/opentelemetry-instrumentation-aws-sdk":"0.35.0","plugins/node/opentelemetry-instrumentation-bunyan":"0.32.0","plugins/node/opentelemetry-instrumentation-cassandra":"0.33.0","plugins/node/opentelemetry-instrumentation-connect":"0.32.0","plugins/node/opentelemetry-instrumentation-dns":"0.32.0","plugins/node/opentelemetry-instrumentation-express":"0.33.0","plugins/node/opentelemetry-instrumentation-fastify":"0.32.0","plugins/node/opentelemetry-instrumentation-generic-pool":"0.32.0","plugins/node/opentelemetry-instrumentation-graphql":"0.35.0","plugins/node/opentelemetry-instrumentation-hapi":"0.32.0","plugins/node/opentelemetry-instrumentation-ioredis":"0.35.0","plugins/node/opentelemetry-instrumentation-knex":"0.32.0","plugins/node/opentelemetry-instrumentation-koa":"0.35.0","plugins/node/opentelemetry-instrumentation-memcached":"0.32.0","plugins/node/opentelemetry-instrumentation-mongodb":"0.36.0","plugins/node/opentelemetry-instrumentation-mysql":"0.34.0","plugins/node/opentelemetry-instrumentation-mysql2":"0.34.0","plugins/node/opentelemetry-instrumentation-nestjs-core":"0.33.0","plugins/node/opentelemetry-instrumentation-net":"0.32.0","plugins/node/opentelemetry-instrumentation-pg":"0.36.0","plugins/node/opentelemetry-instrumentation-pino":"0.34.0","plugins/node/opentelemetry-instrumentation-redis":"0.35.0","plugins/node/opentelemetry-instrumentation-redis-4":"0.35.0","plugins/node/opentelemetry-instrumentation-restify":"0.33.0","plugins/node/opentelemetry-instrumentation-router":"0.33.0","plugins/node/opentelemetry-instrumentation-winston":"0.32.0","plugins/web/opentelemetry-instrumentation-document-load":"0.33.0","plugins/web/opentelemetry-instrumentation-long-task":"0.33.0","plugins/web/opentelemetry-instrumentation-user-interaction":"0.33.0","plugins/web/opentelemetry-plugin-react-load":"0.29.0","propagators/opentelemetry-propagator-aws-xray":"1.3.0","propagators/opentelemetry-propagator-grpc-census-binary":"0.27.0","propagators/opentelemetry-propagator-instana":"0.3.0","propagators/opentelemetry-propagator-ot-trace":"0.27.0"}
+{"detectors/node/opentelemetry-resource-detector-alibaba-cloud":"0.28.0","detectors/node/opentelemetry-resource-detector-aws":"1.3.0","detectors/node/opentelemetry-resource-detector-container":"0.3.0","detectors/node/opentelemetry-resource-detector-gcp":"0.29.0","detectors/node/opentelemetry-resource-detector-github":"0.28.0","detectors/node/opentelemetry-resource-detector-instana":"0.5.0","metapackages/auto-instrumentations-node":"0.38.0","metapackages/auto-instrumentations-web":"0.33.0","packages/opentelemetry-host-metrics":"0.33.0","packages/opentelemetry-id-generator-aws-xray":"1.2.0","packages/opentelemetry-propagation-utils":"0.30.0","packages/opentelemetry-redis-common":"0.36.0","packages/opentelemetry-sql-common":"0.40.0","packages/opentelemetry-test-utils":"0.34.0","plugins/node/instrumentation-amqplib":"0.33.0","plugins/node/instrumentation-cucumber":"0.0.1","plugins/node/instrumentation-dataloader":"0.5.0","plugins/node/instrumentation-fs":"0.8.0","plugins/node/instrumentation-lru-memoizer":"0.33.0","plugins/node/instrumentation-mongoose":"0.33.0","plugins/node/instrumentation-socket.io":"0.34.0","plugins/node/instrumentation-tedious":"0.6.0","plugins/node/opentelemetry-instrumentation-aws-lambda":"0.36.0","plugins/node/opentelemetry-instrumentation-aws-sdk":"0.35.0","plugins/node/opentelemetry-instrumentation-bunyan":"0.32.0","plugins/node/opentelemetry-instrumentation-cassandra":"0.33.0","plugins/node/opentelemetry-instrumentation-connect":"0.32.0","plugins/node/opentelemetry-instrumentation-dns":"0.32.0","plugins/node/opentelemetry-instrumentation-express":"0.33.0","plugins/node/opentelemetry-instrumentation-fastify":"0.32.0","plugins/node/opentelemetry-instrumentation-generic-pool":"0.32.0","plugins/node/opentelemetry-instrumentation-graphql":"0.35.0","plugins/node/opentelemetry-instrumentation-hapi":"0.32.0","plugins/node/opentelemetry-instrumentation-ioredis":"0.35.0","plugins/node/opentelemetry-instrumentation-knex":"0.32.0","plugins/node/opentelemetry-instrumentation-koa":"0.35.0","plugins/node/opentelemetry-instrumentation-memcached":"0.32.0","plugins/node/opentelemetry-instrumentation-mongodb":"0.36.0","plugins/node/opentelemetry-instrumentation-mysql":"0.34.0","plugins/node/opentelemetry-instrumentation-mysql2":"0.34.0","plugins/node/opentelemetry-instrumentation-nestjs-core":"0.33.0","plugins/node/opentelemetry-instrumentation-net":"0.32.0","plugins/node/opentelemetry-instrumentation-pg":"0.36.0","plugins/node/opentelemetry-instrumentation-pino":"0.34.0","plugins/node/opentelemetry-instrumentation-redis":"0.35.0","plugins/node/opentelemetry-instrumentation-redis-4":"0.35.0","plugins/node/opentelemetry-instrumentation-restify":"0.33.0","plugins/node/opentelemetry-instrumentation-router":"0.33.0","plugins/node/opentelemetry-instrumentation-winston":"0.32.0","plugins/web/opentelemetry-instrumentation-document-load":"0.33.0","plugins/web/opentelemetry-instrumentation-long-task":"0.33.0","plugins/web/opentelemetry-instrumentation-user-interaction":"0.33.0","plugins/web/opentelemetry-plugin-react-load":"0.29.0","propagators/opentelemetry-propagator-aws-xray":"1.3.0","propagators/opentelemetry-propagator-grpc-census-binary":"0.27.0","propagators/opentelemetry-propagator-instana":"0.3.0","propagators/opentelemetry-propagator-ot-trace":"0.27.0"}

metapackages/auto-instrumentations-node/README.md

@@ -140,6 +140,7 @@ registerInstrumentations({
 - [@opentelemetry/instrumentation-bunyan](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-bunyan)
 - [@opentelemetry/instrumentation-cassandra-driver](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-cassandra)
 - [@opentelemetry/instrumentation-connect](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-connect)
+- [@opentelemetry/instrumentation-cucumber](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/instrumentation-cucumber)
 - [@opentelemetry/instrumentation-dataloader](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/instrumentation-dataloader)
 - [@opentelemetry/instrumentation-dns](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-dns)
 - [@opentelemetry/instrumentation-express](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-express)

metapackages/auto-instrumentations-node/package.json

@@ -56,6 +56,7 @@
     "@opentelemetry/instrumentation-bunyan": "^0.32.0",
     "@opentelemetry/instrumentation-cassandra-driver": "^0.33.0",
     "@opentelemetry/instrumentation-connect": "^0.32.0",
+    "@opentelemetry/instrumentation-cucumber": "^0.0.1",
     "@opentelemetry/instrumentation-dataloader": "^0.5.0",
     "@opentelemetry/instrumentation-dns": "^0.32.0",
     "@opentelemetry/instrumentation-express": "^0.33.0",

metapackages/auto-instrumentations-node/src/utils.ts

@@ -23,6 +23,7 @@ import { AwsInstrumentation } from '@opentelemetry/instrumentation-aws-sdk';
 import { BunyanInstrumentation } from '@opentelemetry/instrumentation-bunyan';
 import { CassandraDriverInstrumentation } from '@opentelemetry/instrumentation-cassandra-driver';
 import { ConnectInstrumentation } from '@opentelemetry/instrumentation-connect';
+import { CucumberInstrumentation } from '@opentelemetry/instrumentation-cucumber';
 import { DataloaderInstrumentation } from '@opentelemetry/instrumentation-dataloader';
 import { DnsInstrumentation } from '@opentelemetry/instrumentation-dns';
 import { ExpressInstrumentation } from '@opentelemetry/instrumentation-express';
@@ -90,6 +91,7 @@ const InstrumentationMap = {
   '@opentelemetry/instrumentation-cassandra-driver':
     CassandraDriverInstrumentation,
   '@opentelemetry/instrumentation-connect': ConnectInstrumentation,
+  '@opentelemetry/instrumentation-cucumber': CucumberInstrumentation,
   '@opentelemetry/instrumentation-dataloader': DataloaderInstrumentation,
   '@opentelemetry/instrumentation-dns': DnsInstrumentation,
   '@opentelemetry/instrumentation-express': ExpressInstrumentation,

plugins/node/instrumentation-cucumber/.eslintignore

@@ -0,0 +1 @@
+build

plugins/node/instrumentation-cucumber/.eslintrc.js

@@ -0,0 +1,7 @@
+module.exports = {
+    "env": {
+        "mocha": true,
+        "node": true
+    },
+    ...require('../../../eslint.config.js')
+}

plugins/node/instrumentation-cucumber/.npmignore

@@ -0,0 +1,4 @@
+/bin
+/coverage
+/doc
+/test

plugins/node/instrumentation-cucumber/.tav.yml

@@ -0,0 +1,3 @@
+'@cucumber/cucumber':
+  versions: '^8.0.0 || ^9.0.0'
+  commands: npm test