OpenTelemetry Nest

Find the source code at zonneplan/open-telemetry-js.

Set up

npm install @zonneplan/open-telemetry-nest

Usage

Using metrics

import { createCounterProvider, Counter } from '@zonneplan/open-telemetry-nest';

const MY_METRIC = 'my_metric';

// my-module.ts
@Module({
  providers: [
    /**
     * Registers a counter provider, which can be injected in services.
     */
    createCounterProvider({
      name: MY_METRIC,
      description: 'My metric description',
      unit: 'occurrences',
      valueType: ValueType.INT,
    })
  ]
})
export class MyModule {}

// my-service.ts
@Injectable()
export class MyService {
  constructor(
    /**
     * Inject the metric in the service.
     */
    @InjectMetric(MY_METRIC) private readonly myMetric: Counter
  ) {}

  /**
   * Using the default metric methods.
   */
  public myMethod() {
    this.myMetric.add(1);
  }

  /**
   * Using the metric increment decorator.
   */
  @metricIncrement(MY_METRIC)
  public myMetricIncrementDecorator() {
    
  }
}