mosaic/telemetry-client-py
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

Documentation: SDK Integration Guide & API Reference #1

New Issue
Open
opened 2026-02-14 05:22:36 +00:00 by jason.woltje · 0 comments
jason.woltje commented 2026-02-14 05:22:36 +00:00
Owner
Copy Link

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 Python client SDK documentation.

Scope

Integration Guide

  • Installation and setup (pip/uv install)
  • Configuration options (API URL, auth token, batch settings, retry behavior)
  • Quick start example — instrumenting a FastAPI service
  • Quick start example — instrumenting a generic Python app

SDK API Reference

  • All exported classes and methods
  • Configuration dataclass/model
  • Event types and payload schemas
  • Error handling behavior
  • Async vs sync usage patterns

Examples

  • Basic event tracking
  • Custom metadata/tags
  • Batch vs real-time mode
  • Context manager usage
  • 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 (FastAPI + generic Python)
  • Documents async vs sync client usage
  • 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 Python client SDK documentation. ## Scope ### Integration Guide - Installation and setup (pip/uv install) - Configuration options (API URL, auth token, batch settings, retry behavior) - Quick start example — instrumenting a FastAPI service - Quick start example — instrumenting a generic Python app ### SDK API Reference - All exported classes and methods - Configuration dataclass/model - Event types and payload schemas - Error handling behavior - Async vs sync usage patterns ### Examples - Basic event tracking - Custom metadata/tags - Batch vs real-time mode - Context manager usage - 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 (FastAPI + generic Python) - [ ] Documents async vs sync client usage - [ ] Documents which telemetry API version this SDK targets
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
No items
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
jason.woltje
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: mosaic/telemetry-client-py#1
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?