securenow 5.0.0 → 5.0.2

package/docs/INDEX.md

@@ -1,147 +1,206 @@
-# SecureNow Documentation
-
-Complete documentation for SecureNow - OpenTelemetry instrumentation for Node.js and Next.js with tracing and logging.
-
-## 📚 Table of Contents
-
-### 🚀 Getting Started
-
-- **[Customer Guide](CUSTOMER-GUIDE.md)** - Quick start guide for customers
-- **[Auto Setup](AUTO-SETUP.md)** - Automated setup instructions
-- **[Auto Setup Summary](AUTO-SETUP-SUMMARY.md)** - Summary of auto-setup features
-
-### 📋 Logging
-
-- **[Logging Quick Start](LOGGING-QUICKSTART.md)** - Add logging to your app in 2 minutes
-- **[Logging Complete Guide](LOGGING-GUIDE.md)** - Full logging setup for all frameworks
-  - Express.js logging examples
-  - Next.js logging examples
-  - Fastify logging examples
-  - NestJS logging examples
-  - Console instrumentation
-  - Direct logger API usage
-
-### 📦 Next.js Integration
-
-- **[Next.js Guide](NEXTJS-GUIDE.md)** - Complete Next.js integration guide
-- **[Next.js Quickstart](NEXTJS-QUICKSTART.md)** - Quick setup for Next.js
-- **[Easiest Setup](EASIEST-SETUP.md)** - Simplest way to get started with Next.js
-- **[Vercel OTel Migration](VERCEL-OTEL-MIGRATION.md)** - Migrating to @vercel/otel
-- **[Next.js Webpack Warnings](NEXTJS-WEBPACK-WARNINGS.md)** - Fixing webpack bundling issues
-
-### 🔍 Request Body Capture
-
-- **[Request Body Capture](REQUEST-BODY-CAPTURE.md)** - Overview of body capture features
-- **[Body Capture Quickstart](BODY-CAPTURE-QUICKSTART.md)** - Quick start for body capture
-- **[Quickstart Body Capture](QUICKSTART-BODY-CAPTURE.md)** - Alternative quickstart
-- **[Auto Body Capture](AUTO-BODY-CAPTURE.md)** - Automatic body capture for Next.js
-- **[Body Capture Fix](BODY-CAPTURE-FIX.md)** - Troubleshooting body capture issues
-- **[Final Solution](FINAL-SOLUTION.md)** - Complete body capture solution
-
-### 🔐 Next.js Body Capture
-
-- **[Next.js Body Capture](NEXTJS-BODY-CAPTURE.md)** - Body capture specifically for Next.js
-- **[Next.js Body Capture Comparison](NEXTJS-BODY-CAPTURE-COMPARISON.md)** - Compare different approaches
-- **[Next.js Wrapper Approach](NEXTJS-WRAPPER-APPROACH.md)** - Using wrapper functions
-
-### 🛡️ Security & Privacy
-
-- **[Redaction Examples](REDACTION-EXAMPLES.md)** - How sensitive data is redacted
-- **[Automatic IP Capture](AUTOMATIC-IP-CAPTURE.md)** - IP address and metadata collection
-
-### 🖥️ Express.js & Node.js
-
-- **[Express Body Capture](EXPRESS-BODY-CAPTURE.md)** - Body capture for Express.js with PM2
-  - Supports both JavaScript and TypeScript
-  - PM2 clustering setup
-  - Complete examples
-
-### 📊 Architecture & Implementation
-
-- **[Architecture](ARCHITECTURE.md)** - System architecture overview
-- **[Implementation Summary](IMPLEMENTATION-SUMMARY.md)** - Implementation details
-- **[Solution Summary](SOLUTION-SUMMARY.md)** - Summary of all solutions
-- **[Completion Report](COMPLETION-REPORT.md)** - Project completion status
-- **[Changelog - Next.js](CHANGELOG-NEXTJS.md)** - Next.js integration changelog
-
----
-
-## 🎯 Quick Links by Use Case
-
-### "I want to add logging to my app"
-1. Start with [Logging Quick Start](LOGGING-QUICKSTART.md)
-2. For complete guide: [Logging Complete Guide](LOGGING-GUIDE.md)
-3. Works with Express, Next.js, Fastify, NestJS, and all Node.js frameworks
-
-### "I want to add tracing to my Next.js app"
-1. Start with [Next.js Quickstart](NEXTJS-QUICKSTART.md)
-2. For automatic setup: [Auto Setup](AUTO-SETUP.md)
-3. For easiest method: [Easiest Setup](EASIEST-SETUP.md)
-
-### "I want to capture request bodies in Next.js"
-1. Read [Next.js Body Capture](NEXTJS-BODY-CAPTURE.md)
-2. Choose approach: [Next.js Body Capture Comparison](NEXTJS-BODY-CAPTURE-COMPARISON.md)
-3. Implement: [Auto Body Capture](AUTO-BODY-CAPTURE.md)
-
-### "I want to use this with Express.js and PM2"
-1. Read [Express Body Capture](EXPRESS-BODY-CAPTURE.md)
-2. Check [Request Body Capture](REQUEST-BODY-CAPTURE.md) for general info
-
-### "I need to capture IP addresses and headers"
-1. Read [Automatic IP Capture](AUTOMATIC-IP-CAPTURE.md)
-2. Understand redaction: [Redaction Examples](REDACTION-EXAMPLES.md)
-
-### "I'm getting errors or warnings"
-1. Webpack issues: [Next.js Webpack Warnings](NEXTJS-WEBPACK-WARNINGS.md)
-2. Body capture issues: [Body Capture Fix](BODY-CAPTURE-FIX.md)
-3. Check [Final Solution](FINAL-SOLUTION.md) for latest fixes
-
----
-
-## 📖 Documentation Overview
-
-### Complete Guides (Read First)
-- Customer Guide
-- Logging Complete Guide
-- Next.js Guide
-- Express Body Capture
-
-### Quick References
-- Logging Quick Start
-- Next.js Quickstart
-- Body Capture Quickstart
-- Easiest Setup
-
-### Technical Deep Dives
-- Architecture
-- Implementation Summary
-- Vercel OTel Migration
-
-### Problem Solving
-- Body Capture Fix
-- Next.js Webpack Warnings
-- Redaction Examples
-
----
-
-## 🔗 External Resources
-
-- [Main README](../README.md) - Package overview
-- [Examples](../examples/) - Code examples
-- [npm Package](https://www.npmjs.com/package/securenow)
-- [OpenTelemetry Docs](https://opentelemetry.io/)
-- [SigNoz](https://signoz.io/)
-
----
-
-## 💡 Need Help?
-
-1. Check the relevant guide above
-2. Look at [Examples](../examples/)
-3. Review [Troubleshooting sections](BODY-CAPTURE-FIX.md)
-4. Check [Architecture](ARCHITECTURE.md) for system design
-
----
-
-**Last Updated:** March 18, 2026  
-**Package Version:** 4.0.12
+# SecureNow Documentation
+
+Complete documentation for SecureNow - OpenTelemetry instrumentation for Node.js and Next.js with tracing and logging.
+
+## 📚 Table of Contents
+
+### 🚀 Getting Started
+
+- **[NPM Package Documentation](../NPM_README.md)** - Complete npm package documentation
+- **[All Frameworks Quick Start](ALL-FRAMEWORKS-QUICKSTART.md)** - Universal 5-minute setup
+- **[Consuming Apps Guide](../CONSUMING-APPS-GUIDE.md)** - Simple guide for developers
+- **[Customer Guide](CUSTOMER-GUIDE.md)** - Quick start guide for customers
+- **[Auto Setup](AUTO-SETUP.md)** - Automated setup instructions
+- **[Auto Setup Summary](AUTO-SETUP-SUMMARY.md)** - Summary of auto-setup features
+
+### 📋 Logging
+
+- **[Logging Quick Start](LOGGING-QUICKSTART.md)** - Add logging to your app in 2 minutes
+- **[Logging Complete Guide](LOGGING-GUIDE.md)** - Full logging setup for all frameworks
+  - Express.js logging examples
+  - Next.js logging examples
+  - Fastify logging examples
+  - NestJS logging examples
+  - Console instrumentation
+  - Direct logger API usage
+
+### 🎯 Framework-Specific Guides
+
+- **[Express.js Complete Setup](EXPRESS-SETUP-GUIDE.md)** - Step-by-step Express.js guide
+  - Basic setup
+  - TypeScript setup
+  - PM2 configuration
+  - Docker setup
+  - Complete examples
+- **[Next.js Complete Setup](NEXTJS-SETUP-COMPLETE.md)** - Step-by-step Next.js guide
+  - App Router setup
+  - Pages Router setup
+  - API routes examples
+  - Server components
+  - Middleware
+  - Deployment guides
+
+### 📦 Next.js Integration
+
+- **[Next.js Guide](NEXTJS-GUIDE.md)** - Complete Next.js integration guide
+- **[Next.js Quickstart](NEXTJS-QUICKSTART.md)** - Quick setup for Next.js
+- **[Easiest Setup](EASIEST-SETUP.md)** - Simplest way to get started with Next.js
+- **[Vercel OTel Migration](VERCEL-OTEL-MIGRATION.md)** - Migrating to @vercel/otel
+- **[Next.js Webpack Warnings](NEXTJS-WEBPACK-WARNINGS.md)** - Fixing webpack bundling issues
+
+### 🔍 Request Body Capture
+
+- **[Request Body Capture](REQUEST-BODY-CAPTURE.md)** - Overview of body capture features
+- **[Body Capture Quickstart](BODY-CAPTURE-QUICKSTART.md)** - Quick start for body capture
+- **[Quickstart Body Capture](QUICKSTART-BODY-CAPTURE.md)** - Alternative quickstart
+- **[Auto Body Capture](AUTO-BODY-CAPTURE.md)** - Automatic body capture for Next.js
+- **[Body Capture Fix](BODY-CAPTURE-FIX.md)** - Troubleshooting body capture issues
+- **[Final Solution](FINAL-SOLUTION.md)** - Complete body capture solution
+
+### ⚙️ Configuration
+
+- **[Environment Variables Complete Reference](ENVIRONMENT-VARIABLES.md)** - All variables explained
+  - Required variables
+  - Optional variables
+  - Configuration examples
+  - Best practices
+  - Priority and overrides
+
+### 🔐 Next.js Body Capture
+
+- **[Next.js Body Capture](NEXTJS-BODY-CAPTURE.md)** - Body capture specifically for Next.js
+- **[Next.js Body Capture Comparison](NEXTJS-BODY-CAPTURE-COMPARISON.md)** - Compare different approaches
+- **[Next.js Wrapper Approach](NEXTJS-WRAPPER-APPROACH.md)** - Using wrapper functions
+
+### 🛡️ Security & Privacy
+
+- **[Redaction Examples](REDACTION-EXAMPLES.md)** - How sensitive data is redacted
+- **[Automatic IP Capture](AUTOMATIC-IP-CAPTURE.md)** - IP address and metadata collection
+
+### 🖥️ Express.js & Node.js
+
+- **[Express Body Capture](EXPRESS-BODY-CAPTURE.md)** - Body capture for Express.js with PM2
+  - Supports both JavaScript and TypeScript
+  - PM2 clustering setup
+  - Complete examples
+
+### 📊 Architecture & Implementation
+
+- **[Architecture](ARCHITECTURE.md)** - System architecture overview
+- **[Implementation Summary](IMPLEMENTATION-SUMMARY.md)** - Implementation details
+- **[Solution Summary](SOLUTION-SUMMARY.md)** - Summary of all solutions
+- **[Completion Report](COMPLETION-REPORT.md)** - Project completion status
+- **[Changelog - Next.js](CHANGELOG-NEXTJS.md)** - Next.js integration changelog
+
+---
+
+## 🎯 Quick Links by Use Case
+
+### "I want to set up monitoring and logging for any framework"
+1. Start with [NPM Package Documentation](../NPM_README.md)
+2. Quick setup: [All Frameworks Quick Start](ALL-FRAMEWORKS-QUICKSTART.md)
+3. Simple guide: [Consuming Apps Guide](../CONSUMING-APPS-GUIDE.md)
+4. All variables: [Environment Variables Reference](ENVIRONMENT-VARIABLES.md)
+
+### "I'm using Express.js"
+1. Quick start: [All Frameworks Quick Start](ALL-FRAMEWORKS-QUICKSTART.md#expressjs)
+2. Complete guide: [Express.js Setup Guide](EXPRESS-SETUP-GUIDE.md)
+3. Includes PM2, Docker, TypeScript examples
+
+### "I'm using Next.js"
+1. Quick start: [All Frameworks Quick Start](ALL-FRAMEWORKS-QUICKSTART.md#nextjs-app-router)
+2. Complete guide: [Next.js Setup Complete](NEXTJS-SETUP-COMPLETE.md)
+3. Legacy guide: [Next.js Quickstart](NEXTJS-QUICKSTART.md)
+
+### "I want to add logging to my app"
+1. Start with [Logging Quick Start](LOGGING-QUICKSTART.md)
+2. For complete guide: [Logging Complete Guide](LOGGING-GUIDE.md)
+3. Works with Express, Next.js, Fastify, NestJS, and all Node.js frameworks
+
+### "I want to capture request bodies in Next.js"
+1. Read [Next.js Body Capture](NEXTJS-BODY-CAPTURE.md)
+2. Choose approach: [Next.js Body Capture Comparison](NEXTJS-BODY-CAPTURE-COMPARISON.md)
+3. Implement: [Auto Body Capture](AUTO-BODY-CAPTURE.md)
+
+### "I want to use this with Express.js and PM2"
+1. Read [Express Body Capture](EXPRESS-BODY-CAPTURE.md)
+2. Check [Request Body Capture](REQUEST-BODY-CAPTURE.md) for general info
+
+### "I need to capture IP addresses and headers"
+1. Read [Automatic IP Capture](AUTOMATIC-IP-CAPTURE.md)
+2. Understand redaction: [Redaction Examples](REDACTION-EXAMPLES.md)
+
+### "I'm getting errors or warnings"
+1. Webpack issues: [Next.js Webpack Warnings](NEXTJS-WEBPACK-WARNINGS.md)
+2. Body capture issues: [Body Capture Fix](BODY-CAPTURE-FIX.md)
+3. Check [Final Solution](FINAL-SOLUTION.md) for latest fixes
+
+---
+
+## 📖 Documentation Overview
+
+### NPM Package Documentation (Start Here)
+- **NPM Package Documentation** - Complete reference for npm users
+- **All Frameworks Quick Start** - Universal 5-minute setup
+- **Consuming Apps Guide** - Simple step-by-step guide
+- **Environment Variables Reference** - All configuration options
+
+### Complete Framework Guides
+- **Express.js Setup Guide** - Complete Express.js reference
+- **Next.js Setup Complete** - Complete Next.js reference
+- **Logging Complete Guide** - Complete logging reference
+
+### Quick Start Guides
+- **Logging Quick Start** - 2-minute logging setup
+- **All Frameworks Quick Start** - 5-minute universal setup
+- **Next.js Quickstart** - Legacy Next.js quick start
+- **Body Capture Quickstart** - Quick body capture setup
+
+### Technical Deep Dives
+- Architecture
+- Implementation Summary
+- Vercel OTel Migration
+
+### Problem Solving
+- Body Capture Fix
+- Next.js Webpack Warnings
+- Redaction Examples
+
+---
+
+## 🔗 External Resources
+
+- [Main README](../README.md) - Package overview
+- [NPM README](../NPM_README.md) - NPM package documentation
+- [Consuming Apps Guide](../CONSUMING-APPS-GUIDE.md) - Developer setup guide
+- [Examples](../examples/) - Code examples
+- [npm Package](https://www.npmjs.com/package/securenow)
+- [OpenTelemetry Docs](https://opentelemetry.io/)
+
+---
+
+## 💡 Need Help?
+
+1. Check the relevant guide above
+2. Look at [Examples](../examples/)
+3. Review [Troubleshooting sections](BODY-CAPTURE-FIX.md)
+4. Check [Architecture](ARCHITECTURE.md) for system design
+
+---
+
+---
+
+## 📦 NPM Package Files
+
+Key documentation files included in the npm package:
+
+- `NPM_README.md` - Complete npm package documentation
+- `CONSUMING-APPS-GUIDE.md` - Simple developer guide
+- `README.md` - Package overview
+- `docs/` - All guides and references
+- `examples/` - Code examples
+
+---
+
+**Last Updated:** March 18, 2026  
+**Package Version:** 4.0.12+