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.8.tar.gz (241.1 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.8-py3-none-any.whl (354.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: monocle_apptrace-0.8.8.tar.gz
  • Upload date:
  • Size: 241.1 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.8.tar.gz
Algorithm Hash digest
SHA256 ebebd8b8da8dbf48cdb708e14e1a61293c48e50ec02ba24cf29c01ea776ba02b
MD5 9fb42666c6ffbc3ead6cd070a881f7b0
BLAKE2b-256 7661ec2213cc56e2d5d6b67db691a408ca8ba9d8440ed48fc821a422b6a5560e

See more details on using hashes here.

Provenance

The following attestation bundles were made for monocle_apptrace-0.8.8.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.8-py3-none-any.whl.

File metadata

File hashes

Hashes for monocle_apptrace-0.8.8-py3-none-any.whl
Algorithm Hash digest
SHA256 7e17f0f73e4f446f8e8722251201ffc30429fea0d93d545b023b41bfc4f83503
MD5 7e80d5b00d635211dffeb1354bb03e8d
BLAKE2b-256 3b8f3757b6ca53346a32bc271e4d5c0dd64ad920eb1b05e514b00c8ff2e02c02

See more details on using hashes here.

Provenance

The following attestation bundles were made for monocle_apptrace-0.8.8-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