securenow 3.0.14 → 4.0.2

package/cli.js

@@ -0,0 +1,264 @@
+#!/usr/bin/env node
+'use strict';
+
+/**
+ * SecureNow CLI
+ * 
+ * Usage: npx securenow init [options]
+ */
+
+const fs = require('fs');
+const path = require('path');
+
+const commands = {
+  init: initCommand,
+  help: helpCommand,
+  version: versionCommand,
+};
+
+// Templates
+const templates = {
+  typescript: `import { registerSecureNow } from 'securenow/nextjs';
+
+export function register() {
+  registerSecureNow();
+}
+
+/**
+ * Configuration via .env.local:
+ * 
+ * Required:
+ *   SECURENOW_APPID=my-nextjs-app
+ * 
+ * Optional:
+ *   SECURENOW_INSTANCE=http://your-signoz-server:4318
+ *   OTEL_EXPORTER_OTLP_HEADERS="x-api-key=your-key"
+ *   OTEL_LOG_LEVEL=info
+ */
+`,
+  javascript: `const { registerSecureNow } = require('securenow/nextjs');
+
+export function register() {
+  registerSecureNow();
+}
+
+/**
+ * Configuration via .env.local:
+ * 
+ * Required:
+ *   SECURENOW_APPID=my-nextjs-app
+ * 
+ * Optional:
+ *   SECURENOW_INSTANCE=http://your-signoz-server:4318
+ *   OTEL_EXPORTER_OTLP_HEADERS="x-api-key=your-key"
+ *   OTEL_LOG_LEVEL=info
+ */
+`,
+  env: `# SecureNow Configuration
+# Required: Your application identifier
+SECURENOW_APPID=my-nextjs-app
+
+# Optional: Your SigNoz/OpenTelemetry collector endpoint
+# Default: http://46.62.173.237:4318
+SECURENOW_INSTANCE=http://your-signoz-server:4318
+
+# Optional: API key or authentication headers
+# OTEL_EXPORTER_OTLP_HEADERS="x-api-key=your-api-key-here"
+
+# Optional: Log level (debug|info|warn|error)
+# OTEL_LOG_LEVEL=info
+`,
+};
+
+function initCommand(args) {
+  const flags = parseFlags(args);
+  const cwd = process.cwd();
+  
+  console.log('\n🚀 SecureNow Setup\n');
+  
+  // Check if Next.js project
+  const isNextJs = isNextJsProject(cwd);
+  if (!isNextJs && !flags.force) {
+    console.log('⚠️  This doesn\'t appear to be a Next.js project.');
+    console.log('   If you want to proceed anyway, use: npx securenow init --force\n');
+    process.exit(1);
+  }
+  
+  // Determine TypeScript or JavaScript
+  const useTypeScript = flags.typescript || 
+                        (!flags.javascript && fs.existsSync(path.join(cwd, 'tsconfig.json')));
+  
+  // Determine if using src folder
+  const useSrc = flags.src || 
+                 (!flags.root && fs.existsSync(path.join(cwd, 'src')));
+  
+  // Construct file paths
+  const fileName = useTypeScript ? 'instrumentation.ts' : 'instrumentation.js';
+  const filePath = useSrc 
+    ? path.join(cwd, 'src', fileName)
+    : path.join(cwd, fileName);
+  
+  // Check if file already exists
+  if (fs.existsSync(filePath) && !flags.force) {
+    console.log(`❌ ${useSrc ? 'src/' : ''}${fileName} already exists`);
+    console.log('   Use --force to overwrite\n');
+    process.exit(1);
+  }
+  
+  // Create instrumentation file
+  try {
+    const template = useTypeScript ? templates.typescript : templates.javascript;
+    
+    // Ensure src directory exists if needed
+    if (useSrc) {
+      fs.mkdirSync(path.join(cwd, 'src'), { recursive: true });
+    }
+    
+    fs.writeFileSync(filePath, template, 'utf8');
+    console.log(`✅ Created ${useSrc ? 'src/' : ''}${fileName}`);
+  } catch (error) {
+    console.error(`❌ Failed to create instrumentation file: ${error.message}\n`);
+    process.exit(1);
+  }
+  
+  // Create .env.local if it doesn't exist
+  const envPath = path.join(cwd, '.env.local');
+  if (!fs.existsSync(envPath) || flags.force) {
+    try {
+      fs.writeFileSync(envPath, templates.env, 'utf8');
+      console.log('✅ Created .env.local template');
+    } catch (error) {
+      console.warn(`⚠️  Could not create .env.local: ${error.message}`);
+    }
+  } else {
+    console.log('ℹ️  .env.local already exists (skipped)');
+  }
+  
+  // Success message
+  console.log('\n┌─────────────────────────────────────────────────┐');
+  console.log('│  🎉 Setup Complete!                             │');
+  console.log('│                                                 │');
+  console.log('│  Next steps:                                    │');
+  console.log('│                                                 │');
+  console.log('│  1. Edit .env.local and configure:             │');
+  console.log('│     SECURENOW_APPID=your-app-name              │');
+  console.log('│     SECURENOW_INSTANCE=http://signoz:4318      │');
+  console.log('│                                                 │');
+  console.log('│  2. Start your Next.js app: npm run dev        │');
+  console.log('│                                                 │');
+  console.log('│  3. Check SigNoz dashboard for traces!         │');
+  console.log('│                                                 │');
+  console.log('│  📚 Documentation:                              │');
+  console.log('│     node_modules/securenow/NEXTJS-GUIDE.md     │');
+  console.log('└─────────────────────────────────────────────────┘\n');
+}
+
+function helpCommand() {
+  console.log(`
+SecureNow CLI - OpenTelemetry instrumentation for Next.js
+
+USAGE:
+  npx securenow <command> [options]
+
+COMMANDS:
+  init        Initialize SecureNow in your Next.js project
+  help        Show this help message
+  version     Show package version
+
+OPTIONS:
+  --typescript, --ts    Force TypeScript (creates instrumentation.ts)
+  --javascript, --js    Force JavaScript (creates instrumentation.js)
+  --src                 Create file in src/ folder
+  --root                Create file in project root
+  --force, -f           Overwrite existing files
+
+EXAMPLES:
+  # Auto-detect and setup
+  npx securenow init
+
+  # Force TypeScript in src folder
+  npx securenow init --typescript --src
+
+  # Force JavaScript in root
+  npx securenow init --javascript --root
+
+  # Overwrite existing files
+  npx securenow init --force
+
+DOCUMENTATION:
+  Quick Start: node_modules/securenow/NEXTJS-QUICKSTART.md
+  Full Guide:  node_modules/securenow/NEXTJS-GUIDE.md
+  Examples:    node_modules/securenow/examples/
+`);
+}
+
+function versionCommand() {
+  try {
+    const packageJson = require('./package.json');
+    console.log(`securenow v${packageJson.version}`);
+  } catch (error) {
+    console.log('securenow (version unknown)');
+  }
+}
+
+// Utility functions
+function parseFlags(args) {
+  const flags = {};
+  
+  for (let i = 0; i < args.length; i++) {
+    const arg = args[i];
+    
+    if (arg === '--typescript' || arg === '--ts') {
+      flags.typescript = true;
+    } else if (arg === '--javascript' || arg === '--js') {
+      flags.javascript = true;
+    } else if (arg === '--src') {
+      flags.src = true;
+    } else if (arg === '--root') {
+      flags.root = true;
+    } else if (arg === '--force' || arg === '-f') {
+      flags.force = true;
+    }
+  }
+  
+  return flags;
+}
+
+function isNextJsProject(dir) {
+  try {
+    const packageJsonPath = path.join(dir, 'package.json');
+    if (!fs.existsSync(packageJsonPath)) return false;
+    
+    const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
+    const deps = { ...packageJson.dependencies, ...packageJson.devDependencies };
+    
+    return !!deps.next;
+  } catch (error) {
+    return false;
+  }
+}
+
+// Main
+function main() {
+  const args = process.argv.slice(2);
+  const command = args[0] || 'help';
+  const commandFn = commands[command];
+  
+  if (!commandFn) {
+    console.error(`Unknown command: ${command}`);
+    console.log('Run "npx securenow help" for usage\n');
+    process.exit(1);
+  }
+  
+  commandFn(args.slice(1));
+}
+
+if (require.main === module) {
+  main();
+}
+
+module.exports = { main };
+
+
+
+

