edgepulse 0.1.4

EdgePulse Python SDK for edge functions monitoring and observability

EdgePulse Python SDK

The EdgePulse Python SDK provides monitoring and observability capabilities for Python applications. It allows you to track function executions, capture timing data, handle errors, and send telemetry to EdgePulse services.

Installation

Install the EdgePulse SDK using pip:

pip install edgepulse

Quick Start

1. Set up your environment:

   export EDGEPULSE_PROJECT_KEY="your-api-key-here"
   export EDGEPULSE_API_URL="https://api.edgepulse.com/api/Invocation"  # Optional
   

2. Use the decorator to monitor functions:

   from Edgepulse import with_edgepulse
   
   @with_edgepulse
   def my_function(x, y):
       """Your function logic here."""
       return x + y
   
   # The function will now be monitored automatically
   result = my_function(1, 2)
   

Features

• Zero-configuration monitoring: Simple decorator-based approach
• Automatic timing: Captures function execution duration
• Error tracking: Records exceptions with full stack traces
• Flexible telemetry: Sends data to configurable EdgePulse endpoints
• Type safety: Full type hints for better development experience
• No external dependencies: Uses only Python standard library

Configuration

The SDK uses environment variables for configuration:

• EDGEPULSE_PROJECT_KEY (required): Your EdgePulse API key
• EDGEPULSE_API_URL (optional): EdgePulse API endpoint (defaults to https://edgepulse.jeremytrips.be)
• EDGEPULSE_DEBUG (optional): Set to 1, true, or True to mark invocations as debug (suppresses error notifications)
• EDGEPULSE_CAPTURE_ARGS (optional): Set to 1, true, or True to capture function arguments in error events (default: False)

Advanced Usage

Capturing Function Arguments

By default, function arguments are not captured for privacy reasons. To enable argument capture in error events:

from Edgepulse import configure

# Enable globally
configure(api_key="your-key", capture_args=True)

@with_edgepulse
def process_payment(amount, card_number):
    # If an error occurs, arguments will be captured
    # Sensitive parameters like 'card_number' containing 'password', 'token',
    # 'secret', 'api_key', or 'auth' are automatically redacted
    pass

Or using environment variables:

export EDGEPULSE_CAPTURE_ARGS=true

Security & Privacy:

• Arguments are only captured when errors occur (not for successful invocations)
• Sensitive parameter names are automatically redacted (password, token, secret, api_key, auth patterns)
• Argument data is size-limited to 10KB (truncated if larger)
• Non-serializable objects are replaced with [Non-serializable: TypeName] placeholders

Per-Function Configuration

from Edgepulse import with_edgepulse, EdgePulseConfig

# Configure per function
@with_edgepulse(cfg=EdgePulseConfig(
    api_key="your-key",
    capture_args=True
))
def critical_function(data):
    # This function will capture arguments on errors
    pass

Custom HTTP client

from Edgepulse import WebClient, store_invocation

# Use a custom client with different timeout
client = WebClient("https://api.edgepulse.com/api/Invocation", timeout=30)
store_invocation(invocation, client=client)

Development

Setting up development environment

git clone https://github.com/edgepulse/sdk-python.git
cd sdk-python
pip install -e ".[dev]"

Requirements

• Python 3.9+

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

• Documentation: Does not exists yet
• Issues: https://github.com/jeremytrips/edgepulse.py/issues
• Email: [e-mail]

Contributing

We welcome contributions!