fleek-track-analytics 1.17.36 → 1.17.41

package/spec-files/rudderstack-migration/RUDDERSTACK_SELF_HOSTED_PARAMETERS.md

@@ -1,283 +0,0 @@
-# RudderStack Self-Hosted Parameters
-
-This document outlines all parameters and configuration options required for setting up a self-hosted RudderStack solution.
-
-## Overview
-
-RudderStack consists of two main components:
-1. **Control Plane**: Manages source and destination configurations
-2. **Data Plane**: Handles event ingestion, processing, and routing
-
-## Control Plane Parameters
-
-### Hosted Control Plane (Recommended)
-
-When using RudderStack's hosted control plane (recommended for most use cases):
-
-- **Control Plane URL**: `https://app.rudderstack.com` (default)
-- **Workspace Token**: Unique identifier linking your data plane to the control plane
-- **No Database Required**: Database is managed by RudderStack
-
-### Self-Hosted Control Plane (Advanced)
-
-If self-hosting the control plane:
-
-- **Control Plane URL**: Your self-hosted control plane endpoint
-- **Workspace Token**: Unique identifier for your workspace
-- **Database**: PostgreSQL connection string
-  - `DB_HOST`: Database host address
-  - `DB_PORT`: Database port (default: 5432)
-  - `DB_USER`: Database username
-  - `DB_NAME`: Database name
-  - `DB_PASSWORD`: Database password
-- **Environment Variables**:
-  - `WORKSPACE_TOKEN`: Workspace token for authentication
-  - `CONTROL_PLANE_URL`: Self-hosted control plane URL (if applicable)
-
-## Data Plane Parameters
-
-### Required Parameters
-
-- **Data Plane URL**: Endpoint where SDK sends events
-  - Example: `https://dataplane.yourdomain.com`
-  - Must be accessible from client applications
-  - Should use HTTPS in production
-
-- **Write Key**: Source-specific write key for authentication
-  - Generated in the control plane
-  - Unique per source
-  - Used by SDK to authenticate requests
-
-- **Workspace Token**: Links data plane to control plane
-  - Required for data plane to fetch configurations
-  - Generated in the control plane
-
-### Database Configuration (PostgreSQL)
-
-Required for metadata storage and event processing:
-
-- **DB_HOST**: PostgreSQL host address
-- **DB_PORT**: PostgreSQL port (default: 5432)
-- **DB_USER**: PostgreSQL username
-- **DB_NAME**: PostgreSQL database name
-- **DB_PASSWORD**: PostgreSQL password
-- **DB_SSL_MODE**: SSL mode (optional, default: require)
-
-### Optional Components
-
-- **Redis**: For caching and queue management
-  - `REDIS_HOST`: Redis host address
-  - `REDIS_PORT`: Redis port (default: 6379)
-  - `REDIS_PASSWORD`: Redis password (if required)
-  - `REDIS_DB`: Redis database number (default: 0)
-
-### Environment Variables for Data Plane
-
-```bash
-# Database Configuration
-DB_HOST=postgres.example.com
-DB_PORT=5432
-DB_USER=rudderstack
-DB_NAME=rudderstack
-DB_PASSWORD=your_password
-DB_SSL_MODE=require
-
-# Workspace Configuration
-WORKSPACE_TOKEN=your_workspace_token
-
-# Data Plane Configuration
-DATA_PLANE_URL=https://dataplane.yourdomain.com
-PORT=8080
-
-# Optional: Redis Configuration
-REDIS_HOST=redis.example.com
-REDIS_PORT=6379
-REDIS_PASSWORD=your_redis_password
-
-# Optional: Docker Configuration
-DOCKER_IMAGE_TAG=latest
-```
-
-## SDK Configuration Parameters
-
-### Web SDK (`@rudderstack/rudder-sdk-js`)
-
-```typescript
-rudderanalytics.load(writeKey, dataPlaneUrl, {
-  // Anonymous ID Options
-  anonymousIdOptions: {
-    autoCapture: {
-      enabled: true,
-      source: "segment" // For Segment migration
-    }
-  },
-  
-  // Flush Settings
-  flushAt: 20, // Number of events to batch before sending
-  flushInterval: 5000, // Time in ms to wait before flushing
-  
-  // Options
-  integrations: {
-    All: true, // Send to all integrations
-    // Or specify individual integrations
-  },
-  
-  // Other options
-  logLevel: 'DEBUG', // 'DEBUG' | 'INFO' | 'WARN' | 'ERROR'
-  secureCookie: true, // Use secure cookies
-  sameSiteCookie: 'Lax', // Cookie same-site attribute
-});
-```
-
-### React Native SDK (`@rudderstack/analytics-react-native`)
-
-```typescript
-const client = RudderClient.getInstance(writeKey, {
-  dataPlaneUrl: 'YOUR_DATA_PLANE_URL',
-  
-  // Flush Settings
-  flushAt: 3,
-  flushInterval: 5,
-  
-  // Debug
-  debug: true,
-  
-  // Track App Lifecycle
-  trackAppLifecycleEvents: true,
-});
-```
-
-## Deployment Options
-
-### Docker Deployment
-
-```yaml
-# docker-compose.yml example
-version: '3.8'
-services:
-  rudderstack-data-plane:
-    image: rudderlabs/rudder-server:latest
-    environment:
-      - DB_HOST=postgres
-      - DB_PORT=5432
-      - DB_USER=rudderstack
-      - DB_NAME=rudderstack
-      - DB_PASSWORD=${DB_PASSWORD}
-      - WORKSPACE_TOKEN=${WORKSPACE_TOKEN}
-      - DATA_PLANE_URL=${DATA_PLANE_URL}
-    ports:
-      - "8080:8080"
-    depends_on:
-      - postgres
-      - redis
-  
-  postgres:
-    image: postgres:14
-    environment:
-      - POSTGRES_USER=rudderstack
-      - POSTGRES_PASSWORD=${DB_PASSWORD}
-      - POSTGRES_DB=rudderstack
-    volumes:
-      - postgres_data:/var/lib/postgresql/data
-  
-  redis:
-    image: redis:7-alpine
-    volumes:
-      - redis_data:/data
-
-volumes:
-  postgres_data:
-  redis_data:
-```
-
-### Kubernetes Deployment
-
-Requires:
-- Kubernetes cluster
-- Helm charts (if using Helm)
-- Persistent volumes for PostgreSQL
-- Ingress controller for external access
-- ConfigMaps and Secrets for configuration
-
-## Network Requirements
-
-### Inbound Connections
-
-- **Data Plane**: Must accept HTTPS connections from client applications
-- **Control Plane**: Must be accessible for configuration management (if self-hosted)
-
-### Outbound Connections
-
-- **Data Plane** → **Control Plane**: To fetch source/destination configurations
-- **Data Plane** → **Destinations**: To forward events to configured destinations
-- **Data Plane** → **PostgreSQL**: Database connections
-- **Data Plane** → **Redis**: Cache/queue connections (if used)
-
-## Security Considerations
-
-1. **HTTPS**: Always use HTTPS for data plane URL in production
-2. **Write Key**: Keep write keys secure, rotate regularly
-3. **Workspace Token**: Treat as sensitive credential
-4. **Database**: Use strong passwords, enable SSL
-5. **Network**: Restrict access to data plane endpoint
-6. **Firewall**: Configure firewall rules appropriately
-
-## Monitoring and Observability
-
-### Metrics to Monitor
-
-- Event ingestion rate
-- Event processing latency
-- Destination delivery success/failure rates
-- Database connection pool usage
-- Redis memory usage (if applicable)
-- Error rates
-
-### Logging
-
-- Application logs
-- Access logs
-- Error logs
-- Audit logs for configuration changes
-
-## Configuration Summary
-
-### Minimum Required for PoC
-
-1. **Control Plane**: Use hosted control plane (no setup required)
-2. **Data Plane**: 
-   - Data Plane URL
-   - Write Key
-   - Workspace Token
-   - PostgreSQL database
-3. **SDK Configuration**:
-   - Write Key
-   - Data Plane URL
-
-### Production Requirements
-
-1. **Control Plane**: Hosted or self-hosted with proper security
-2. **Data Plane**: 
-   - All minimum requirements
-   - Redis (recommended for production)
-   - High availability setup
-   - Monitoring and alerting
-   - Backup and disaster recovery
-3. **SDK Configuration**:
-   - All minimum requirements
-   - Proper error handling
-   - Retry logic
-   - Batching configuration
-
-## Parameter Checklist
-
-- [ ] Data Plane URL configured and accessible
-- [ ] Write Key generated in control plane
-- [ ] Workspace Token obtained
-- [ ] PostgreSQL database set up and accessible
-- [ ] Redis configured (optional but recommended)
-- [ ] Network security configured
-- [ ] SSL/TLS certificates configured
-- [ ] Monitoring and logging set up
-- [ ] Backup strategy in place
-

