@egintegrations/telemetry 0.3.0 → 0.3.1

package/README.md

@@ -26,12 +26,37 @@ npx @egintegrations/telemetry init
 ```
 
 The CLI will:
-1. Detect your framework (Next.js, Express, Fastify, or generic)
-2. Prompt for engine name, SKU version, and Control Center URL
-3. Generate configuration file (`.egi/telemetry.json`)
-4. Create integration code (`lib/telemetry.ts` for Next.js, `src/telemetry.ts` for Express)
-5. Add environment variables (`.env.local` or `.env`)
-6. Optionally generate status endpoint boilerplate
+1. Show the EGI ASCII logo and welcome message
+2. Detect your framework (Next.js, Express, Fastify, or generic)
+3. Prompt for engine configuration:
+   - Engine name
+   - Version (semantic version like 1.0.0)
+   - System type (16 options: API, BOT, WA, RAG, ETL, INT, CMS, MA, DA, AI, DB, OP, FX, SDK, CLI, QA)
+   - Platform (25 options: VE, EKS, GKE, NPM, PYPI, etc.)
+4. Generate full SKU automatically (e.g., `1.0.0.API.VE.20260113`)
+5. Create configuration file (`.egi/telemetry.json`)
+6. Create integration code (`lib/telemetry.ts` for Next.js, `telemetry.ts` for Express/Fastify)
+
+### How It Works
+
+1. **Install and configure** (30 seconds)
+2. **Deploy your project** (Vercel, Heroku, K8s, anywhere)
+3. **Engine automatically registers** on first startup
+4. **View in dashboard**: https://control-center.egintegrations.com/ui
+
+No manual configuration. No YAML files. Just install, configure, and deploy!
+
+### SKU Format
+
+SKUs follow the format: `VERSION.TYPE.PLATFORM.DATE`
+
+**Example:** `1.0.0.API.VE.20260113`
+- **VERSION**: Semantic version (1.0.0, 2.1.3, etc.)
+- **TYPE**: System type - API, BOT, WA, RAG, ETL, INT, CMS, MA, DA, AI, DB, OP, FX, SDK, CLI, QA
+- **PLATFORM**: Deployment platform - VE (Vercel), EKS, GKE, NPM, PYPI, etc.
+- **DATE**: Auto-generated timestamp (YYYYMMDD)
+
+The CLI will guide you through selecting the appropriate type and platform for your project.
 
 ### Non-Interactive Setup
 
@@ -40,9 +65,10 @@ For CI/CD or automated setups:
 ```bash
 npx @egintegrations/telemetry init \
   --engine my-engine \
-  --sku 1.0.0 \
-  --url https://control-center.egintegrations.com \
-  --token your-auth-token
+  --version 1.0.0 \
+  --type API \
+  --platform VE \
+  --url https://control-center.egintegrations.com
 ```
 
 ### CLI Options
@@ -50,15 +76,16 @@ npx @egintegrations/telemetry init \
 | Option | Description | Default |
 |--------|-------------|---------|
 | `--engine <name>` | Engine name (required) | - |
-| `--sku <version>` | SKU version (required) | - |
-| `--url <url>` | Control Center URL (required) | - |
+| `--version <version>` | Semantic version (required) | - |
+| `--type <type>` | System type (API, BOT, WA, etc.) | - |
+| `--platform <platform>` | Platform (VE, EKS, NPM, etc.) | - |
+| `--url <url>` | Control Center URL | `https://control-center.egintegrations.com` |
 | `--token <token>` | Auth token (optional) | - |
 | `--modules <modules>` | Comma-separated module list | - |
 | `--output <path>` | Config file location | `.egi/telemetry.json` |
 | `--framework <type>` | Force framework type (nextjs, express, fastify, generic) | Auto-detected |
 | `--no-interactive` | Skip prompts, fail on missing args | Interactive mode |
 | `--no-codegen` | Only generate config file | Code generation enabled |
-| `--status-endpoint` | Generate status endpoint boilerplate | false |
 
 ### Framework-Specific Examples
 
@@ -66,18 +93,26 @@ npx @egintegrations/telemetry init \
 
 ```bash
 cd my-nextjs-app
+npm install @egintegrations/telemetry
 npx @egintegrations/telemetry init
+# Select: 1.0.0, API type, VE platform
+
+# Deploy to Vercel
+vercel deploy --prod
+
+# Check dashboard - engine appears automatically!
+# https://control-center.egintegrations.com/ui
 ```
 
 **Generated Files:**
