zlogger-client 1.0.1

Python client for Zlogger logging service

Zlogger Python Client

A simple and efficient Python client for the Zlogger logging service. Send structured logs to your Zlogger instance with ease.

Features

• 🚀 Simple and intuitive API
• 📊 Structured logging with context data
• 🔒 Secure API key authentication
• 🌐 HTTP/HTTPS support
• ⚡ Lightweight with minimal dependencies
• 🐍 Python 3.7+ support

Installation

pip install zlogger-client

Quick Start

from zlogger import ZloggerClient

# Initialize the client
logger = ZloggerClient(
    endpoint="https://your-zlogger-instance.com/api/logs",
    api_key="your-api-key",
    app_name="my-application"
)

# Send logs with different levels
logger.info("Application started", {"version": "1.0.0", "env": "production"})
logger.warn("High memory usage detected", {"memory_usage": "90%", "threshold": "80%"})
logger.error("Database connection failed", {"database": "primary", "timeout": 30})
logger.debug("Processing user request", {"user_id": 123, "endpoint": "/api/users"})

API Reference

ZloggerClient(endpoint, api_key, app_name)

Creates a new Zlogger client instance.

Parameters:

• endpoint (str): Your Zlogger API endpoint URL
• api_key (str): Your Zlogger API key for authentication
• app_name (str): Name of your application (used for log categorization)

Example:

client = ZloggerClient(
    endpoint="https://logs.yourcompany.com/api/logs",
    api_key="zlogger_abc123def456",
    app_name="ecommerce-backend"
)

Logging Methods

All logging methods accept the same parameters:

• message (str): The log message
• context (dict, optional): Additional structured data

Available log levels:

• logger.debug(message, context=None) - Debug information
• logger.info(message, context=None) - General information
• logger.warn(message, context=None) - Warning messages
• logger.error(message, context=None) - Error messages

Advanced Usage

Error Handling

try:
    # Your application code
    result = process_payment(amount, card)
    logger.info("Payment processed successfully", {
        "transaction_id": result.id,
        "amount": amount,
        "processing_time": result.duration
    })
except PaymentError as e:
    logger.error("Payment processing failed", {
        "error": str(e),
        "error_code": e.code,
        "amount": amount,
        "retry_count": 3
    })

Structured Context Data

# E-commerce example
logger.info("Order placed", {
    "order_id": "ORD-123456",
    "customer_id": "CUST-789",
    "items": [
        {"sku": "WIDGET-001", "quantity": 2, "price": 29.99},
        {"sku": "GADGET-002", "quantity": 1, "price": 49.99}
    ],
    "total_amount": 109.97,
    "payment_method": "credit_card",
    "shipping_address": {
        "country": "US",
        "state": "CA",
        "zip": "90210"
    }
})

# API monitoring example
logger.debug("API request processed", {
    "method": "POST",
    "endpoint": "/api/users",
    "status_code": 201,
    "response_time_ms": 145,
    "user_agent": "MyApp/1.0",
    "ip_address": "192.168.1.100"
})

Performance Monitoring

import time

start_time = time.time()
# Your processing code here
process_data()
processing_time = time.time() - start_time

logger.info("Data processing completed", {
    "records_processed": 1000,
    "processing_time_seconds": round(processing_time, 2),
    "records_per_second": round(1000 / processing_time, 2)
})

Configuration Examples

Environment-based Configuration

import os
from zlogger import ZloggerClient

# Load configuration from environment variables
logger = ZloggerClient(
    endpoint=os.getenv("ZLOGGER_ENDPOINT", "https://localhost:3000/api/logs"),
    api_key=os.getenv("ZLOGGER_API_KEY"),
    app_name=os.getenv("APP_NAME", "my-app")
)

Development vs Production

import os
from zlogger import ZloggerClient

# Different endpoints for different environments
is_production = os.getenv("ENV") == "production"

logger = ZloggerClient(
    endpoint="https://prod-logs.company.com/api/logs" if is_production
             else "https://dev-logs.company.com/api/logs",
    api_key=os.getenv("ZLOGGER_API_KEY"),
    app_name=f"my-app-{'prod' if is_production else 'dev'}"
)

Requirements

• Python 3.7+
• requests >= 2.31.0

License

MIT License - see the LICENSE file for details.

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Support

• 📧 Email: [e-mail]
• 🌐 Website: https://zlogger.ch
• 📖 Documentation: https://docs.zlogger.ch
• 🐛 Bug Reports: GitHub Issues