@manifest-cyber/observability-ts 0.2.0 → 0.2.2

package/package.json

@@ -1,16 +1,13 @@
 {
   "name": "@manifest-cyber/observability-ts",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "Unified observability library for Manifest Cyber services - Metrics (Prometheus) and Tracing (OpenTelemetry)",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "repository": "https://github.com/manifest-cyber/observability-ts",
   "files": [
     "dist",
-    "README.md",
-    "TRACING_GUIDE.md",
-    "TRACING_IMPLEMENTATION_PLAN.md",
-    "MIGRATION_GUIDE.md"
+    "README.md"
   ],
   "exports": {
     ".": {

package/MIGRATION_GUIDE.md

@@ -1,299 +0,0 @@
-# Migration Guide: @manifest-cyber/metrics → @manifest-cyber/observability-ts
-
-## Overview
-
-The `@manifest-cyber/metrics` package has been renamed and expanded to `@manifest-cyber/observability-ts`, now including both **Prometheus metrics** and **OpenTelemetry distributed tracing**.
-
-**All existing metrics code is fully backward compatible.** No breaking changes to your metrics implementation.
-
----
-
-## Quick Migration
-
-### 1. Update Dependencies
-
-```bash
-# Remove old package
-npm uninstall @manifest-cyber/metrics
-
-# Install new package
-npm install @manifest-cyber/observability-ts
-
-# Install tracing peer dependencies (optional, only if using tracing)
-npm install @opentelemetry/sdk-node @opentelemetry/exporter-trace-otlp-grpc
-```
-
-### 2. Update Imports
-
-```typescript
-// Before
-import { createCounter, startMetricsServer } from '@manifest-cyber/metrics';
-
-// After - Option 1: Same imports work!
-import { createCounter, startMetricsServer } from '@manifest-cyber/observability-ts';
-
-// After - Option 2: Tree-shakeable (recommended)
-import {
-  createCounter,
-  startMetricsServer,
-} from '@manifest-cyber/observability-ts/metrics';
-```
-
-### 3. No Code Changes Required
-
-All your existing metrics code continues to work exactly as before:
-
-```typescript
-const requestsTotal = createCounter({
-  name: 'http_requests',
-  help: 'Total HTTP requests',
-  labelNames: ['method', 'status'],
-});
-
-startMetricsServer({ serviceName: 'my-service' });
-
-requestsTotal.inc({ method: 'GET', status: '200' });
-// ✅ Works exactly the same!
-```
-
----
-
-## What's Changed
-
-### Package Name
-
-- **Old**: `@manifest-cyber/metrics`
-- **New**: `@manifest-cyber/observability-ts`
-
-### Repository Name
-
-- **Old**: `https://github.com/manifest-cyber/metrics-ts`
-- **New**: `https://github.com/manifest-cyber/observability-ts`
-
-### What's Added
-
-- ✨ OpenTelemetry distributed tracing
-- ✨ W3C Trace Context propagation
-- ✨ OTLP export to VictoriaTraces
-- ✨ Integration with logger-ts for trace correlation
-- ✨ Message queue trace propagation helpers
-
-### What Hasn't Changed
-
-- ✅ All metrics APIs (createCounter, createHistogram, createGauge)
-- ✅ All instrumentation helpers (Timer, MetricsContext, trackOperation)
-- ✅ Metrics server setup
-- ✅ Bucket configurations
-- ✅ Environment variables
-
----
-
-## Step-by-Step Migration
-
-### Step 1: Update package.json
-
-```diff
-{
-  "dependencies": {
--   "@manifest-cyber/metrics": "^0.1.0",
-+   "@manifest-cyber/observability-ts": "^0.2.0"
-  }
-}
-```
-
-### Step 2: Run npm install
-
-```bash
-npm install
-```
-
-### Step 3: Update imports across your codebase
-
-#### Find all imports:
-
-```bash
-grep -r "@manifest-cyber/metrics" --include="*.ts" --include="*.js"
-```
-
-#### Replace with:
-
-```typescript
-// Option 1: Main export (everything)
-import { createCounter } from '@manifest-cyber/observability-ts';
-
-// Option 2: Metrics-only (tree-shakeable)
-import { createCounter } from '@manifest-cyber/observability-ts/metrics';
-```
-
-### Step 4: Test
-
-```bash
-npm test
-npm run build
-```
-
-Your application should work exactly as before!
-
----
-
-## Optional: Add Tracing
-
-Once migrated, you can optionally add distributed tracing:
-
-### 1. Install peer dependencies
-
-```bash
-npm install @opentelemetry/sdk-node @opentelemetry/exporter-trace-otlp-grpc
-```
-
-### 2. Initialize tracing
-
-```typescript
-import { initTracing } from '@manifest-cyber/observability-ts';
-
-// Add at application startup
-await initTracing({
-  serviceName: process.env.SERVICE_NAME,
-  exporter: {
-    endpoint: process.env.OTEL_EXPORTER_OTLP_ENDPOINT || 'http://localhost:4317',
-  },
-});
-```
-
-### 3. Add spans to your code
-
-```typescript
-import { withSpan } from '@manifest-cyber/observability-ts';
-
-await withSpan('operation.name', async () => {
-  // Your existing code
-  return await doWork();
-});
-```
-
-See [TRACING_GUIDE.md](./TRACING_GUIDE.md) for complete tracing documentation.
-
----
-
-## NPM Package Status
-
-### Old Package: @manifest-cyber/metrics
-
-The old package is **deprecated** on NPM:
-
-```bash
-npm deprecate @manifest-cyber/metrics "*" "Package renamed to @manifest-cyber/observability-ts"
-```
-
-When users try to install the old package, they'll see:
-
-```
-npm WARN deprecated @manifest-cyber/metrics@0.1.0: Package renamed to @manifest-cyber/observability-ts
-```
-
-### New Package: @manifest-cyber/observability-ts
-
-Published and ready to use:
-
-```bash
-npm install @manifest-cyber/observability-ts
-```
-
----
-
-## Environment Variables
-
-No changes to existing environment variables:
-
-| Variable            | Purpose                             | Default             |
-| ------------------- | ----------------------------------- | ------------------- |
-| `SERVICE_NAME`      | Service name for metrics and traces | `'unknown-service'` |
-| `MFST_METRICS_PORT` | Metrics server port                 | `9090`              |
-
-**New variables for tracing** (optional):
-| Variable | Purpose | Default |
-|----------|---------|---------|
-| `OTEL_EXPORTER_OTLP_ENDPOINT` | OTLP exporter endpoint | `'http://localhost:4317'` |
-| `OTEL_TRACING_ENABLED` | Enable/disable tracing | `true` |
-| `ENV` | Environment (dev/staging/prod) | `'development'` |
-
----
-
-## Breaking Changes
-
-**None!** This is a backward-compatible migration.
-
-The only "breaking" change is the package name itself, but all APIs remain unchanged.
-
----
-
-## Rollback Plan
-
-If you encounter issues, you can roll back:
-
-```bash
-npm uninstall @manifest-cyber/observability-ts
-npm install @manifest-cyber/metrics@0.1.0
-```
-
-Then revert your import changes.
-
----
-
-## Update Checklist
-
-- [ ] Update `package.json` with new package name
-- [ ] Run `npm install`
-- [ ] Update all imports from `@manifest-cyber/metrics` to `@manifest-cyber/observability-ts`
-- [ ] Run tests to verify functionality
-- [ ] Build and deploy to development environment
-- [ ] Verify metrics still appear in Grafana
-- [ ] (Optional) Add tracing configuration
-- [ ] (Optional) Update CI/CD pipelines with new package name
-- [ ] Update team documentation
-
----
-
-## Services to Update
-
-All services currently using `@manifest-cyber/metrics`:
-
-```bash
-# Find all services with the old package
-cd /Users/codymoore/Workspace/manifest
-grep -l "@manifest-cyber/metrics" */package.json
-
-# Example services:
-# - manifest-api
-# - job-sbom-process
-# - job-vulnerability-match
-# - job-component-process
-# - chronotrigger
-# - (etc.)
-```
-
----
-
-## Timeline
-
-| Phase       | Duration | Description                                              |
-| ----------- | -------- | -------------------------------------------------------- |
-| **Phase 1** | Week 1   | Publish `observability-ts` v0.2.0, deprecate old package |
-| **Phase 2** | Week 2-3 | Migrate all services in development environment          |
-| **Phase 3** | Week 4   | Validate in staging                                      |
-| **Phase 4** | Week 5   | Production rollout                                       |
-
----
-
-## Support
-
-For questions or issues:
-
-- GitHub Issues: [observability-ts/issues](https://github.com/manifest-cyber/observability-ts/issues)
-- Platform Team: Contact via Slack #platform-team
-- Documentation: See [README.md](./README.md) and [TRACING_GUIDE.md](./TRACING_GUIDE.md)
-
----
-
-**Document Owner**: Platform Team  
-**Last Updated**: November 11, 2025