Skip to main content
Home

grammY plugin to allow instrumentation with open telemetry

This package works with Cloudflare Workers, Node.js, Deno, Bun, Browsers
This package works with Cloudflare Workers
This package works with Node.js
This package works with Deno
This package works with Bun
This package works with Browsers
JSR Score
100%
Published
a year ago (0.0.2)
function openTelemetry
openTelemetry(
tracer: otel.Tracer,
options?: PluginOptions,
): MiddlewareFn<Context & OpenTelemetryContext>

Main plugin function. Enables OpenTelemetry for every update and every API call performed via Context helpers (eg: ctx.reply).

Examples

Example 1

import { Bot, Context } from "grammy";
import { openTelemetry } from "grammy-opentelemetry";
import { getHttpTracer } from "grammy-opentelemetry";

const bot = new Bot<Context>("token");
bot.use(openTelemetry(getHttpTracer("my-bot")));
bot.start();

Parameters

tracer: otel.Tracer

An instance of OpenTelemetry Tracer

optional
options: PluginOptions

Optional config object

Return Type

MiddlewareFn<Context & OpenTelemetryContext>

A middleware that enables OpenTelemetry for every update

New Ticket: Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.

Add Package

deno add jsr:@roz/grammy-opentelemetry

Import symbol

import { openTelemetry } from "@roz/grammy-opentelemetry";
or

Import directly with a jsr specifier

import { openTelemetry } from "jsr:@roz/grammy-opentelemetry";

Add Package

pnpm i jsr:@roz/grammy-opentelemetry
or (using pnpm 10.8 or older)
pnpm dlx jsr add @roz/grammy-opentelemetry

Import symbol

import { openTelemetry } from "@roz/grammy-opentelemetry";

Add Package

yarn add jsr:@roz/grammy-opentelemetry
or (using Yarn 4.8 or older)
yarn dlx jsr add @roz/grammy-opentelemetry

Import symbol

import { openTelemetry } from "@roz/grammy-opentelemetry";

Add Package

vlt install jsr:@roz/grammy-opentelemetry

Import symbol

import { openTelemetry } from "@roz/grammy-opentelemetry";

Add Package

npx jsr add @roz/grammy-opentelemetry

Import symbol

import { openTelemetry } from "@roz/grammy-opentelemetry";

Add Package

bunx jsr add @roz/grammy-opentelemetry

Import symbol

import { openTelemetry } from "@roz/grammy-opentelemetry";