apitoolkit-express

APIToolkit Express Middleware is a middleware that can be used to monitor HTTP requests. It is provides additional functionalities on top of the open telemetry instrumentation which creates a custom span for each request capturing details about the request including request and response bodies.

Installation

Run the following command to install the express js package from your projects root:

npm install --save apitoolkit-express @opentelemetry/api @opentelemetry/auto-instrumentations-node

Setup Open Telemetry

Setting up open telemetry allows you to send traces, metrics and logs to the APIToolkit platform.

export OTEL_EXPORTER_OTLP_ENDPOINT="http://otelcol.apitoolkit.io:4317"
export OTEL_SERVICE_NAME="my-service" # Specifies the name of the service.
export OTEL_RESOURCE_ATTRIBUTES=at-project-key="<YOUR_API_KEY>" # Adds your API KEY to the resource.
export OTEL_EXPORTER_OTLP_PROTOCOL="grpc" #Specifies the protocol to use for the OpenTelemetry exporter.
export NODE_OPTIONS="--require @opentelemetry/auto-instrumentations-node/register"

node server.js # starting your express server

HTTP Requests Monitoring

You can monitor http requests using APIToolkit's express middleware, this allows you to monitor all your http requests. including headers, response time, response status code, request body, response body, etc.

import * as express from "express";
import { APIToolkit } from "./index";
import axios from "axios";

const app = express();
const apitoolkitClient = APIToolkit.NewClient({
  serviceName: "my-service",
  serviceVersion: "1.0.0",
  tags: ["env:dev"],
  monitorAxios: axios, // optional, if you want to monitor axios requests
});

// add the middleware to for request monitoring
app.use(apitoolkitClient.middleware);

app.get("/", async (req, res) => {
  const r = await axios.get("https://jsonplaceholder.typicode.com/todos/1");
  res.json(r.data);
});

// automatically report unhandled errors along with the request data
app.use(apitoolkitClient.errorMiddleware);

app.listen(3000, () => {
  console.log("Example app listening on port 3000!");
});

Quick overview of the configuration parameters

An object with the following optional fields can be passed to the middleware to configure it:

Option	Description
`debug`	Set to `true` to enable debug mode.
`serviceName`	A defined string name of your application.
`tags`	A list of defined tags for your services (used for grouping and filtering data on the dashboard).
`serviceVersion`	A defined string version of your application (used for further debugging on the dashboard).
`redactHeaders`	A list of HTTP header keys to redact.
`redactResponseBody`	A list of JSONPaths from the response body to redact.
`redactRequestBody`	A list of JSONPaths from the request body to redact.
`captureRequestBody`	Default `false`, set to `true` if you want to capture the request body.
`captureResponseBody`	Default `false`, set to `true` if you want to capture the response body.

[!IMPORTANT]

To learn more configuration options (redacting fields, error reporting, outgoing requests, etc.) and complete integration guide, please read this SDK documentation.