package/examples/README.md

@@ -0,0 +1,262 @@
+# SecureNow Next.js Examples
+
+This folder contains example files to help you integrate SecureNow with your Next.js application.
+
+---
+
+## 📁 Files
+
+### 1. `nextjs-instrumentation.ts`
+**TypeScript setup (recommended for TS projects)**
+
+Basic Next.js instrumentation setup using TypeScript.
+
+**Usage:**
+1. Copy this file to your project root as `instrumentation.ts`
+2. Set environment variables in `.env.local`
+3. Run your Next.js app
+
+---
+
+### 2. `nextjs-instrumentation.js`
+**JavaScript setup (for JS projects)**
+
+Basic Next.js instrumentation setup using JavaScript.
+
+**Usage:**
+1. Copy this file to your project root as `instrumentation.js`
+2. Set environment variables in `.env.local`
+3. Run your Next.js app
+
+---
+
+### 3. `nextjs-with-options.ts`
+**Advanced configuration with programmatic options**
+
+Shows how to pass configuration options directly to `registerSecureNow()` instead of using only environment variables.
+
+**Usage:**
+1. Copy to project root as `instrumentation.ts`
+2. Customize the options object
+3. Set sensitive values (API keys) via environment variables
+
+**Good for:**
+- Complex configurations
+- Multiple environments
+- Custom headers
+- Selective instrumentation
+
+---
+
+### 4. `nextjs-env-example.txt`
+**Complete environment variables reference**
+
+Lists all available environment variables with explanations.
+
+**Usage:**
+1. Copy contents to your `.env.local` file
+2. Uncomment and set the variables you need
+3. Remove or comment out unused variables
+
+---
+
+### 5. `test-nextjs-setup.js`
+**Test script to verify your setup**
+
+A standalone script to test SecureNow configuration before integrating with Next.js.
+
+**Usage:**
+```bash
+# Test with environment variables
+SECURENOW_APPID=test-app \
+SECURENOW_INSTANCE=http://localhost:4318 \
+node examples/test-nextjs-setup.js
+
+# Or set them in .env first
+node examples/test-nextjs-setup.js
+```
+
+**What it tests:**
+- ✅ Package installation
+- ✅ SDK registration
+- ✅ Span creation
+- ✅ Configuration loading
+- ✅ Export functionality
+
+---
+
+## 🚀 Quick Start Guide
+
+### Step 1: Choose Your Setup
+
+**TypeScript project?** → Use `nextjs-instrumentation.ts`  
+**JavaScript project?** → Use `nextjs-instrumentation.js`  
+**Need advanced config?** → Use `nextjs-with-options.ts`
+
+### Step 2: Copy File
+
+```bash
+# From your project root
+cp node_modules/securenow/examples/nextjs-instrumentation.ts instrumentation.ts
+# or
+cp node_modules/securenow/examples/nextjs-instrumentation.js instrumentation.js
+```
+
+### Step 3: Configure Environment
+
+```bash
+# Copy environment variables template
+cp node_modules/securenow/examples/nextjs-env-example.txt .env.local
+# Edit .env.local with your values
+```
+
+### Step 4: Test (Optional)
+
+```bash
+# Verify setup works
+node node_modules/securenow/examples/test-nextjs-setup.js
+```
+
+### Step 5: Run Your App
+
+```bash
+npm run dev
+```
+
+---
+
+## 📚 Documentation
+
+- **[Quick Start](../NEXTJS-QUICKSTART.md)** - 30-second setup
+- **[Complete Guide](../NEXTJS-GUIDE.md)** - Full documentation
+- **[Customer Guide](../CUSTOMER-GUIDE.md)** - User-friendly guide
+- **[Architecture](../ARCHITECTURE.md)** - Technical details
+
+---
+
+## 💡 Tips
+
+### For Development
+```bash
+# Use simpler service names
+SECURENOW_NO_UUID=1
+SECURENOW_APPID=my-app-dev
+
+# Enable debug logging
+OTEL_LOG_LEVEL=debug
+```
+
+### For Production
+```bash
+# Use descriptive names with UUID
+SECURENOW_APPID=my-app-prod
+# UUID is auto-appended
+
+# Use info or warn level
+OTEL_LOG_LEVEL=info
+```
+
+### For Vercel
+```bash
+# Set in Vercel dashboard:
+SECURENOW_APPID=my-app
+SECURENOW_INSTANCE=http://your-signoz:4318
+OTEL_EXPORTER_OTLP_HEADERS="x-api-key=your-key"
+```
+
+---
+
+## 🆘 Troubleshooting
+
+### "Cannot find module 'securenow/nextjs'"
+
+Make sure you're on the latest version:
+```bash
+npm install securenow@latest
+```
+
+### Traces not appearing
+
+1. Check console for `[securenow] ✅ OpenTelemetry started`
+2. Enable debug mode: `OTEL_LOG_LEVEL=debug`
+3. Run test script: `node examples/test-nextjs-setup.js`
+4. Verify SigNoz accessibility: `curl http://your-signoz:4318/v1/traces`
+
+### Too many spans
+
+Disable noisy instrumentations:
+```bash
+SECURENOW_DISABLE_INSTRUMENTATIONS=fs,dns
+```
+
+---
+
+## 📝 Customization
+
+### Disable Specific Instrumentations
+
+```typescript
+registerSecureNow({
+  disableInstrumentations: ['fs', 'dns', 'net'],
+});
+```
+
+### Add Custom Headers
+
+```typescript
+registerSecureNow({
+  headers: {
+    'x-api-key': process.env.SIGNOZ_API_KEY,
+    'x-environment': process.env.NODE_ENV,
+  },
+});
+```
+
+### Use Different Service Name
+
+```typescript
+registerSecureNow({
+  serviceName: 'my-custom-app-name',
+  noUuid: false, // Still append UUID
+});
+```
+
+---
+
+## 🎯 Next Steps
+
+After setting up:
+
+1. **Run your app** and verify traces appear
+2. **Test key user flows** to see end-to-end tracing
+3. **Check SigNoz dashboard** for service map and traces
+4. **Adjust configuration** based on your needs
+5. **Deploy to production** with proper environment variables
+
+---
+
+## 🌟 Success Looks Like
+
+```bash
+$ npm run dev
+
+[securenow] Next.js integration loading (pid=12345)
+[securenow] 🚀 Next.js App → service.name=my-app-abc123
+[securenow] ✅ OpenTelemetry started for Next.js → http://signoz:4318/v1/traces
+
+✓ Ready in 1.2s
+```
+
+Then in SigNoz:
+- ✅ See your service in service map
+- ✅ View traces for requests
+- ✅ Analyze performance metrics
+- ✅ Debug issues with distributed tracing
+
+---
+
+**Happy tracing! 🎉**
+
+
+
+

