toolscope-obs 0.1.0

Production observability for your applications

Toolscope Python SDK

Production observability and telemetry collection SDK for python applications and Wikimedia Toolforge tools.

Installation

You can install the Toolscope SDK from PyPI:

pip install toolscope-obs

Or install with optional requests instrumentation support:

pip install "toolscope-obs[requests]"

Quick Start

Initialize the SDK at the entry point of your application:

import toolscope
import logging

# Initialize the SDK
toolscope.init(
    api_key="ts_live_your_api_key",
    backend_url="http://localhost:3000/api" # Optional: defaults to production api
)

# Start logging
logging.info("Application started")

Job and Metric Monitoring

Isolate specific runs, jobs, or requests in your application using the job context manager:

with toolscope.job("generate_image") as run_id:
    # All print outputs, logs, requests, and unhandled errors 
    # inside this block are automatically tagged with the job's run_id.
    print("Beginning image rendering task...")
    
    # Track custom metrics
    toolscope.metric("GPU_temp_c", 65.5)