@opentelemetry/instrumentation-cucumber NPM

OpenTelemetry Cucumber Instrumentation for Node.js

This module provides automatic instrumentation for the @cucumber/cucumber module, which may be loaded using the @opentelemetry/sdk-trace-node package and is included in the @opentelemetry/auto-instrumentations-node bundle.

If total installation size is not constrained, it is recommended to use the @opentelemetry/auto-instrumentations-node bundle with @opentelemetry/sdk-node for the most seamless instrumentation experience.

Compatible with OpenTelemetry JS API and SDK 1.0+.

Installation

npm install --save @opentelemetry/instrumentation-cucumber

Supported Versions

@cucumber/cucumber versions >=8.0.0 <11

Usage

const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
const {
  CucumberInstrumentation,
} = require('@opentelemetry/instrumentation-cucumber');
const { registerInstrumentations } = require('@opentelemetry/instrumentation');

const provider = new NodeTracerProvider();
provider.register();

registerInstrumentations({
  instrumentations: [
    new CucucmberInstrumentation({
      // see below for available configuration
    }),
  ],
});

Cucumber Instrumentation Options

Cucumber instrumentation has currently no options.

Options	Type	Description

Semantic Conventions

This package uses @opentelemetry/semantic-conventions version 1.22+, which implements Semantic Convention Version 1.7.0

Attributes collected:

Attribute	Short Description
`code.filepath`	The source code file name that identifies the code unit as uniquely as possible.
`code.function`	The method or function name, or equivalent.
`code.lineno`	The line number in `code.filepath` best representing the operation.
`code.namespace`	The "namespace" within which `code.function` is defined.