securenow 5.0.0 → 5.0.2

package/CONSUMING-APPS-GUIDE.md

@@ -0,0 +1,415 @@
+# How to Use SecureNow Logging in Your App
+
+This guide is for developers who want to add the `securenow` package to their applications to enable logging to SigNoz.
+
+---
+
+## Installation
+
+```bash
+npm install securenow
+```
+
+---
+
+## Setup Steps
+
+### Step 1: Configure Environment Variables
+
+Add these to your `.env` file or export them:
+
+```bash
+# Required: Enable logging
+SECURENOW_LOGGING_ENABLED=1
+
+# Required: Your app name
+SECURENOW_APPID=my-app-name
+
+# Required: Your SigNoz endpoint
+SECURENOW_INSTANCE=http://your-signoz-server:4318
+
+# For SigNoz Cloud (optional):
+# OTEL_EXPORTER_OTLP_HEADERS="signoz-ingestion-key=your-key"
+```
+
+---
+
+### Step 2: Choose Your Integration Method
+
+You have **three options** to integrate logging:
+
+#### **Option A: Automatic Console Instrumentation** (Recommended - Easiest)
+
+This automatically captures all `console.log()`, `console.info()`, `console.warn()`, and `console.error()` calls and sends them to SigNoz.
+
+**Add to your main application file:**
+
+```javascript
+// At the very top of your app.js, index.js, server.js, or main.ts
+require('securenow/register');
+require('securenow/console-instrumentation');
+
+// Now use console normally - all logs go to SigNoz!
+console.log('Application started');
+console.error('An error occurred', { userId: 123, details: 'Something went wrong' });
+console.warn('Warning message');
+```
+
+**Or using NODE_OPTIONS (no code changes needed):**
+
+```bash
+NODE_OPTIONS="-r securenow/register -r securenow/console-instrumentation" node app.js
+```
+
+---
+
+#### **Option B: Direct Logger API**
+
+For more control over logging, use the OpenTelemetry logger API directly:
+
+```javascript
+require('securenow/register');
+const { getLogger } = require('securenow/tracing');
+
+// Get a logger instance
+const logger = getLogger('my-service', '1.0.0');
+
+// Emit structured logs
+logger.emit({
+  severityNumber: 9,      // INFO level
+  severityText: 'INFO',
+  body: 'User logged in',
+  attributes: {
+    userId: 123,
+    username: 'john',
+    ip: '192.168.1.1',
+  },
+});
+```
+
+**Severity Levels:**
+- `5` = DEBUG
+- `9` = INFO
+- `13` = WARN
+- `17` = ERROR
+
+---
+
+#### **Option C: Custom Logger Wrapper**
+
+Create your own logger wrapper for cleaner API:
+
+```javascript
+// logger.js
+require('securenow/register');
+const { getLogger } = require('securenow/tracing');
+
+const logger = getLogger('app-logger', '1.0.0');
+
+const SeverityNumber = {
+  DEBUG: 5,
+  INFO: 9,
+  WARN: 13,
+  ERROR: 17,
+};
+
+function log(level, message, attributes = {}) {
+  if (logger) {
+    logger.emit({
+      severityNumber: SeverityNumber[level],
+      severityText: level,
+      body: message,
+      attributes,
+    });
+  }
+  console.log(`[${level}] ${message}`, attributes);
+}
+
+module.exports = {
+  debug: (msg, attrs) => log('DEBUG', msg, attrs),
+  info: (msg, attrs) => log('INFO', msg, attrs),
+  warn: (msg, attrs) => log('WARN', msg, attrs),
+  error: (msg, attrs) => log('ERROR', msg, attrs),
+};
+```
+
+**Usage:**
+
+```javascript
+const logger = require('./logger');
+
+logger.info('User signed up', { userId: 456, email: 'user@example.com' });
+logger.error('Payment failed', { orderId: 789, amount: 99.99 });
+```
+
+---
+
+## Framework-Specific Setup
+
+### Express.js
+
+```javascript
+// app.js
+require('securenow/register');
+require('securenow/console-instrumentation');
+
+const express = require('express');
+const app = express();
+
+app.get('/', (req, res) => {
+  console.log('Home page accessed');
+  res.send('Hello World');
+});
+
+app.listen(3000, () => {
+  console.log('Server running on port 3000');
+});
+```
+
+**Run:**
+```bash
+SECURENOW_LOGGING_ENABLED=1 SECURENOW_APPID=express-app node app.js
+```
+
+---
+
+### Next.js (App Router)
+
+**1. Create `instrumentation.ts` in project root:**
+
+```typescript
+// instrumentation.ts
+export async function register() {
+  if (process.env.NEXT_RUNTIME === 'nodejs') {
+    process.env.SECURENOW_LOGGING_ENABLED = '1';
+    await import('securenow/register');
+    await import('securenow/console-instrumentation');
+  }
+}
+```
+
+**2. Enable in `next.config.js`:**
+
+```javascript
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  experimental: {
+    instrumentationHook: true,
+  },
+};
+
+module.exports = nextConfig;
+```
+
+**3. Add to `.env.local`:**
+
+```bash
+SECURENOW_LOGGING_ENABLED=1
+SECURENOW_APPID=my-nextjs-app
+SECURENOW_INSTANCE=http://localhost:4318
+```
+
+**4. Use in API routes:**
+
+```typescript
+// app/api/users/route.ts
+export async function GET() {
+  console.log('GET /api/users called');
+  const users = await fetchUsers();
+  console.info('Users fetched', { count: users.length });
+  return Response.json(users);
+}
+```
+
+---
+
+### Fastify
+
+```javascript
+// server.js
+require('securenow/register');
+require('securenow/console-instrumentation');
+
+const fastify = require('fastify')();
+
+fastify.get('/', async () => {
+  console.log('Root endpoint called');
+  return { hello: 'world' };
+});
+
+fastify.listen({ port: 3000 });
+```
+
+---
+
+### NestJS
+
+```typescript
+// main.ts
+require('securenow/register');
+require('securenow/console-instrumentation');
+
+import { NestFactory } from '@nestjs/core';
+import { AppModule } from './app.module';
+
+async function bootstrap() {
+  const app = await NestFactory.create(AppModule);
+  console.log('NestJS application starting');
+  await app.listen(3000);
+}
+
+bootstrap();
+```
+
+---
+
+## Verification
+
+After starting your app, you should see:
+
+```
+[securenow] OTel SDK started → http://your-signoz-server:4318/v1/traces
+[securenow] 📋 Logging: ENABLED → http://your-signoz-server:4318/v1/logs
+[securenow] Console instrumentation installed
+```
+
+---
+
+## View Logs in SigNoz
+
+1. Open your SigNoz dashboard
+2. Go to **Logs** section
+3. Filter by `service.name = my-app-name`
+4. See all your logs with:
+   - Automatic severity levels
+   - Structured attributes
+   - Trace correlation
+
+---
+
+## Common Issues
+
+### Logs Not Appearing
+
+**Check 1:** Verify `SECURENOW_LOGGING_ENABLED=1` is set
+
+```bash
+echo $SECURENOW_LOGGING_ENABLED  # Should output: 1
+```
+
+**Check 2:** Verify endpoint is correct
+
+```bash
+# Self-hosted SigNoz
+export SECURENOW_INSTANCE=http://localhost:4318
+
+# SigNoz Cloud
+export SECURENOW_INSTANCE=https://ingest.<region>.signoz.cloud:443
+export OTEL_EXPORTER_OTLP_HEADERS="signoz-ingestion-key=<your-key>"
+```
+
+**Check 3:** Enable debug logging
+
+```bash
+export OTEL_LOG_LEVEL=debug
+node app.js
+```
+
+---
+
+### Console Instrumentation Not Working
+
+Make sure the load order is correct:
+
+```javascript
+// ✅ Correct
+require('securenow/register');
+require('securenow/console-instrumentation');
+const express = require('express');
+
+// ❌ Wrong
+const express = require('express');
+require('securenow/register');
+```
+
+---
+
+### Logger Returns Null
+
+This happens when logging is disabled:
+
+```javascript
+const { getLogger } = require('securenow/tracing');
+const logger = getLogger('test');
+
+if (!logger) {
+  console.log('Set SECURENOW_LOGGING_ENABLED=1 to enable logging');
+}
+```
+
+---
+
+## Environment Variables Reference
+
+```bash
+# Logging
+SECURENOW_LOGGING_ENABLED=1              # Enable/disable logging (default: 1)
+
+# Connection
+SECURENOW_INSTANCE=http://localhost:4318 # OTLP endpoint
+OTEL_EXPORTER_OTLP_LOGS_ENDPOINT=...     # Override logs endpoint
+
+# Authentication
+OTEL_EXPORTER_OTLP_HEADERS="signoz-ingestion-key=KEY"
+
+# Service Info
+SECURENOW_APPID=my-app                   # Your app name
+OTEL_SERVICE_NAME=my-app                 # Alternative
+
+# Debugging
+OTEL_LOG_LEVEL=debug                     # Enable debug output
+```
+
+---
+
+## Best Practices
+
+1. **Use Structured Logging** - Pass objects with meaningful attributes
+   ```javascript
+   console.log('User action', { userId: 123, action: 'login' });
+   ```
+
+2. **Choose Appropriate Severity Levels**
+   - `console.log()` / `console.info()` - Normal operations
+   - `console.warn()` - Warnings, deprecations
+   - `console.error()` - Errors, exceptions
+
+3. **Include Context** - Add userId, requestId, etc. to log attributes
+
+4. **Don't Log Sensitive Data** - SecureNow automatically redacts passwords, tokens, etc.
+
+5. **Use Different Loggers for Different Modules**
+   ```javascript
+   const authLogger = getLogger('auth-service');
+   const dbLogger = getLogger('database');
+   ```
+
+---
+
+## Complete Documentation
+
+- [Logging Quick Start](./docs/LOGGING-QUICKSTART.md)
+- [Logging Complete Guide](./docs/LOGGING-GUIDE.md)
+- [All Examples](./examples/)
+
+---
+
+## Support
+
+- **Documentation**: [Full Docs](./docs/INDEX.md)
+- **Website**: [securenow.ai](http://securenow.ai/)
+- **Issues**: GitHub Issues
+
+---
+
+**That's it!** Your app is now sending logs to SigNoz. 🎉