traceroot 0.0.4a3

A clean, principled wrapper around OpenTelemetry, AWS CloudWatch, and AWS X-Ray for enhanced debugging experience

TraceRoot SDK

TraceRoot SDK is a clean and principled package built upon OpenTelemetry with enhanced debugging and tracing experience. It provides smart and cloud-stored logging and tracing with minimal setup and code changes.

Quick Start

You can follow the docs here to get more details and have a deeper understanding of the TraceRoot SDK.

Installation

python3.11 -m venv venv
source venv/bin/activate
pip install traceroot
# or install the latest version from the source code
pip install -e .

Prerequisite

For the TraceRoot SDK to work with your application, we need to set up some environment variables with some credentials.

Please visit TraceRoot.AI to get the credentials.

You also need to input following information to traceroot.init(...) at the beginning of your entry file for your Python program to have a full experience:

traceroot.init(
    name="traceroot-ai",
    service_name="sdk-example-service",
    github_owner="traceroot-ai",
    github_repo_name="traceroot-sdk",
    github_commit_hash="main"
)

Or you can just put them in a yaml file called .traceroot-config.yaml in the root of your project:

name: "traceroot-ai"
service_name: "sdk-example-service"
github_owner: "traceroot-ai"
github_repo_name: "traceroot-sdk"
github_commit_hash: "main"

• Notice that the name is the name of the user who is using the TraceRoot SDK.
• service_name is the name of the service or program you are going to keep track of.

Please reach out to [e-mail] or visit TraceRoot.AI if you do not have these credentials or have any questions.

Examples

For an end-to-end example that uses the TraceRoot SDK for a multi-agent system, please refer to the Multi-agent System with TraceRoot SDK.

The source code of the multi-agent system example is available in traceroot-examples/examples/multi_agent.

Local Development

Download the Jaeger Docker image:

docker run cr.jaegertracing.io/jaegertracing/jaeger:2.8.0 --help

Run the Jaeger Docker container:

docker stop jaeger || true && docker rm jaeger || true && docker run -d --name jaeger \
  -e COLLECTOR_OTLP_ENABLED=true \
  -p 16686:16686 \
  -p 14268:14268 \
  -p 14250:14250 \
  -p 4317:4317 \
  -p 4318:4318 \
  cr.jaegertracing.io/jaegertracing/jaeger:2.8.0

docker logs -f jaeger