vibex-sh 1.0.0

vibex.sh Python SDK - Fail-safe logging handler for vibex.sh

vibex.sh Python SDK

Fail-safe logging handler for sending logs to vibex.sh.

Features

• Fail-Safe: Silently disables if configuration is missing or invalid
• Kill Switch: Permanently disables on 401/403 errors (expired/invalid tokens)
• Easy Integration: Drop-in Python logging handler
• Zero Dependencies (except requests)

Installation

pip install vibex_sh

Authentication

Before using the SDK, you need to get your authentication token. Run this command in your terminal:

npx vibex-sh login

This will generate your VIBEX_TOKEN that you'll use in the environment variables below.

Quick Start

1. Set environment variables:

export VIBEX_TOKEN=vb_live_your_token_here
export VIBEX_SESSION_ID=my-production-app

2. Use in your Python application:

import logging
import json
from vibex_sh import VibexHandler

# Get your logger
logger = logging.getLogger('my_app')

# Add Vibex handler
vibex_handler = VibexHandler()
logger.addHandler(vibex_handler)

# Send JSON logs (only JSON logs are sent to Vibex)
logger.info(json.dumps({'cpu': 45, 'memory': 78, 'status': 'healthy'}))
logger.info(json.dumps({'error': 'connection_failed', 'retry_count': 3}))

Configuration

The SDK reads configuration from environment variables:

• VIBEX_TOKEN (required): Your Vibex API token
• VIBEX_SESSION_ID (required): Your session ID

Fail-Safe Behavior

The SDK is designed to be fail-safe:

1. Missing Config: If VIBEX_TOKEN or VIBEX_SESSION_ID is missing, the handler silently disables itself
2. Invalid Token: On 401/403 responses, the handler permanently disables for the process lifetime
3. Network Errors: All network errors are silently handled - your application continues normally
4. Rate Limits: On 429 (rate limit), logs are dropped but the handler remains enabled. Logs are still written to console by default (passthrough_console=True)

Console Passthrough Options

By default, logs are forwarded to Vibex and also written to stderr (console), ensuring you can always see your logs locally while they're sent to Vibex.

passthrough_console (default: True)

When enabled (default), logs are always written to stderr in addition to being sent to Vibex. This provides visibility into your logs while forwarding them to Vibex.

# Default behavior - logs written to console and sent to Vibex
vibex_handler = VibexHandler()  # passthrough_console=True by default
logger.addHandler(vibex_handler)

# To disable console output (logs only sent to Vibex)
vibex_handler = VibexHandler(passthrough_console=False)
logger.addHandler(vibex_handler)

Note: To avoid duplicate log output when using passthrough_console=True, either:

• Avoid using logging.basicConfig() which adds a default StreamHandler, or
• Configure your logger to not propagate: logger.propagate = False

passthrough_on_failure (default: False)

When enabled, logs are written to stderr when sending to Vibex fails (rate limits, network errors, etc.). This is useful as an additional safety net, but with passthrough_console=True by default, it's typically not needed.

# Write logs to console only when sending fails
vibex_handler = VibexHandler(passthrough_console=False, passthrough_on_failure=True)
logger.addHandler(vibex_handler)

Supported Log Types

The SDK supports multiple log types for different use cases. By default, the handler auto-detects JSON vs text logs and sends them appropriately.

JSON Logs (Default)

JSON logs are sent with a hybrid structure that includes message, level, metrics, and context:

import json

# ✅ Good - JSON logs are sent with hybrid structure
logger.info(json.dumps({'cpu': 45, 'memory': 78, 'status': 'healthy'}))
logger.info(json.dumps({'error': 'connection_failed', 'retry_count': 3}))

# ✅ Also works - Plain text logs are sent as text type
logger.info('Application started')
logger.info('High memory usage: 85%')

Specifying Log Types

You can specify a log type when creating the handler or when using the client directly:

# Handler with specific log type
vibex_handler = VibexHandler(log_type='web-server')
logger.addHandler(vibex_handler)

# Direct client usage with different types
client.send_log('json', {'cpu': 45, 'memory': 78})
client.send_log('text', 'GET /api/users 200 150ms')
client.send_log('web-server', '127.0.0.1 - - [25/Dec/2024:10:00:00 +0000] "GET /path HTTP/1.1" 200')
client.send_log('stacktrace', 'Error: Connection failed\n  at file.py:10:5')

Available Log Types

• json (default): Structured JSON logs with hybrid structure (dict payload)
• text: Plain text logs (str payload)
• web-server: Web server access logs (Nginx, Apache) - str payload
• loadbalancer: Load balancer logs (HAProxy, AWS ALB) - str payload
• stacktrace: Stack trace logs - str payload
• firewall: Firewall logs (iptables, pfSense, Cisco ASA) - str payload
• kubernetes: Kubernetes pod/container logs - str payload
• docker: Docker container logs - str payload
• network: Network logs (tcpdump, wireshark) - str payload
• keyvalue: Key-value pair logs - str payload
• json-in-text: JSON embedded in text - str payload
• smart-pattern: Smart pattern logs (multi-language) - str payload
• raw: Raw logs (fallback) - str payload

Advanced Usage

Direct Client Usage

from vibex_sh import VibexClient, VibexConfig

config = VibexConfig()
client = VibexClient(config)

# Send JSON log (default behavior)
client.send_log('json', {'cpu': 45, 'memory': 78})

# Send text log
client.send_log('text', 'Application started successfully')

# Send web server log
client.send_log('web-server', '127.0.0.1 - - [25/Dec/2024:10:00:00 +0000] "GET /api/users HTTP/1.1" 200 1234')

# Send stack trace
client.send_log('stacktrace', 'Error: Connection failed\n  at file.py:10:5\n  at main.py:25:3')

Check if Enabled

handler = VibexHandler()
if handler.is_enabled():
    print('Vibex is active')
else:
    print('Vibex is disabled (missing config or expired token)')

Verbose Mode

Enable verbose mode to see status messages when the handler initializes or encounters errors:

vibex_handler = VibexHandler(verbose=True)
logger.addHandler(vibex_handler)

License

MIT