package/examples/next.config.js

@@ -0,0 +1,34 @@
+/**
+ * Example Next.js configuration for SecureNow
+ * 
+ * This configuration suppresses OpenTelemetry instrumentation warnings
+ */
+
+const { getSecureNowWebpackConfig } = require('securenow/nextjs-webpack-config');
+
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  // Next.js 15+ doesn't need this
+  // For Next.js 14 and below, uncomment:
+  // experimental: {
+  //   instrumentationHook: true,
+  // },
+  
+  // Suppress OpenTelemetry bundling warnings
+  webpack: (config, options) => {
+    return getSecureNowWebpackConfig(config, options);
+  },
+  
+  // Optional: Tell Next.js not to bundle OpenTelemetry packages
+  serverExternalPackages: [
+    '@opentelemetry/sdk-node',
+    '@opentelemetry/auto-instrumentations-node',
+    '@opentelemetry/instrumentation',
+  ],
+};
+
+module.exports = nextConfig;
+
+
+
+

package/examples/nextjs-env-example.txt

@@ -0,0 +1,31 @@
+# SecureNow Configuration for Next.js
+# Place these in your .env.local file
+
+# Required: Your application identifier
+SECURENOW_APPID=my-nextjs-app
+
+# Optional: Your SigNoz/OpenTelemetry collector endpoint
+# Default: http://46.62.173.237:4318
+SECURENOW_INSTANCE=http://your-signoz-server:4318
+
+# Optional: API Key or authentication headers
+OTEL_EXPORTER_OTLP_HEADERS="x-api-key=your-api-key-here"
+
+# Optional: Don't append UUID to service name (useful for dev)
+# SECURENOW_NO_UUID=1
+
+# Optional: Log level
+# OTEL_LOG_LEVEL=info
+
+# Optional: Disable specific instrumentations (comma-separated)
+# SECURENOW_DISABLE_INSTRUMENTATIONS=fs,dns
+
+# Optional: Create a test span on startup
+# SECURENOW_TEST_SPAN=1
+
+# Next.js will automatically use NODE_ENV
+# NODE_ENV=production
+
+
+
+

