Add Axiom logging support and update environment configuration (#526)

* Add Axiom logging support and update environment configuration

- Introduced Axiom logging integration by adding environment variables AXIOM_DATASET and AXIOM_TOKEN to .env.example.
- Created Axiom setup documentation for centralized logging configuration.
- Updated logger implementation in index.ts and logger.ts to support Axiom in production.
- Enhanced logging documentation to include new Axiom-related configurations.

* Update Axiom logging setup and enhance documentation for development and production modes

- Refined Axiom logging configuration in index.ts and logger.ts to support both development and production environments.
- Updated AXIOM_SETUP.md to clarify logging behavior in development and production modes, including new setup options.
- Improved logging output for development with pino-pretty and ensured production logs are piped to Axiom via stdout.

* Refactor Axiom logging configuration for production and development environments

- Updated logger setup in index.ts and logger.ts to streamline Axiom logging for production while maintaining pretty printing for development.
- Removed redundant conditions and improved clarity in logging transport configuration.
- Ensured consistent logging levels and options across environments for better debugging and monitoring.

* Add Axiom logging environment variables to docker-compose configuration

- Introduced AXIOM_DATASET and AXIOM_TOKEN environment variables in docker-compose.cloud.yml for enhanced Axiom logging support.
- Updated service configuration to include optional Axiom logging settings, improving flexibility for deployment environments.

* Refactor Axiom logging configuration to support cloud environments

- Updated logger setup in index.ts and logger.ts to conditionally enable Axiom logging based on cloud deployment.
- Simplified logging transport configuration for production and development environments, ensuring clarity and consistency.
- Enhanced logging level management to default to 'info' in production while maintaining 'debug' in development.

* Enhance Axiom logging configuration for production and development environments

- Updated logger setup in index.ts and logger.ts to send logs to both Axiom and stdout in production, simplifying the logging process.
- Clarified logging behavior in AXIOM_SETUP.md to reflect the new dual logging capability and ease of use for local development.
- Ensured consistent logging levels and options across environments for improved monitoring and debugging.

* Refactor logging configuration to enhance output formatting

- Updated logger setup in index.ts and logger.ts to use pino-pretty for improved log readability in Docker environments.
- Enhanced logging options to include colorization, time formatting, and exclusion of unnecessary fields for clearer output.

Author: goldflag

docker-compose.cloud.yml

@@ -103,6 +103,9 @@ services:
       - REDIS_HOST=redis
       - REDIS_PORT=6379
       - REDIS_PASSWORD=${REDIS_PASSWORD:-changeme}
+      # Axiom logging configuration (optional)
+      - AXIOM_DATASET=${AXIOM_DATASET}
+      - AXIOM_TOKEN=${AXIOM_TOKEN}
     depends_on:
       clickhouse:
         condition: service_healthy

server/.env.example

@@ -32,4 +32,8 @@ R2_ACCOUNT_ID=
 R2_ACCESS_KEY_ID=
 R2_SECRET_ACCESS_KEY=
 R2_BUCKET_NAME=
-R2_PUBLIC_URL=
+R2_PUBLIC_URL=
+
+# Axiom logging (optional)
+AXIOM_DATASET=
+AXIOM_TOKEN=

server/AXIOM_SETUP.md

@@ -0,0 +1,121 @@
+# Axiom Logging Setup
+
+This guide explains how to configure Axiom for centralized logging in the Rybbit server.
+
+## Prerequisites
+
+1. Create an Axiom account at https://axiom.co
+2. Create a new dataset for your logs (e.g., "rybbit-logs")
+3. Generate an API token with ingest permissions
+
+## Configuration
+
+Add the following environment variables to your `.env` file:
+
+```env
+# Axiom logging
+AXIOM_DATASET=your-dataset-name
+AXIOM_TOKEN=xaat-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
+```
+
+## How It Works
+
+### Development Mode
+When both `AXIOM_DATASET` and `AXIOM_TOKEN` are set in development:
+- Logs are sent directly to Axiom using the Pino transport
+- This is useful for testing your Axiom integration
+
+Without Axiom credentials in development:
+- Logs use pino-pretty for readable console output
+
+### Production Mode
+In production with Axiom configured:
+- Logs are sent to both Axiom AND stdout simultaneously
+- You can view logs in Axiom for powerful searching and analytics
+- You can still use `docker logs` to see logs locally
+- No additional piping or configuration needed
+
+## Production Setup
+
+For production, you have several options:
+
+### Option 1: Using Axiom's log forwarder
+```bash
+# Install axiom CLI
+curl -fsSL https://install.axiom.co/install.sh | sh
+
+# Run your app and pipe to Axiom
+npm start | axiom ingest $AXIOM_DATASET -t $AXIOM_TOKEN
+```
+
+### Option 2: Docker Compose
+```yaml
+services:
+  app:
+    image: your-app
+    environment:
+      - NODE_ENV=production
+    logging:
+      driver: "json-file"
+  
+  log-forwarder:
+    image: axiomhq/axiom-forwarder
+    environment:
+      - AXIOM_DATASET=${AXIOM_DATASET}
+      - AXIOM_TOKEN=${AXIOM_TOKEN}
+    volumes:
+      - /var/lib/docker/containers:/var/lib/docker/containers:ro
+```
+
+### Option 3: Direct in Development
+Set your environment variables and logs will be sent directly to Axiom:
+```bash
+AXIOM_DATASET=your-dataset AXIOM_TOKEN=your-token npm run dev
+```
+
+## Log Structure
+
+All logs include:
+- Service name (e.g., "monitor-scheduler", "notification-service")
+- Structured data as the first parameter
+- Log level (info, warn, error, debug)
+- Timestamp and other metadata
+
+Example:
+```javascript
+logger.info({ monitorId: 123, region: "us-east-1" }, "Health check completed");
+```
+
+## Viewing Logs in Axiom
+
+1. Go to your Axiom dashboard
+2. Select your dataset
+3. Use APL (Axiom Processing Language) to query logs:
+
+```apl
+// View all errors
+| where level == "error"
+
+// View logs from a specific service
+| where service == "notification-service"
+
+// View logs for a specific monitor
+| where monitorId == 123
+```
+
+## Benefits
+
+- Centralized logging across all services
+- Powerful search and analytics
+- Real-time log streaming
+- Alerts and dashboards
+- No log rotation needed
+- Cost-effective for high volume
+
+## Troubleshooting
+
+If logs aren't appearing in Axiom:
+1. Check that environment variables are set correctly
+2. Verify the API token has ingest permissions
+3. Check the dataset name matches exactly
+4. Look for connection errors in stdout logs

server/package-lock.json

@@ -22,6 +22,7 @@
   },
   "dependencies": {
     "@aws-sdk/client-s3": "^3.842.0",
+    "@axiomhq/pino": "^1.3.1",
     "@clickhouse/client": "1.11.1",
     "@fastify/cors": "11.0.1",
     "@fastify/one-line-logger": "2.0.2",