-- `.egi/telemetry.json` - Configuration
-- `lib/telemetry.ts` - Telemetry client singleton
-- `.env.local` - Environment variables
-- `app/api/engine-status/route.ts` - Status endpoint (if requested)
+- `.egi/telemetry.json` - Configuration with full SKU
+- `lib/telemetry.ts` - Telemetry client singleton (auto-registers on import)
 
 **Usage in Next.js:**
 ```typescript
-// app/api/data/route.ts
+// The telemetry client is already registered automatically
+// Just import and use when you need custom metrics:
+
 import telemetry from '@/lib/telemetry';
 
 export async function GET() {
@@ -93,35 +128,38 @@ export async function GET() {
 
 ```bash
 cd my-express-app
+npm install @egintegrations/telemetry
 npx @egintegrations/telemetry init
+# Select: 1.0.0, API type, EKS platform
+
+# Deploy however you normally deploy
+npm start
 ```
 
 **Generated Files:**
-- `.egi/telemetry.json` - Configuration
-- `src/telemetry.ts` - Telemetry client
-- `.env` - Environment variables
-- `src/routes/status.ts` - Status endpoint (if requested)
+- `.egi/telemetry.json` - Configuration with full SKU
+- `telemetry.ts` - Telemetry client with health endpoint
 
 **Usage in Express:**
 ```typescript
-// src/index.ts
+// telemetry.ts already sets up /.well-known/engine-status endpoint
+// and registers on startup. Just import and use:
+
 import express from 'express';
 import telemetry from './telemetry';
 
 const app = express();
 
-// Auto-track requests
+// Optional: Auto-track requests
 app.use(telemetry.middleware());
 
-// Use in routes
+// Use in routes for custom metrics
 app.get('/data', async (req, res) => {
   await telemetry.sendMetrics({ metrics: { requests: 1 } });
   res.json({ ok: true });
 });
 
-app.listen(3000, async () => {
-  await telemetry.register();
-});
+app.listen(3000);
 ```
 
 ## Manual Setup (Advanced)
@@ -136,13 +174,13 @@ import { TelemetryClient } from '@egintegrations/telemetry';
 // Initialize the client
 const telemetry = new TelemetryClient({
   engineName: 'my-awesome-engine',
-  skuVersion: '1.0.0',
+  skuVersion: '1.0.0.API.VE.20260113', // Full SKU format: VERSION.TYPE.PLATFORM.DATE
   controlCenterUrl: 'https://control-center.egintegrations.com',
   authToken: 'optional-auth-token', // Optional
   enabled: true, // Default: true
 });
 
-// Register your engine
+// Register your engine (auto-creates engine in dashboard)
 await telemetry.register({
   environment: 'production',
   region: 'us-east-1',
@@ -179,14 +217,16 @@ import { TelemetryClient } from '@egintegrations/telemetry';
 const app = express();
 const telemetry = new TelemetryClient({
   engineName: 'api-server',
-  skuVersion: '1.0.0',
+  skuVersion: '1.0.0.API.EKS.20260113', // Full SKU format
   controlCenterUrl: 'https://control-center.egintegrations.com',
 });
 
 // Automatic request metrics
 app.use(telemetry.middleware());
 
-app.listen(3000);
+app.listen(3000, async () => {
+  await telemetry.register(); // Auto-registers in dashboard
+});
 ```
 
 ### Automatic Health Checks
@@ -215,7 +255,7 @@ process.on('SIGTERM', async () => {
 #### Constructor Options
 
 - `engineName` (string, required) - Unique name for your engine
-- `skuVersion` (string, required) - Version of your engine (e.g., "1.0.0")
+- `skuVersion` (string, required) - Full SKU (e.g., "1.0.0.API.VE.20260113")
 - `controlCenterUrl` (string, required) - URL of your control center
 - `authToken` (string, optional) - Authentication token if required
 - `enabled` (boolean, optional) - Enable/disable telemetry (default: true)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@egintegrations/telemetry",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "Telemetry SDK for EGIntegrations client engines",
   "main": "dist/index.js",
   "module": "dist/index.mjs",