securenow 6.0.2 → 6.1.0

package/docs/LOGGING-QUICKSTART.md

@@ -1,255 +1,234 @@
-# SecureNow Logging - Quick Start
-
-Get logging set up in your Node.js app in under 2 minutes!
-
----
-
-## 1. Install
-
-```bash
-npm install securenow
-```
-
----
-
-## 2. Configure Environment
-
-Create `.env` file or export variables:
-
-```bash
-SECURENOW_LOGGING_ENABLED=1
-SECURENOW_APPID=my-app
-SECURENOW_INSTANCE=http://your-signoz-server:4318
-
-# For SigNoz Cloud:
-# SECURENOW_INSTANCE=https://ingest.<region>.signoz.cloud:443
-# OTEL_EXPORTER_OTLP_HEADERS="signoz-ingestion-key=<your-key>"
-```
-
----
-
-## 3. Add to Your App
-
-**Option A: Automatic Console Logging (Easiest)**
-
-Add these two lines at the top of your main file:
-
-```javascript
-// app.js, index.js, server.js, or main.ts
-require('securenow/register');
-require('securenow/console-instrumentation');
-
-// That's it! Now use console normally
-console.log('App started');
-console.error('An error occurred', { userId: 123 });
-```
-
-**Option B: Use NODE_OPTIONS (No code changes)**
-
-```bash
-NODE_OPTIONS="-r securenow/register -r securenow/console-instrumentation" node app.js
-```
-
----
-
-## 4. Run Your App
-
-```bash
-node app.js
-# or
-npm start
-```
-
-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
-```
-
----
-
-## 5. View Logs in SigNoz
-
-1. Open your SigNoz dashboard
-2. Go to **Logs** section
-3. Filter by `service.name = my-app`
-4. See all your logs with automatic trace correlation!
-
----
-
-## Framework-Specific Examples
-
-### 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('Request received');
-  res.send('Hello World');
-});
-
-app.listen(3000);
-```
-
-### Next.js
-
-Next.js apps must use `securenow/nextjs` (not `securenow/register`, which
-boots a full NodeSDK and conflicts with Next.js / `@vercel/otel`). Since
-**6.0.1**, `registerSecureNow()` sets up the OTLP logs pipeline and auto-
-patches `console.*` whenever `SECURENOW_LOGGING_ENABLED=1` is set — on both
-Vercel and self-hosted (EC2, PM2, Docker) environments.
-
-```typescript
-// instrumentation.ts (in project root)
-export async function register() {
-  if (process.env.NEXT_RUNTIME === 'nodejs') {
-    // Must be set BEFORE loading securenow/nextjs
-    process.env.SECURENOW_LOGGING_ENABLED = '1';
-
-    const { registerSecureNow } = await import('securenow/nextjs');
-    registerSecureNow({ captureBody: true });
-  }
-}
-```
-
-```bash
-# .env.local
-SECURENOW_LOGGING_ENABLED=1
-SECURENOW_APPID=my-nextjs-app
-SECURENOW_INSTANCE=http://localhost:4318
-```
-
-Enable the instrumentation hook in `next.config.js`:
-
-```javascript
-module.exports = {
-  experimental: { instrumentationHook: true },
-};
-```
-
-### Fastify
-
-```javascript
-// server.js
-require('securenow/register');
-require('securenow/console-instrumentation');
-
-const fastify = require('fastify')();
-
-fastify.get('/', async () => {
-  console.log('Route 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('App starting');
-  await app.listen(3000);
-}
-
-bootstrap();
-```
-
----
-
-## Troubleshooting
-
-**Logs not appearing?**
-
-1. Check `SECURENOW_LOGGING_ENABLED=1` is set
-2. Verify SigNoz endpoint is correct
-3. Enable debug: `OTEL_LOG_LEVEL=debug`
-
-**Console instrumentation not working?**
-
-Make sure require order is correct:
-
-```javascript
-// ✅ Correct
-require('securenow/register');           // First
-require('securenow/console-instrumentation');  // Second
-
-// ❌ Wrong
-require('express');
-require('securenow/register');  // Too late!
-```
-
----
-
-## What Gets Logged?
-
-All standard console methods:
-
-- `console.log()` → INFO
-- `console.info()` → INFO
-- `console.warn()` → WARN
-- `console.error()` → ERROR
-- `console.debug()` → DEBUG
-
-**Structured logging example:**
-
-```javascript
-console.log('User logged in', {
-  userId: 123,
-  email: 'user@example.com',
-  ip: '192.168.1.1'
-});
-```
-
-This creates a log with attributes you can filter/search in SigNoz!
-
----
-
-## Advanced Usage
-
-**Direct Logger API:**
-
-```javascript
-const { getLogger } = require('securenow/tracing');
-const logger = getLogger('my-module', '1.0.0');
-
-logger.emit({
-  severityNumber: 9,
-  severityText: 'INFO',
-  body: 'Custom log message',
-  attributes: {
-    customField: 'value',
-  },
-});
-```
-
----
-
-## Next Steps
-
-- [Complete Logging Guide](./LOGGING-GUIDE.md) - All features and options
-- [View Logs in SigNoz](https://signoz.io/docs/logs-management/overview/)
-- [Set Up Log Alerts](https://signoz.io/docs/alerts-management/log-based-alerts/)
-- [Combine with Tracing](../README.md) - Full observability
-
----
-
-**That's it!** 🎉 Your app is now sending logs to SigNoz.
-
-Need help? Check the [full documentation](./LOGGING-GUIDE.md) or open an issue.
+# SecureNow Logging - Quick Start
+
+Get logging set up in your Node.js app in under 2 minutes!
+
+**Since v5.6.0:** When `SECURENOW_LOGGING_ENABLED=1` is set, all `console.log` / `warn` / `error` / `info` / `debug` calls are automatically forwarded as OTLP log records. You only need `require('securenow/register')`—a separate `console-instrumentation` preload is no longer required.
+
+---
+
+## 1. Install
+
+```bash
+npm install securenow
+```
+
+---
+
+## 2. Configure Environment
+
+Create `.env` file or export variables:
+
+```bash
+SECURENOW_LOGGING_ENABLED=1
+SECURENOW_APPID=my-app
+SECURENOW_INSTANCE=http://your-otlp-backend:4318
+
+# For SecureNow / hosted OTLP (example):
+# SECURENOW_INSTANCE=https://freetrial.securenow.ai:4318
+# OTEL_EXPORTER_OTLP_HEADERS="x-api-key=<your-key>"
+```
+
+---
+
+## 3. Add to Your App
+
+**Option A: Automatic Console Logging (Easiest)**
+
+Add this line at the top of your main file:
+
+```javascript
+// app.js, index.js, server.js, or main.ts
+require('securenow/register');
+
+// That's it! Now use console normally
+console.log('App started');
+console.error('An error occurred', { userId: 123 });
+```
+
+**Option B: Use NODE_OPTIONS (No code changes)**
+
+```bash
+NODE_OPTIONS="-r securenow/register" node app.js
+```
+
+---
+
+## 4. Run Your App
+
+```bash
+node app.js
+# or
+npm start
+```
+
+You should see:
+
+```
+[securenow] OTel SDK started → http://your-otlp-backend:4318/v1/traces
+[securenow] 📋 Logging: ENABLED → http://your-otlp-backend:4318/v1/logs
+```
+
+---
+
+## 5. View Logs in SecureNow
+
+1. Open your SecureNow dashboard
+2. Go to **Logs** section
+3. Filter by `service.name = my-app`
+4. See all your logs with automatic trace correlation!
+
+---
+
+## Framework-Specific Examples
+
+### Express.js
+
+```javascript
+// app.js
+require('securenow/register');
+
+const express = require('express');
+const app = express();
+
+app.get('/', (req, res) => {
+  console.log('Request received');
+  res.send('Hello World');
+});
+
+app.listen(3000);
+```
+
+### Next.js
+
+```typescript
+// instrumentation.ts (in project root)
+export async function register() {
+  if (process.env.NEXT_RUNTIME === 'nodejs') {
+    process.env.SECURENOW_LOGGING_ENABLED = '1';
+    await import('securenow/register');
+  }
+}
+```
+
+```bash
+# .env.local
+SECURENOW_LOGGING_ENABLED=1
+SECURENOW_APPID=my-nextjs-app
+SECURENOW_INSTANCE=http://localhost:4318
+```
+
+### Fastify
+
+```javascript
+// server.js
+require('securenow/register');
+
+const fastify = require('fastify')();
+
+fastify.get('/', async () => {
+  console.log('Route called');
+  return { hello: 'world' };
+});
+
+fastify.listen({ port: 3000 });
+```
+
+### NestJS
+
+```typescript
+// main.ts
+require('securenow/register');
+
+import { NestFactory } from '@nestjs/core';
+import { AppModule } from './app.module';
+
+async function bootstrap() {
+  const app = await NestFactory.create(AppModule);
+  console.log('App starting');
+  await app.listen(3000);
+}
+
+bootstrap();
+```
+
+---
+
+## Troubleshooting
+
+**Logs not appearing?**
+
+1. Check `SECURENOW_LOGGING_ENABLED=1` is set
+2. Verify your OTLP / SecureNow endpoint is correct
+3. Enable debug: `OTEL_LOG_LEVEL=debug`
+
+**Console logs not forwarding?**
+
+Load `securenow/register` before other app code so logging hooks run first:
+
+```javascript
+// ✅ Correct
+require('securenow/register');  // First
+
+// ❌ Wrong
+require('express');
+require('securenow/register');  // Too late!
+```
+
+---
+
+## What Gets Logged?
+
+All standard console methods:
+
+- `console.log()` → INFO
+- `console.info()` → INFO
+- `console.warn()` → WARN
+- `console.error()` → ERROR
+- `console.debug()` → DEBUG
+
+**Structured logging example:**
+
+```javascript
+console.log('User logged in', {
+  userId: 123,
+  email: 'user@example.com',
+  ip: '192.168.1.1'
+});
+```
+
+This creates a log with attributes you can filter/search in SecureNow!
+
+---
+
+## Advanced Usage
+
+**Direct Logger API:**
+
+```javascript
+const { getLogger } = require('securenow/tracing');
+const logger = getLogger('my-module', '1.0.0');
+
+logger.emit({
+  severityNumber: 9,
+  severityText: 'INFO',
+  body: 'Custom log message',
+  attributes: {
+    customField: 'value',
+  },
+});
+```
+
+---
+
+## Next Steps
+
+- [Complete Logging Guide](./LOGGING-GUIDE.md) - All features and options
+- [SecureNow](https://securenow.ai/)
+- [Documentation](./INDEX.md)
+- [Combine with Tracing](../README.md) - Full observability
+
+---
+
+**That's it!** 🎉 Your app is now sending logs to SecureNow.
+
+Need help? Check the [full documentation](./LOGGING-GUIDE.md) or open an issue.