Skip to content

Simple, privacy-focused API monitoring & analytics for Node.js apps

License

Notifications You must be signed in to change notification settings

apitally/apitally-js

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Apitally logo

Simple, privacy-focused API monitoring & analytics

Apitally helps you understand how your APIs are being used and alerts you when things go wrong.
Just add two lines of code to your project to get started.


Apitally screenshots


Apitally client library for Node.js

Tests Codecov npm

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

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.
});

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.

Note: Currently only NestJS applications that use Express as the underlying HTTP server are supported (the default).

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

const app = await NestFactory.create(AppModule);

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.

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.
});

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.
});

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.