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
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 founders@traceroot.ai 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
.