package/spec-files/rudderstack-migration/SEGMENT_VS_RUDDERSTACK_SDK_COMPARISON.md

@@ -1,140 +0,0 @@
-# Segment vs RudderStack SDK Comparison
-
-This document provides a comprehensive comparison between Segment and RudderStack client SDKs for Web and React Native platforms.
-
-## Web SDK Comparison
-
-| Feature | Segment | RudderStack | Notes |
-|---------|---------|-------------|-------|
-| **Core Methods** | | | |
-| `identify()` | ✅ | ✅ | API compatible - both accept userId and traits |
-| `track()` | ✅ | ✅ | API compatible - both accept event name and properties |
-| `page()` | ✅ | ✅ | API compatible - both accept page name and properties |
-| `group()` | ✅ | ✅ | API compatible - both support group identification |
-| `alias()` | ✅ | ✅ | API compatible - both support user aliasing |
-| **Additional Features** | | | |
-| Session Tracking | ❌ | ✅ | RudderStack has built-in configurable sessions |
-| Ad Blocker Detection | ❌ | ✅ | RudderStack automatically detects ad blockers |
-| Anonymous ID Sync | N/A | ✅ | RudderStack can capture Segment's anonymousId |
-| **Initialization** | `AnalyticsBrowser.load({ writeKey })` | `rudderanalytics.load(writeKey, dataPlaneUrl)` | RudderStack requires data plane URL |
-| **Configuration** | Write Key only | Write Key + Data Plane URL | RudderStack requires self-hosted data plane endpoint |
-| **Package** | `@segment/analytics-next` | `@rudderstack/rudder-sdk-js` | Different npm packages |
-| **User Management** | `client.user().traits()`, `client.user().anonymousId()` | `rudderanalytics.getUserTraits()`, `rudderanalytics.getAnonymousId()` | Similar functionality, different API |
-| **Options Support** | ✅ | ✅ | Both support options and callbacks |
-| **Debug Mode** | ✅ | ✅ | Both support debug logging |
-
-### Segment Web SDK Example
-
-```typescript
-import { AnalyticsBrowser } from '@segment/analytics-next';
-
-const client = AnalyticsBrowser.load({ writeKey: 'YOUR_WRITE_KEY' });
-
-await client.track('Event Name', { property: 'value' });
-await client.identify('userId', { email: 'user@example.com' });
-await client.page('Page Name', { path: '/home' });
-const anonymousId = await client.user().anonymousId();
-```
-
-### RudderStack Web SDK Example
-
-```typescript
-import * as rudderanalytics from '@rudderstack/rudder-sdk-js';
-
-rudderanalytics.load('YOUR_WRITE_KEY', 'YOUR_DATA_PLANE_URL');
-
-rudderanalytics.track('Event Name', { property: 'value' });
-rudderanalytics.identify('userId', { email: 'user@example.com' });
-rudderanalytics.page('Page Name', { path: '/home' });
-const anonymousId = rudderanalytics.getAnonymousId();
-```
-
-## React Native SDK Comparison
-
-| Feature | Segment | RudderStack | Notes |
-|---------|---------|-------------|-------|
-| **Core Methods** | | | |
-| `identify()` | ✅ | ✅ | API compatible - both accept userId and traits |
-| `track()` | ✅ | ✅ | API compatible - both accept event name and properties |
-| `screen()` | ✅ | ✅ | API compatible - both accept screen name and properties |
-| `group()` | ✅ | ✅ | API compatible - both support group identification |
-| `alias()` | ✅ | ✅ | API compatible - both support user aliasing |
-| **Initialization** | `createClient({ writeKey })` | `RudderClient.getInstance(writeKey, dataPlaneUrl)` | RudderStack requires data plane URL |
-| **Configuration** | Write Key only | Write Key + Data Plane URL | RudderStack requires self-hosted data plane endpoint |
-| **Package** | `@segment/analytics-react-native` | `@rudderstack/analytics-react-native` | Different npm packages |
-| **Flush Settings** | `flushAt`, `flushInterval` | `flushAt`, `flushInterval` | Both support batching configuration |
-| **Debug Mode** | ✅ | ✅ | Both support debug logging |
-| **App Lifecycle Events** | ✅ (trackAppLifecycleEvents) | ✅ | Both can track app lifecycle automatically |
-
-### Segment React Native SDK Example
-
-```typescript
-import { createClient } from '@segment/analytics-react-native';
-
-const client = createClient({
-  writeKey: 'YOUR_WRITE_KEY',
-  trackAppLifecycleEvents: true,
-  flushAt: 3,
-  flushInterval: 5,
-});
-
-await client.track('Event Name', { property: 'value' });
-await client.identify('userId', { email: 'user@example.com' });
-await client.screen('Screen Name', { screen: 'Home' });
-```
-
-### RudderStack React Native SDK Example
-
-```typescript
-import { RudderClient } from '@rudderstack/analytics-react-native';
-
-const client = RudderClient.getInstance('YOUR_WRITE_KEY', {
-  dataPlaneUrl: 'YOUR_DATA_PLANE_URL',
-  flushAt: 3,
-  flushInterval: 5,
-});
-
-client.track('Event Name', { property: 'value' });
-client.identify('userId', { email: 'user@example.com' });
-client.screen('Screen Name', { screen: 'Home' });
-```
-
-## Key Differences Summary
-
-### 1. **Data Plane Requirement**
-- **Segment**: Uses Segment's hosted infrastructure. Only requires write key.
-- **RudderStack**: Requires self-hosted data plane URL in addition to write key for self-hosted deployments.
-
-### 2. **Session Tracking**
-- **Segment**: Does not have built-in session tracking. Requires custom implementation.
-- **RudderStack**: Has built-in session tracking that can be configured.
-
-### 3. **Ad Blocker Detection**
-- **Segment**: Does not detect ad blockers.
-- **RudderStack**: Automatically detects ad blockers and can send event flags accordingly.
-
-### 4. **Anonymous ID Synchronization**
-- **Segment**: N/A (source of truth).
-- **RudderStack**: Can automatically capture and sync anonymousId from Segment during migration.
-
-### 5. **API Compatibility**
-- Both SDKs are designed to be API-compatible, making migration easier.
-- Method signatures are similar but not identical.
-- RudderStack requires data plane URL parameter during initialization.
-
-## Migration Considerations
-
-1. **Initialization Changes**: RudderStack requires data plane URL parameter
-2. **Method Calls**: Method signatures are compatible, but some helper methods differ
-3. **User Management**: Different APIs for accessing user traits and anonymous ID
-4. **Configuration**: RudderStack requires additional configuration for self-hosted setup
-5. **Error Handling**: Both support error handling, but implementation details differ
-
-## Compatibility Notes
-
-- Both SDKs support the same core tracking methods (identify, track, page/screen)
-- Event payload structures are compatible
-- Both support custom properties and traits
-- Both support options and callbacks
-- RudderStack can sync anonymousId from Segment for seamless migration
-