Skip to main content

package with monocle genAI tracing

Project description

Monocle Apptrace

Monocle helps developers and platform engineers building or managing GenAI apps monitor these in prod by making it easy to instrument their code to capture traces that are compliant with open-source cloud-native observability ecosystem.

Monocle is a community-driven OSS framework for tracing GenAI app code governed as a Linux Foundation AI & Data project.

Use Monocle

  • Get the Monocle package
    pip install monocle_apptrace 
  • Instrument your app code
    • Import the Monocle package
         from monocle_apptrace.instrumentor import setup_monocle_telemetry
      
    • Setup instrumentation in your main() function
         setup_monocle_telemetry(workflow_name="your-app-name")
      
  • (Optionally) Modify config to alter where traces are sent

See Monocle user guide for more details.

Claude Code Instrumentation

# 1. Install uv (if not already installed)
curl -LsSf https://astral.sh/uv/install.sh | sh

# 2. Install package
uv tool install monocle_apptrace

# 3. Register hooks — prompts for Okahu API key (leave blank for local-only)
monocle-apptrace claude-setup

Start a new Claude Code session — traces flow automatically.

See Hook Setup Guide for complete instructions.

Codex CLI Instrumentation

# 1. Install uv (if not already installed)
curl -LsSf https://astral.sh/uv/install.sh | sh

# 2. Install package
uv tool install monocle_apptrace

# 3. Register hooks — prompts for Okahu API key (leave blank for local-only)
monocle-apptrace codex-setup

Start a new Codex session — traces flow automatically.

See Hook Setup Guide for complete instructions.

GitHub Copilot Instrumentation

# 1. Install uv (if not already installed)
curl -LsSf https://astral.sh/uv/install.sh | sh

# 2. Install package
uv tool install monocle_apptrace

# 3. Register hooks — prompts for Okahu API key (leave blank for local-only)
monocle-apptrace copilot-setup

After setup, reload your environment for the config to take effect — run source ~/.zshrc (or your shell's equivalent) in the terminal, or Developer: Reload Window in VS Code.

Captures traces from both Copilot CLI and VS Code Copilot Chat. Start a session — traces flow automatically.

Token counts are collected via Copilot's built-in OpenTelemetry file exporter, which copilot-setup enables automatically. Trace data is written to ~/.monocle/.copilot_otel/copilot.jsonl and attached to the emitted OTel spans at the end of each turn.

See Hook Setup Guide for complete instructions.

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

monocle_apptrace-0.8.5.tar.gz (225.5 kB view details)

Uploaded Source

Built Distribution

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

monocle_apptrace-0.8.5-py3-none-any.whl (338.1 kB view details)

Uploaded Python 3

File details

Details for the file monocle_apptrace-0.8.5.tar.gz.

File metadata

  • Download URL: monocle_apptrace-0.8.5.tar.gz
  • Upload date:
  • Size: 225.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.14

File hashes

Hashes for monocle_apptrace-0.8.5.tar.gz
Algorithm Hash digest
SHA256 18be1aff5988e001bab619763a5a6250750d15dd5372361e40e86c16c0494cc6
MD5 ef2f6416bf193eb91070fb34df392543
BLAKE2b-256 c34a4968aa78ffb79d8be17a717159a27219bfbcb43847b7dc58b3f6f275c1d1

See more details on using hashes here.

File details

Details for the file monocle_apptrace-0.8.5-py3-none-any.whl.

File metadata

File hashes

Hashes for monocle_apptrace-0.8.5-py3-none-any.whl
Algorithm Hash digest
SHA256 ab88370d6a2780e4a7ceb50debeae2b852b8655a23e3c2b47629cecf89d31e5d
MD5 53dc0867e570c77bcd2f6e8ceaccf328
BLAKE2b-256 a220675f38635b73c65b45b6efa43e8c058a0a4c85678c87ecac030d2b9c85c4

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