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.7b1.tar.gz (241.8 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.7b1-py3-none-any.whl (354.6 kB view details)

Uploaded Python 3

File details

Details for the file monocle_apptrace-0.8.7b1.tar.gz.

File metadata

  • Download URL: monocle_apptrace-0.8.7b1.tar.gz
  • Upload date:
  • Size: 241.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for monocle_apptrace-0.8.7b1.tar.gz
Algorithm Hash digest
SHA256 168a3014093fda605127fbd55882f6aad2724f61a5fe6c149ff2f8e1b30d5e78
MD5 9908863b30f63d6d5832f205ced37295
BLAKE2b-256 6b2bcae1c658d81e0868be0625e0c4fa2c9fb8047e2756b1fea51d503571ff63

See more details on using hashes here.

Provenance

The following attestation bundles were made for monocle_apptrace-0.8.7b1.tar.gz:

Publisher: release.yml on monocle2ai/monocle

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file monocle_apptrace-0.8.7b1-py3-none-any.whl.

File metadata

File hashes

Hashes for monocle_apptrace-0.8.7b1-py3-none-any.whl
Algorithm Hash digest
SHA256 0074a29d31ad6456f8f459901f1ece222228bd6385cfcca480aa25f4439e7171
MD5 ab49a6fb11be15574ec0063b6ab2c162
BLAKE2b-256 743e4c0d18b8eba8f9b21103bac5a57a33c1c4c4ca9a15f32b5a6b7e1a0d3784

See more details on using hashes here.

Provenance

The following attestation bundles were made for monocle_apptrace-0.8.7b1-py3-none-any.whl:

Publisher: release.yml on monocle2ai/monocle

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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