Skip to main content

CLI tool to generate structured LLM logs for CrashLens cost detection

Project description

CrashLens Logger 🧠💸

Structured Token & Cost Logs for OpenAI / Anthropic Usage

PyPI version MIT License

⚠️ Are you burning money on GPT calls without knowing where or why?
CrashLens Logger captures cost, tokens, and prompts in JSON logs — for FinOps, audits, or debugging.


Purpose

CrashLens Logger is a Python package for generating structured, machine-readable logs of LLM (Large Language Model) API usage.
It helps you:

  • Track prompt, model, and token usage for every AI call
  • Automatically calculate cost using standard model pricing
  • Output logs in newline-delimited JSON (NDJSON) for easy analysis, monitoring, and cost tracking

Real Use Cases

  • 🔍 Debug fallback loops by logging all model calls with prompt/token trace
  • 💰 Auto-generate cost reports across agents & users
  • 🧠 Analyze which prompts are burning tokens (and why)
  • 🛡️ Audit LLM usage for compliance or security

Installation

pip install --upgrade crashlens_logger

This will install or upgrade to the latest version.


Quick Start

from crashlens_logger import CrashLensLogger
import uuid
from datetime import datetime
import openai

logger = CrashLensLogger()

def call_and_log():
    trace_id = str(uuid.uuid4())
    start_time = datetime.utcnow().isoformat() + "Z"
    prompt = "What are the main tourist attractions in Rome?"
    model = "gpt-3.5-turbo"
    response = openai.ChatCompletion.create(
        model=model,
        messages=[{"role": "user", "content": prompt}]
    )
    end_time = datetime.utcnow().isoformat() + "Z"
    usage = response["usage"]
    logger.log_event(
        traceId=trace_id,
        startTime=start_time,
        endTime=end_time,
        input={"model": model, "prompt": prompt},
        usage=usage,
        output_file="logs.jsonl"  # <-- This will create/append to logs.jsonl
    )

Where Do Logs Go?

By default, logs are printed to stdout in newline-delimited JSON (NDJSON) format.

If you provide the output_file parameter (recommended), logs will also be appended to that file (e.g., logs.jsonl).

  • If the file does not exist, it will be created automatically.
  • If the file exists, each new log will be appended as a new line.

You can redirect output to a file as well:

python your_script.py > logs.jsonl

But using output_file="logs.jsonl" is the most robust and portable way to persist logs.


Example Output

{
  "traceId": "trace_norm_01",
  "startTime": "2025-07-22T10:30:05Z",
  "input": {"model": "gpt-3.5-turbo", "prompt": "What are the main tourist attractions in Rome?"},
  "usage": {"prompt_tokens": 10, "completion_tokens": 155, "total_tokens": 165},
  "cost": 0.0002375
}

What Gets Calculated Automatically?

  • total_tokens: If you provide prompt_tokens and completion_tokens in usage, the logger adds total_tokens.
  • cost: If you provide model, prompt_tokens, and completion_tokens, the logger calculates cost using standard pricing.

Troubleshooting

  • Cannot resolve host: Check your internet connection or DNS.
  • pip cache issues: Try pip install --no-cache-dir crashlens_logger
  • Permission errors: Use a virtual environment or add --user to your pip command.
  • Module not found: Ensure you’re using the correct Python environment.
  • File not created: Make sure you are passing output_file="logs.jsonl" to log_event and that your process has write permissions.

Roadmap

  • Token pricing overrides
  • File/DB exporters
  • SDK instrumentation helpers
  • Pydantic validation for log structure

Testing

Run tests with:

pytest

100% coverage on core logging logic.


License

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

crashlens_logger-1.0.6.tar.gz (10.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

crashlens_logger-1.0.6-py3-none-any.whl (10.5 kB view details)

Uploaded Python 3

File details

Details for the file crashlens_logger-1.0.6.tar.gz.

File metadata

  • Download URL: crashlens_logger-1.0.6.tar.gz
  • Upload date:
  • Size: 10.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.12.10 Windows/11

File hashes

Hashes for crashlens_logger-1.0.6.tar.gz
Algorithm Hash digest
SHA256 1eb2ea3b5a721fbee4bd9f03f4b12eca7002abe10b2a7c699b64fed43c432342
MD5 6c990293fd62b3e0719ed66fdd3eb430
BLAKE2b-256 6bd1edee9a0fccfe45b890793dc60f04db31e4aa9c13eedb676be754c0772c38

See more details on using hashes here.

File details

Details for the file crashlens_logger-1.0.6-py3-none-any.whl.

File metadata

  • Download URL: crashlens_logger-1.0.6-py3-none-any.whl
  • Upload date:
  • Size: 10.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.12.10 Windows/11

File hashes

Hashes for crashlens_logger-1.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 514731b1e93c8abc437b21cde0c8e593ce526b1599262a93bf4f56bd87af5f65
MD5 1319db9f91e8ed6b0dc8a569bd41bfff
BLAKE2b-256 65d49788ab983fbb601907a2abeec7c6e430e1db19e966ecae570434c066a365

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page