Apitally SDK for Node.js

This SDK for Apitally currently supports the following Node.js web frameworks:

• Express
• Fastify
• NestJS
• AdonisJS
• Hono
• H3 (v2)
• Elysia
• Koa
• Hapi

Learn more about Apitally on our 🌎 website or check out the 📚 documentation.

Key features

API analytics

Track traffic, error and performance metrics for your API, each endpoint and individual API consumers, allowing you to make informed, data-driven engineering and product decisions.

Error tracking

Understand which validation rules in your endpoints cause client errors. Capture error details and stack traces for 500 error responses, and have them linked to Sentry issues automatically.

Request logging

Drill down from insights to individual requests or use powerful filtering to understand how consumers have interacted with your API. Configure exactly what is included in the logs to meet your requirements.

API monitoring & alerting

Get notified immediately if something isn't right using custom alerts, synthetic uptime checks and heartbeat monitoring. Notifications can be delivered via email, Slack or Microsoft Teams.

Installation

You can install this library in your project using npm or yarn:

npm install apitally

or

yarn add apitally

Usage

Our comprehensive setup guides include all the details you need to get started.

Express

This is an example of how to use the Apitally middleware with an Express application. For further instructions, see our setup guide for Express.

const express = require("express");
const { useApitally } = require("apitally/express");

const app = express();
app.use(express.json());

useApitally(app, {
  clientId: "your-client-id",
  env: "dev", // or "prod" etc.
});

Fastify

This is an example of how to register the Apitally plugin with a Fastify application. For further instructions, see our setup guide for Fastify.

The Apitally plugin requires the fastify-plugin package to be installed.

npm install fastify-plugin

const fastify = require("fastify")({ logger: true });
const { apitallyPlugin } = require("apitally/fastify");

fastify.register(apitallyPlugin, {
  clientId: "your-client-id",
  env: "dev", // or "prod" etc.
});

// Wrap your routes in a plugin, so Apitally can detect them
fastify.register((instance, opts, done) => {
  instance.get("/", (request, reply) => {
    reply.send("hello");
  });
  done();
});

Note: If your project uses ES modules you can use await fastify.register(...) and don't need to wrap your routes in a plugin. See the Fastify V4 migration guide for more details.

NestJS

This is an example of how to use the Apitally middleware with a NestJS application. For further instructions, see our setup guide for NestJS.

const { NestFactory } = require("@nestjs/core");
const { useApitally } = require("apitally/nestjs");
const { AppModule } = require("./app.module");

async function bootstrap() {
  const app = await NestFactory.create(AppModule);

  await useApitally(app, {
    clientId: "your-client-id",
    env: "dev", // or "prod" etc.
  });

  // ...
}

bootstrap();

AdonisJS

You can use the following Ace command to configure Apitally in your AdonisJS application:

node ace configure apitally/adonisjs

This command will automatically:

• Create a config file at config/apitally.ts
• Register the Apitally provider in adonisrc.ts
• Add the Apitally middleware to start/kernel.ts
• Add required environment variables to .env and start/env.ts

For further instructions, see our setup guide for AdonisJS.

Hono

This is an example of how to use the Apitally middleware with a Hono application. For further instructions, see our setup guide for Hono.

import { Hono } from "hono";
import { useApitally } from "apitally/hono";

const app = new Hono();

useApitally(app, {
  clientId: "your-client-id",
  env: "dev", // or "prod" etc.
});

H3

This is an example of how to register the Apitally plugin with an H3 application. For further instructions, see our setup guide for H3.

import { H3 } from "h3";
import { apitallyPlugin } from "apitally/h3";

const app = new H3({
  plugins: [
    apitallyPlugin({
      clientId: "your-client-id",
      env: "dev", // or "prod" etc.
    }),
  ],
});

Note: Apitally only works with H3 v2 and currently doesn't support nested apps.

Elysia

This is an example of how to use the Apitally plugin with an Elysia application. For further instructions, see our setup guide for Elysia.

import { Elysia } from "elysia";
import { apitallyPlugin } from "apitally/elysia";

const app = new Elysia()
  .use(
    apitallyPlugin({
      clientId: "your-client-id",
      env: "dev", // or "prod" etc.
    }),
  )
  .get("/", () => "hello");

Koa

This is an example of how to use the Apitally middleware with a Koa application. For further instructions, see our setup guide for Koa.

const Koa = require("koa");
const { useApitally } = require("apitally/koa");

const app = new Koa();

useApitally(app, {
  clientId: "your-client-id",
  env: "dev", // or "prod" etc.
});

Hapi

This is an example of how to use the Apitally plugin with a Hapi application. For further instructions, see our setup guide for Hapi.

const Hapi = require("@hapi/hapi");
const { apitallyPlugin } = require("apitally/hapi");

const init = async () => {
  const server = Hapi.server({
    port: 3000,
    host: "localhost",
  });

  await server.register({
    plugin: apitallyPlugin({
      clientId: "your-client-id",
      env: "dev", // or "prod" etc.
    }),
  });
};

init();

Getting help

If you need help please create a new discussion on GitHub or join our Slack workspace.

License

This library is licensed under the terms of the MIT license.