Setup guide for Fastify

This page guides you through the steps of configuring your Fastify application to work with Apitally. If you don’t have an account yet, now would be a good time to sign up.

Once you’re done with this guide, you will be able to:

• Monitor traffic to your application on our simple dashboard
• Keep track of errors, response times and payload sizes
• Understand how individual API consumers use your application
• Monitor your application’s uptime and receive alerts when it’s down

​

Create app

To get started, create a new app in the Apitally dashboard and select as your framework.

Here you can also configure the environments (e.g. prod and dev) for your app, or simply accept the defaults.

Take a note of the client ID displayed after submitting. You will need it in the next step.

​

Add plugin

Next, install the Apitally client library and the fastify-plugin package in your Fastify project.

npm install apitally fastify-plugin

Register the Apitally plugin with your Fastify application and provide the clientId for your app. You’ll find the clientId on the Setup instructions page for your app in the Apitally dashboard, which is displayed immediately after creating the app.

import Fastify from "fastify";
import { apitallyPlugin } from "apitally/fastify";

const fastify = Fastify({ logger: true });

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

​

Identify consumers

In order to analyze API traffic by consumers in Apitally, your application must identify which consumers requests are coming from.

How you identify API consumers depends on your application and use case. If your application uses authentication, it would make sense to use the authenticated identity (e.g. username) as the consumer identifier.

To associate requests with consumers, set the consumerIdentifier property on the Request object, for example in your authentication function.

fastify.addHook("onRequest", async (request, reply) => {
  try {
    await request.jwtVerify(); // Assuming @fastify/jwt is used for authentication
    request.consumerIdentifier = request.user.name;
  } catch (err) {
    reply.send(err);
  }
});

The consumer identifier should be a string that uniquely identifies the consumer of the API, e.g. customer-123. Once the first request is received from a consumer, it will show up in the Apitally dashboard and you can assign a more descriptive name to it.