@ainvirion/ptelemetry
v0.2.2
Published
JavaScript/TypeScript SDK for ProductTelemetry - privacy-first product analytics
Maintainers
Readme
Product Telemetry SDK (JavaScript/TypeScript)
Privacy-first product analytics and telemetry SDK
Features
- Privacy-first - No IP logging, GDPR compliant, stack traces opt-in
- Event tracking - Lifecycle, usage, and error events
- User identification - Link anonymous users to known IDs
- GDPR deletion - Self-service data deletion requests
- Multiple opt-out mechanisms - DO_NOT_TRACK, browser signals, config
- Zero dependencies - Lightweight, no external deps
- Universal - Works in Node.js 18+ and modern browsers
- Automatic batching - Efficient event queueing and flushing
- Secure by default - HTTPS enforced, cryptographic UUIDs
Installation
npm install @ainvirion/ptelemetryQuick Start
import { Telemetry } from '@ainvirion/ptelemetry';
const telemetry = new Telemetry({
writeKey: 'proj_wk_xxxxx'
});
// Track events
telemetry.track('feature.used', { feature: 'export' });
// Track errors
telemetry.error(new Error('Something went wrong'));
// Link to user
telemetry.identify('user_123');Documentation
- Getting Started - Installation, configuration, troubleshooting
- API Reference - Complete API documentation
- Examples - Real-world usage examples
Links
Contributing
We welcome contributions! Please read our Contributing Guidelines before submitting a pull request.
Development Setup
# Install dependencies
npm install
# Run tests
npm test
# Build package
npm run buildSecurity
If you discover a security vulnerability, please follow our Security Policy.
License
MIT - see LICENSE file for details.
Copyright (c) 2025-2026 AInvirion LLC. All Rights Reserved.
