traceroot 0.0.2a1

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 -e .

Prerequisite

For the TraceRoot SDK to work with your application, we need to set up the following environment variable.

Please visit TraceRoot.AI to get these credentials.

export AWS_ACCESS_KEY_ID='your_access_key'
export AWS_SECRET_ACCESS_KEY='your_secret_key'
export AWS_REGION='your_region'

You may need to input following information to traceroot.init(...) at the beginning of your entry file for your Python program or put them in a yaml file called .traceroot-config.yaml in the root of your project. Following is an example of the yaml file:

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] 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 example is available in traceroot-examples/examples/multi_agent.