Skip to content

Commit 79971f8

Browse files
committed
docs: update BYOI documentation to reflect current compatibility matrix
- Remove 'coming soon' references since compatibility matrix is now live - Replace OpenLLMetry references with accurate Traceloop instrumentor info - Remove pip install examples for non-onboarded providers (LangChain, LlamaIndex) - Update to reflect only the 11 officially supported instrumentors - Update 'Upcoming Features' to 'Available Features' for implemented functionality - Correct ecosystem-specific package group examples to match onboarded providers The BYOI documentation now accurately reflects the completed compatibility matrix framework and supported instrumentor ecosystem.
1 parent d2f6618 commit 79971f8

1 file changed

Lines changed: 35 additions & 36 deletions

File tree

‎docs/explanation/architecture/byoi-design.rst‎

Lines changed: 35 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -165,12 +165,12 @@ HoneyHive supports multiple instrumentor providers through its BYOI architecture
165165
- **LLM-focused** with rich semantic conventions
166166
- **Multi-provider** support from day one
167167

168-
**OpenLLMetry Instrumentors**
168+
**Traceloop Instrumentors**
169169

170-
- **Comprehensive LLM coverage** across providers
171-
- **Production-ready** instrumentation
172-
- **Active development** and maintenance
173-
- **Enterprise support** available
170+
- **Enhanced metrics and monitoring** capabilities
171+
- **Production-ready** instrumentation with detailed cost tracking
172+
- **OpenTelemetry-based** for standardization
173+
- **Extended provider support** with performance analytics
174174

175175
**Custom Instrumentors**
176176

@@ -195,14 +195,10 @@ HoneyHive supports multiple instrumentor providers through its BYOI architecture
195195
# Alternative: Manual installation
196196
pip install honeyhive openinference-instrumentation-google-generativeai
197197
198-
# OpenLLMetry Providers (alternative)
199-
pip install openllmetry[openai]
200-
pip install openllmetry[anthropic]
201-
pip install openllmetry[google]
202-
203-
# Framework Support
204-
pip install openinference-instrumentation-llamaindex
205-
pip install openinference-instrumentation-langchain
198+
# Traceloop Providers (alternative - enhanced metrics)
199+
pip install opentelemetry-instrumentation-openai
200+
pip install opentelemetry-instrumentation-anthropic
201+
pip install opentelemetry-instrumentation-bedrock
206202
207203
.. note::
208204
**Compatibility Matrix Available**
@@ -392,15 +388,15 @@ HoneyHive provides industry-leading ecosystem-specific convenience groupings tha
392388
393389
# Ecosystem-specific integration groups (RECOMMENDED)
394390
pip install honeyhive[openinference-openai] # OpenAI via OpenInference
395-
pip install honeyhive[openinference-langchain] # LangChain via OpenInference
396391
pip install honeyhive[openinference-anthropic] # Anthropic via OpenInference
392+
pip install honeyhive[openinference-bedrock] # AWS Bedrock via OpenInference
393+
pip install honeyhive[openinference-google-ai] # Google AI via OpenInference
397394
398395
# Multi-ecosystem installation
399396
pip install honeyhive[openinference-openai,openinference-anthropic]
400397
401398
# Convenience groups for common scenarios
402-
pip install honeyhive[all-openinference] # All OpenInference integrations
403-
pip install honeyhive[openinference-llm-providers] # Popular LLM providers only
399+
pip install honeyhive[all-openinference] # All OpenInference integrations
404400
405401
**Key Benefits of Ecosystem-Specific Groups:**
406402

@@ -428,7 +424,7 @@ HoneyHive provides industry-leading ecosystem-specific convenience groupings tha
428424
.. code-block:: python
429425
430426
# Example 2: Multi-provider setup with convenience groups
431-
# pip install honeyhive[openinference-llm-providers]
427+
# pip install honeyhive[all-openinference]
432428
433429
from honeyhive import HoneyHiveTracer
434430
from openinference.instrumentation.openai import OpenAIInstrumentor
@@ -444,42 +440,45 @@ HoneyHive provides industry-leading ecosystem-specific convenience groupings tha
444440
445441
.. code-block:: bash
446442
447-
# Example 3: Framework integration with ecosystem clarity
448-
pip install honeyhive[openinference-langchain]
449-
# Installs: openinference-instrumentation-langchain + langchain
443+
# Example 3: Specialized provider integration
444+
pip install honeyhive[openinference-google-adk]
445+
# Installs: openinference-instrumentation-google-adk + dependencies
450446
451447
This approach provides the best of both worlds: **BYOI flexibility** with **ecosystem-specific convenience**.
452448

453449
Future Evolution
454450
----------------
455451

456-
**Multi-Ecosystem Support (Coming Soon)**
452+
**Multi-Ecosystem Support**
457453

458-
The ecosystem-specific package groups enable future support for multiple instrumentor ecosystems:
454+
The ecosystem-specific package groups support multiple instrumentor ecosystems:
459455

460456
.. code-block:: bash
461457
462-
# Current: OpenInference ecosystem
458+
# OpenInference ecosystem (community-driven)
463459
pip install honeyhive[openinference-openai]
464-
pip install honeyhive[openinference-langchain]
465-
466-
# Future: OpenLLMetry ecosystem
467-
pip install honeyhive[openllmetry-openai]
468-
pip install honeyhive[openllmetry-langchain]
460+
pip install honeyhive[openinference-anthropic]
461+
pip install honeyhive[openinference-bedrock]
469462
470-
# Future: Custom enterprise ecosystems
471-
pip install honeyhive[enterprise-openai]
472-
pip install honeyhive[acme-corp-langchain]
463+
# Traceloop ecosystem (enhanced metrics)
464+
pip install honeyhive[traceloop-openai]
465+
pip install honeyhive[traceloop-anthropic]
466+
pip install honeyhive[traceloop-bedrock]
473467
474468
This pattern provides **unlimited scalability** for instrumentor ecosystem adoption while maintaining the core BYOI principles.
475469

476-
**Upcoming Features**
470+
**Available Features**
471+
472+
1. **Compatibility Matrix**: Complete testing documentation for all supported providers (:doc:`../index`)
473+
2. **Python Version Support**: Full validation across Python 3.11, 3.12, 3.13
474+
3. **Dynamic Generation**: Automated maintenance reducing manual work by 75%
475+
4. **Ecosystem-Specific Groups**: Convenient installation patterns for all supported providers
476+
477+
**Future Features**
477478

478479
1. **Instrumentor Registry**: Discover available instrumentors across ecosystems
479-
2. **Compatibility Matrix**: Track tested version combinations per ecosystem
480-
3. **Auto-detection**: Suggest instrumentors based on installed packages
481-
4. **Bundle Packages**: Pre-configured combinations for common use cases
482-
5. **Ecosystem Marketplace**: Community hub for instrumentor ecosystem discovery
480+
2. **Auto-detection**: Suggest instrumentors based on installed packages
481+
3. **Bundle Packages**: Pre-configured combinations for common use cases
483482

484483
**Community Growth**
485484

0 commit comments

Comments
 (0)