Technical Documentation

Welcome to the Apio Developer Handbook. Everything you need to securely monitor, query, and integrate your microservices.

Introduction

Apio is a highly-scalable, drop-in Observability SaaS built for modern monolithic and microservice infrastructures. Unlike traditional loggers that require thousands of lines of boilerplate setup, we engineered a global package that intercepts traffic without modifying your core business logic.

Core Philosophy

We built this platform to guarantee that 99.99% of crashes are recorded, alerted, and categorized within 14 milliseconds of occurring in production.

System Architecture

The platform runs on a proprietary distributed 4-package monorepo design, utilizing the world's most robust open-source technologies:

Subsystem	Runtime	Responsibility
API-CLI Package	`Node.js (Bun)`	Global request interceptor hooking directly into native `fetch` and `axios` instances.
Ingest Engine	`NestJS / Prisma`	Secures raw socket events and persists metrics globally to `MongoDB`.
Enterprise Admin	`Next.js 16`	Internal workspace granting developers cross-tenant visibility.
Observer App	`Next.js 16`	Customer-facing portal streaming real-time glassmorphic datasets.

Quick Start Integration

Integrating Apio into an express server or an existing NestJS repo takes approximately 10 seconds. You do not need to rewrite your network handlers.

Step 1: Obtain a Global SDK Token

Navigate to the Settings page within the main application and locate your unique cryptographic SDK token.

Step 2: Initialize via NPM

Launch the CLI initialization script in the root directory of your target backend node package.

~/my-backend-app ❯npx apio-cli init --token sdk_84f93a...

# The CLI will now intercept external calls automatically.

~/my-backend-app ❯npm run start

CLI Command Reference

The package execution supports several high-level parameters for enterprise compliance rules and data redaction:

apio-cli init --token <YOUR_TOKEN> --ignore-paths "/health,/metrics"

# Prevent specific low-value routes from saturating the websocket

Security Vault & Redaction

We absolutely respect PII (Personally Identifiable Information). By default, the Apio interceptor automatically drops payloads exceeding standard chunk limits and purges headers matching the following blacklists before transit:

Authentication Headers (Authorization Barer tokens, API Keys)
Common Financial Identifiers (SSN, PCI data)
Internal Node VM Memory Signatures