@aethyrion/observatory-cli

🔭 CLI tool for Observatory - self-hosted observability platform

Features

• 🚀 Quick instrumentation of Node.js applications
• 🔍 Auto-detects frameworks (Next.js, Express, NestJS, etc.)
• 📦 Zero-config OpenTelemetry setup
• 🆓 100% free and open source
• 🔒 Self-hosted - your data stays with you

Installation

# Run without installing (recommended)
npx @aethyrion/observatory-cli instrument

# Or install globally
npm install -g @aethyrion/observatory-cli

Usage

Instrument Your Application

Automatically instrument your Node.js application with OpenTelemetry:

# Auto-detect framework and instrument
npx @aethyrion/observatory-cli instrument

# Specify framework explicitly
npx @aethyrion/observatory-cli instrument --framework nextjs

# Custom Observatory URL
npx @aethyrion/observatory-cli instrument --url http://192.168.1.100:3102

# Custom service name
npx @aethyrion/observatory-cli instrument --service my-awesome-app

Check Observatory Status

npx @aethyrion/observatory-cli status

# Check remote Observatory instance
npx @aethyrion/observatory-cli status --url http://192.168.1.100:3101

Supported Frameworks

• ✅ Next.js
• ✅ Express.js
• ✅ NestJS
• ✅ Fastify
• ✅ Koa
• ✅ Generic Node.js

What Gets Instrumented?

The CLI automatically instruments:

• 📝 HTTP requests - Request/response tracking
• 🗄️ Database queries - PostgreSQL, MySQL, MongoDB, etc.
• 🌐 External API calls - Fetch, axios, http/https
• ⚡ Performance metrics - CPU, memory, event loop
• 🔍 Distributed tracing - Full request flow across services

Requirements

• Node.js 18 or higher
• Observatory backend running (see Observatory docs)

How It Works

1. Detects your framework from package.json
2. Installs OpenTelemetry packages as dev dependencies
3. Creates instrumentation configuration files
4. Tests connection to Observatory backend
5. Done! Start your app and see telemetry in Observatory

Example Output

🔭 Observatory Instrumentation Tool

✔ Detecting framework... Detected: Next.js
? Instrument Next.js application? Yes
✔ Installing OpenTelemetry packages...
✔ Creating configuration files...
✔ Testing connection to Observatory... Connected to Observatory!

✅ Instrumentation complete!

Next steps:
  1. Start your app: npm run dev
  2. Open Observatory: http://localhost:3101
  3. Check the services list!

Part of the Aethyrion Ecosystem

Observatory is part of the Aethyrion suite of free, open-source developer tools:

• 🔭 Observatory - Observability platform (replaces Datadog/New Relic)
• 🎨 Helix - AI-powered code generation
• 💎 Prism - ServiceNow development tools

Documentation

• Full Observatory docs: github.com/yourusername/observatory
• Report issues: github.com/yourusername/observatory/issues

License

MIT © Owen

Made with ❤️ to make observability accessible to everyone