package/examples/nextjs-instrumentation.js

@@ -0,0 +1,33 @@
+/**
+ * Next.js Instrumentation with SecureNow (JavaScript version)
+ * 
+ * Place this file at the root of your Next.js project as: instrumentation.js
+ * (or in the src/ folder if you're using it)
+ * 
+ * For Next.js 14 and below, also add to next.config.js:
+ *   experimental: { instrumentationHook: true }
+ */
+
+const { registerSecureNow } = require('securenow/nextjs');
+
+export function register() {
+  registerSecureNow();
+}
+
+/**
+ * Configuration via Environment Variables (.env.local):
+ * 
+ * Required:
+ *   SECURENOW_APPID=my-nextjs-app
+ * 
+ * Optional:
+ *   SECURENOW_INSTANCE=http://your-signoz-server:4318
+ *   SECURENOW_NO_UUID=1                    # Don't append UUID to service name
+ *   OTEL_LOG_LEVEL=info                    # debug|info|warn|error
+ *   SECURENOW_DISABLE_INSTRUMENTATIONS=fs  # Comma-separated list
+ *   SECURENOW_TEST_SPAN=1                  # Create test span on startup
+ */
+
+
+
+

package/examples/nextjs-instrumentation.ts

@@ -0,0 +1,33 @@
+/**
+ * Next.js Instrumentation with SecureNow
+ * 
+ * Place this file at the root of your Next.js project as: instrumentation.ts
+ * (or in the src/ folder if you're using it)
+ * 
+ * For Next.js 14 and below, also add to next.config.js:
+ *   experimental: { instrumentationHook: true }
+ */
+
+import { registerSecureNow } from 'securenow/nextjs';
+
+export function register() {
+  registerSecureNow();
+}
+
+/**
+ * Configuration via Environment Variables (.env.local):
+ * 
+ * Required:
+ *   SECURENOW_APPID=my-nextjs-app
+ * 
+ * Optional:
+ *   SECURENOW_INSTANCE=http://your-signoz-server:4318
+ *   SECURENOW_NO_UUID=1                    # Don't append UUID to service name
+ *   OTEL_LOG_LEVEL=info                    # debug|info|warn|error
+ *   SECURENOW_DISABLE_INSTRUMENTATIONS=fs  # Comma-separated list
+ *   SECURENOW_TEST_SPAN=1                  # Create test span on startup
+ */
+
+
+
+

package/examples/nextjs-with-options.ts

@@ -0,0 +1,33 @@
+/**
+ * Next.js Instrumentation with SecureNow - Advanced Configuration
+ * 
+ * This example shows how to pass configuration options programmatically
+ * instead of using environment variables.
+ */
+
+import { registerSecureNow } from 'securenow/nextjs';
+
+export function register() {
+  registerSecureNow({
+    serviceName: 'my-nextjs-app',
+    endpoint: 'http://your-signoz-server:4318',
+    noUuid: false,
+    disableInstrumentations: ['fs', 'dns'],
+    headers: {
+      'x-api-key': process.env.SECURENOW_API_KEY || '',
+    },
+  });
+}
+
+/**
+ * You can still use environment variables alongside options.
+ * Options take precedence over environment variables.
+ * 
+ * Mix and match as needed:
+ *   - Use options for static config
+ *   - Use env vars for secrets and per-environment config
+ */
+
+
+
+