test server and docs for fastify

Author: dawkaka

packages/express/README.md

@@ -23,7 +23,6 @@ export OTEL_RESOURCE_ATTRIBUTES=at-project-key="<YOUR_API_KEY>" # Adds your API
 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
 ```
 

packages/fastify/README.md

@@ -0,0 +1,80 @@
+<p>
+<img src="https://apitoolkit.io/assets/img/logo-full.svg" alt="APIToolkit" width="250px" />
+</p>
+
+APIToolkit fastify 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 fastify js package from your projects root:
+
+```sh
+npm install --save apitoolkit-fastify @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.
+
+```sh
+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 fastify server
+```
+
+### HTTP Requests Monitoring
+
+You can monitor http requests using APIToolkit's fastify middleware, this allows you to monitor all your http requests. including headers, response time, response status code, request body, response body, etc.
+
+```js
+import fastify from "fastify";
+import { APIToolkit } from "./index";
+import axios from "axios";
+
+const fastifyServer = fastify({});
+const apitoolkit = APIToolkit.NewClient({
+  fastify: fastifyServer,
+  serviceName: "my-service",
+  serviceVersion: "1.0.0",
+  tags: [],
+  debug: true,
+  monitorAxios: axios, // optional axios instance to monitor all axios requests
+});
+
+apitoolkit.initializeHooks();
+
+fastifyServer.get("/", async (request, reply) => {
+  const response = await axios.get(
+    "https://jsonplaceholder.typicode.com/todos/1"
+  );
+  return response.data;
+});
+
+fastifyServer.listen({ 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.                          |
+
+<br />
+
+> [!IMPORTANT]
+>
+> To learn more configuration options (redacting fields, error reporting, outgoing requests, etc.) and complete integration guide, please read this [SDK documentation](https://apitoolkit.io/docs/sdks/nodejs/fastifyjs/utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme).

packages/fastify/package.json

@@ -12,11 +12,15 @@
   "dependencies": {
     "@apitoolkit/common": "workspace:*",
     "@opentelemetry/api": "^1.9.0",
+    "@opentelemetry/auto-instrumentations-node": "^0.54.0",
     "axios": "^1.7.9",
     "fastify": "^5.1.0",
     "uuid": "^11.0.3"
   },
   "keywords": [],
   "author": "",
-  "license": "ISC"
+  "license": "ISC",
+  "devDependencies": {
+    "typescript": "^5.0.0"
+  }
 }

packages/fastify/src/index.ts

@@ -11,7 +11,7 @@ import {
 } from "@apitoolkit/common";
 import { trace } from "@opentelemetry/api";
 
-export { ReportError, observeAxios } from "@apitoolkit/common";
+export { ReportError as reportError, observeAxios } from "@apitoolkit/common";
 
 class APIToolkit {
   #config: Config & { fastify: FastifyInstance };
@@ -78,7 +78,7 @@ class APIToolkit {
 
   public initializeHooks() {
     if (this.#config.monitorAxios) {
-      observeAxiosGlobal(this.#config.monitorAxios, {});
+      observeAxiosGlobal(this.#config.monitorAxios, this.#config);
     }
     this.#config.fastify.addHook("preHandler", (request, _reply, done) => {
       if (this.#config.debug) {
@@ -90,14 +90,7 @@ class APIToolkit {
           const span = trace
             .getTracer(this.#config.serviceName || "")
             .startSpan("apitoolkit-http-span");
-
-          asyncLocalStorage.getStore()!.set("AT_client", this);
           asyncLocalStorage.getStore()!.set("AT_span", span);
-          asyncLocalStorage.getStore()!.set("AT_config", {
-            tags: this.#config.tags,
-            serviceVersion: this.#config.serviceVersion,
-          });
-
           asyncLocalStorage.getStore()!.set("AT_errors", []);
           const msg_id: string = uuidv4();
           asyncLocalStorage.getStore()!.set("AT_msg_id", msg_id);