markflorkowski/prisma-axiom

Axiom observability middleware for Prisma

prisma-axiom

Axiom observability middleware for Prisma.

Quickstart

1. Install prisma-axiom

npm install --save prisma-axiom

2. Add the following where you initialize your Prisma client:

import withAxiom from 'prisma-axiom';
const prisma = withAxiom(new PrismaClient());

Note: This will configure Axiom from the AXIOM_TOKEN and other environment variables. Check out the Kitchen Sink Full Configuration for more advanced configuration.

3. Enable the prisma tracing preview feature in schema.prisma like this:

generator client {
  provider        = "prisma-client-js"
  previewFeatures = ["tracing"]
}

Kitchen Sink Full Configuration

You can configure prisma-axiom by passing an options object as the second parameter. This snippet shows all available options:

const prisma = withAxiom(new PrismaClient(), {
  axiomToken:                 "xaat-xxxxx",
  axiomUrl:                   "https://my-axiom.example.org",
  additionalInstrumentations: [new HttpInstrumentation()] // add more instrumentations to the tracing setup
});

License

© Axiom, Inc., 2022

Distributed under MIT License (The MIT License).

See LICENSE for more information.