Documentation: SDK Integration Guide & API Reference #1

New Issue

2026-02-14T05:22:26Z

jason.woltje commented

2026-02-14 05:22:26 +00:00

Context

The Mosaic Telemetry monorepo (API + Web) is now operational. The telemetry agent is documenting the API contract, endpoints, auth, and data schema on the server side.

This issue covers the JS client SDK documentation.

Scope

Integration Guide

Installation and setup (npm install)
Configuration options (API URL, auth token, batch settings, retry behavior)
Quick start example — instrumenting a Next.js app
Quick start example — instrumenting a Node.js service

SDK API Reference

All exported classes and methods
Configuration interface/types
Event types and payload schemas
Error handling behavior

Examples

Basic event tracking
Custom metadata/tags
Batch vs real-time mode
Environment-specific configuration (dev vs prod)

Dependency

This documentation should be written against the API contract documented in mosaic/telemetry. Coordinate with the telemetry monorepo docs for the authoritative endpoint specs, auth requirements, and data schema.

Acceptance Criteria

README.md updated with clear quick start
Full API reference in docs/ or README
At least 2 integration examples (Next.js + Node.js)
Documents which telemetry API version this SDK targets

## Context The Mosaic Telemetry monorepo (API + Web) is now operational. The telemetry agent is documenting the API contract, endpoints, auth, and data schema on the server side. This issue covers the JS client SDK documentation. ## Scope ### Integration Guide - Installation and setup (npm install) - Configuration options (API URL, auth token, batch settings, retry behavior) - Quick start example — instrumenting a Next.js app - Quick start example — instrumenting a Node.js service ### SDK API Reference - All exported classes and methods - Configuration interface/types - Event types and payload schemas - Error handling behavior ### Examples - Basic event tracking - Custom metadata/tags - Batch vs real-time mode - Environment-specific configuration (dev vs prod) ## Dependency This documentation should be written against the API contract documented in mosaic/telemetry. Coordinate with the telemetry monorepo docs for the authoritative endpoint specs, auth requirements, and data schema. ## Acceptance Criteria - [ ] README.md updated with clear quick start - [ ] Full API reference in docs/ or README - [ ] At least 2 integration examples (Next.js + Node.js) - [ ] Documents which telemetry API version this SDK targets

jason.woltje referenced this issue from a commit

2026-02-15 04:38:24 +00:00

docs(#1): SDK integration guide, API reference, and CI pipeline

jason.woltje referenced this issue from a commit

2026-02-15 04:43:29 +00:00

fix(#1): add Node.js globals to ESLint config

jason.woltje referenced this issue from a commit

2026-02-15 04:47:09 +00:00

fix(#1): remove duplicate npm ci from parallel CI steps

jason.woltje referenced this issue from a commit

2026-02-15 04:48:09 +00:00

chore(#1): apply Prettier formatting to all source and test files