Volcengine TLS Bootstrap

A Python bootstrap utility for automatically installing and configuring Volcengine's OpenTelemetry instrumentation packages for LLM applications. This package provides a command-line interface similar to opentelemetry-instrumentation for seamless integration with Volcengine TLS (Torch Log Service).

Overview

The volcengine-tls-bootstrap package serves as a centralized installer for Volcengine's OpenTelemetry instrumentation ecosystem, specifically designed for:

• LangChain applications - Automatic instrumentation of LangChain LLM calls
• OpenAI integrations - Tracing OpenAI API calls and completions
• General Python services - Comprehensive observability for distributed systems

Installation

pip install "volcengine-tls-bootstrap==<bootstrap-release>"

Quick Start

Install All Instrumentation Packages

volcengine-tls-bootstrap -a install -v <runtime-release>

Install Specific Version (Optional)

volcengine-tls-bootstrap -a install -v 1.0.1

volcengine-tls-bootstrap is the only package that users install from PyPI. -a install downloads the versioned Python runtime bundle from the TLS TOS artifact repository and installs the wheel set contained in that bundle. Pin both <bootstrap-release> and <runtime-release> according to the release manifest; do not separately install instrumentation or exporter wheels from PyPI, and do not use an unbounded upgrade during container startup.

Install Into a Non-standard Directory

When PIPPATH is used, pip --target does not automatically expose installed modules or console scripts to the application. Bootstrap writes a helper after installation; source it in the same process that starts the application:

export PIPPATH=/opt/tls-agent
volcengine-tls-bootstrap -a install -v <runtime-release>
source /opt/tls-agent/activate-volcengine-tls.sh
volcengine-tls-instrument --check
volcengine-tls-instrument python app.py

Commands

The bootstrap utility supports the following operations:

• install - Download and install the versioned Volcengine OpenTelemetry runtime bundle (default)
• uninstall - Remove all installed instrumentation packages
• requirements - Install instrumentation packages based on detected dependencies

Configuration

The installer automatically configures:

• OpenTelemetry SDK initialization
• TLS exporter configuration
• Context propagation settings
• Auto-instrumentation hooks

Privacy Notice

By default, this package will record prompts and completions as span attributes in your traces. This behavior can be configured through environment variables or manual instrumentation settings.