Skip to content

Commit e6984ab

Browse files
committed
chore: otel docs
1 parent 3ad9865 commit e6984ab

15 files changed

Lines changed: 466 additions & 88 deletions

File tree

changelog/2025/apr.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Read more about this [here](https://portkey.ai/docs/api-reference/admin-api/cont
4040

4141
**Export logs to your internal stack**
4242

43-
Enterprises can now push analytics logs to any OTEL-compliant store through Portkey to centralize monitoring, maintain compliance, and ensure efficient operations.
43+
Enterprises can now push analytics logs to any OTel-compliant store through Portkey to centralize monitoring, maintain compliance, and ensure efficient operations.
4444
See how it's done [here](https://portkey.ai/docs/product/enterprise-offering/components#analytics-store)
4545

4646
**Budget limits and rate limts on workspace**

changelog/2025/august.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@ Princeton and NYU shared how they're deploying Portkey across their institutions
77

88
**Future of AI Platforms** brought together industry leaders from Doordash, Postman, Qure.ai and more for honest conversations about challenges and opportunities.
99

10-
Meanwhile, we shipped what you asked for: multiple workspace guardrails, OTEL instrumentation, and day-zero support for the latest models.
10+
Meanwhile, we shipped what you asked for: multiple workspace guardrails, OTel instrumentation, and day-zero support for the latest models.
1111

1212
Here's what's new this month:
1313
## Summary
1414

1515
| Area | Key Highlights |
1616
| :--- | :------------ |
1717
| **Highlights** | • Making GenAI rollout easy with Princeton, NYU and Internet2 <br/> • Upcoming Palo Alto Networks webinar <br/> • New `/models` endpoint |
18-
| **Platform** | • Unified + Portkey batching <br/> • OTEL-based auto-instrumentation <br/> • Multiple guardrails at workspace level <br/> • CRUD Guardrails API |
18+
| **Platform** | • Unified + Portkey batching <br/> • OTel-based auto-instrumentation <br/> • Multiple guardrails at workspace level <br/> • CRUD Guardrails API |
1919
| **Gateway & Providers** | • Featherless.ai integration <br/> • GPT-OSS models support <br/> • Claude Opus 4.1 support <br/> • Custom models and pricing |
2020

2121
## Highlights
@@ -50,11 +50,11 @@ This reduces per-request overhead while providing automatic batch size optimizat
5050

5151
See how you can get started [here](http://localhost:3000/product/ai-gateway/batches).
5252

53-
### **OTEL-based autoinstrumentation**
53+
### **OTel-based autoinstrumentation**
5454
<video
5555
src="https://cfassets.portkey.ai/WEBSITE%2FPRODUCT%20PAGES%2FOVSERVABILITY%2FObservibility_point_3.mp4"
5656
controls
57-
title="OTEL-based Autoinstrumentation Demo"
57+
title="OTel-based Autoinstrumentation Demo"
5858
style={{ width: "100%", borderRadius: "8px", margin: "24px 0" }}
5959
/>
6060
Portkey now works as an OTel endpoint. Send telemetry from any OTel-compatible source into Portkey and view it alongside LLM call logs. End-to-end observability for performance, cost, and compliance. Super powerful for agent workflows.

changelog/2025/november.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ We’re closing the year with conversations and gatherings across the community!
1717
|---|---|
1818
| **Models & Providers** | • GPT-5.1 <br />• Gemini 3.0<br />• Claude Opus 4.5 <br />• New providers: Z-AI, MatterAI, CometAPI, Modal Labs |
1919
| **Platform** | • Conditioner Router now supports URL-based conditions<br />• Usage limits & rate-limit policies for org-wide control |
20-
| **Observability** | • Trace visibility by category<br />• Guardrail checks highlighted in logs<br />• OTEL log export |
20+
| **Observability** | • Trace visibility by category<br />• Guardrail checks highlighted in logs<br />• OTel log export |
2121
| **Guardrails** | • F5 Guardrail added<br />• Javelin Guardrails added <br /> • Guardrails for streaming responses|
2222

2323
## How Snorkel AI runs multi-agents evals for frontier models
@@ -66,7 +66,7 @@ See guardrail-flagged events more prominently in logs, simplifying debugging of
6666

6767
<img src="/images/changelog/guardrails-logs.png" alt="guardrails-checks-in-logs" style={{maxWidth: "80%", borderRadius: "8px", margin: "24px 0"}} />
6868

69-
### OTEL Log Export [Experimental]
69+
### OTel Log Export [Experimental]
7070

7171
You can now export Gateway logs to an OpenTelemetry-compatible endpoint, aligned to experimental GenAI semantic conventions, allowing external systems to ingest AI activity traces. Read more about this [here](https://portkey.ai/docs/product/observability/opentelemetry#experimental-features).
7272

changelog/2025/september.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ New provider focused on efficient inference for specialized workloads
155155
* **Azure Foundry** → You can now enable multiple models in a single Azure Foundry integration. This simplifies management and makes it easier to experiment with different models under the same integration, without repetitive setup.
156156

157157
* Support custom scope for entra auth to use with deprecated azure serverless models
158-
* Custom Header support for OTEL Export of analytics data
158+
* Custom Header support for OTel Export of analytics data
159159

160160

161161
🚨 **Vertex AI deprecation** → Llama 3.1 + 3.2 models will be retired on Jan 15, 2026. Recommended migration: Llama 3.3 or Llama 4.

changelog/enterprise.mdx

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -413,7 +413,7 @@ Discuss how Portkey's AI Gateway can enhance your organization's AI infrastructu
413413

414414
### Fixes and Improvements
415415
- Enhancements for token rate limiter to handle small limit values
416-
- Fixed status code and timestamp handling for OTEL `http/protobuf` transport protocol
416+
- Fixed status code and timestamp handling for OTel `http/protobuf` transport protocol
417417
- Fixed an issue with `multipart/form-data` requests when the data contained a `model` field
418418
- Added support for multiple checks of same type under a single guardrail
419419

@@ -468,7 +468,7 @@ Discuss how Portkey's AI Gateway can enhance your organization's AI infrastructu
468468
## v1.15.5
469469
---
470470

471-
### OTEL Exporter Enhancements
471+
### OTel Exporter Enhancements
472472
- Added support for `http/protobuf` transport protocol.
473473
- Set `OTEL_EXPORTER_OTLP_PROTOCOL` environment variable to `http/protobuf` to use this.
474474

@@ -512,7 +512,7 @@ Discuss how Portkey's AI Gateway can enhance your organization's AI infrastructu
512512
### New Features
513513
- KMS Support for file uploads to bedrock/AWS.
514514
- Support custom scope for entra auth to use with deprecated azure serverless models.
515-
- Custom Header support for OTEL Export of analytics data
515+
- Custom Header support for OTel Export of analytics data
516516

517517

518518
### Improvements and Fixes
@@ -894,8 +894,8 @@ Discuss how Portkey's AI Gateway can enhance your organization's AI infrastructu
894894
- **Azure**: Added support for custom hosts and private links for Azure Plugins
895895
- **Bedrock**: Added native support for `inference profiles` [Ref](https://docs.aws.amazon.com/bedrock/latest/userguide/inference-profiles-use.html)
896896

897-
### OTEL Traces Collector endpoints
898-
- Added new endpoint `/v1/otel/v1/traces` to collect any OTEL traces as Portkey traces
897+
### OTel Traces Collector endpoints
898+
- Added new endpoint `/v1/otel/v1/traces` to collect any OTel traces as Portkey traces
899899

900900
### Log Exports available on Data Plane
901901
- Log exports are now available on Data Plane
@@ -944,7 +944,7 @@ Discuss how Portkey's AI Gateway can enhance your organization's AI infrastructu
944944
- Applicable for Anthropic, Bedrock-Anthropic and VertexAI-Anthropic models.
945945
- [Docs](/integrations/llms/anthropic#processing-pdfs-with-claude)
946946

947-
### OTEL Configurations
947+
### OTel Configurations
948948
- Added two new environment variables:
949949
- `OTEL_SERVICE_NAME`: Sets the `service.name` resource attribute value.
950950
- `OTEL_RESOURCE_ATTRIBUTES`: Comma-separated `key=value` pairs which will be sent as individual resource attributes.
@@ -1023,9 +1023,9 @@ Discuss how Portkey's AI Gateway can enhance your organization's AI infrastructu
10231023
## v1.10.19
10241024
---
10251025

1026-
### OTEL Metrics Push
1027-
- Added support for pushing Portkey Clickhouse analytics (traces and spans) to OTEL collector.
1028-
- The following environment variables will be used to configure OTEL collector:
1026+
### OTel Metrics Push
1027+
- Added support for pushing Portkey Clickhouse analytics (traces and spans) to OTel collector.
1028+
- The following environment variables will be used to configure OTel collector:
10291029
- `OTEL_PUSH_ENABLED`
10301030
- `OTEL_ENDPOINT`
10311031

@@ -1065,9 +1065,9 @@ We are redacting this release and will be releasing a patch with out Workspace B
10651065
- Organisations can now enforce usage limits for each workspace
10661066
- Organisations can now enforce rate limits for each workspace
10671067

1068-
### OTEL Metrics Push
1069-
- Added support for pushing Portkey Clickhouse analytics (traces and spans) to OTEL collector.
1070-
- The following environment variables will be used to configure OTEL collector:
1068+
### OTel Metrics Push
1069+
- Added support for pushing Portkey Clickhouse analytics (traces and spans) to OTel collector.
1070+
- The following environment variables will be used to configure OTel collector:
10711071
- `OTEL_PUSH_ENABLED`
10721072
- `OTEL_ENDPOINT`
10731073

docs.json

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,14 @@
194194
"product/enterprise-offering/access-control-management",
195195
"product/enterprise-offering/budget-limits",
196196
"product/enterprise-offering/security-portkey",
197-
"product/enterprise-offering/analytics-logs-export",
197+
{
198+
"group": "OpenTelemetry(OTel)",
199+
"pages": [
200+
"product/enterprise-offering/otel/otel",
201+
"product/enterprise-offering/otel/analytics",
202+
"product/enterprise-offering/otel/complete-logs"
203+
]
204+
},
198205
"product/enterprise-offering/logs-export",
199206
"/product/enterprise-offering/audit-logs",
200207
"product/enterprise-offering/budget-policies",

integrations/agents/pydantic-ai.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -563,7 +563,7 @@ For comprehensive monitoring and observability, Portkey supports OpenTelemetry i
563563
```python
564564
import openlit
565565

566-
# Initialize OpenLit with Portkey's OTEL endpoint
566+
# Initialize OpenLit with Portkey's OTel endpoint
567567
openlit.init(
568568
otlp_endpoint="https://api.portkey.ai/v1/otel",
569569
otlp_headers={

product/enterprise-offering/analytics-logs-export.mdx

Lines changed: 0 additions & 52 deletions
This file was deleted.

product/enterprise-offering/components.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Portkey leverages Clickhouse as the primary Analytics Store for the Control Pane
1515
</CardGroup>
1616

1717
<Note>
18-
Portkey supports exporting your Clickhouse analytics data to OpenTelemetry (OTEL) compatible collectors, allowing you to integrate Portkey's analytics with your existing observability infrastructure.
18+
Portkey supports exporting your Clickhouse analytics data to OpenTelemetry (OTel) compatible collectors, allowing you to integrate Portkey's analytics with your existing observability infrastructure.
1919
</Note>
2020

2121

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
---
2+
title: Analytics Export
3+
sidebarTitle: Analytics
4+
description: Export Portkey analytics data to OpenTelemetry-compatible collectors for centralized observability
5+
---
6+
7+
Portkey supports sending your Analytics data to OpenTelemetry (OTel) compatible collectors, allowing you to integrate Portkey's analytics with your existing observability infrastructure.
8+
9+
## Overview
10+
11+
While Portkey leverages Clickhouse as the primary Analytics Store for the Control Panel by default, enterprise customers can integrate Portkey's analytics data with their existing data infrastructure through OpenTelemetry.
12+
13+
This export focuses on **aggregated metrics and analytics data** such as:
14+
15+
- Request counts and latency metrics
16+
- Token usage statistics
17+
- Cost tracking data
18+
- Error rates and status codes
19+
20+
<Note>
21+
For exporting complete request/response logs with full prompt and completion content, see [Complete Logs Export](/product/enterprise-offering/otel/complete-logs).
22+
</Note>
23+
24+
## Configuration
25+
26+
Portkey supports pushing your analytics data to an OTel compatible endpoint. The following environment variables are needed for pushing to OTel:
27+
28+
```yaml
29+
OTEL_PUSH_ENABLED: true
30+
OTEL_ENDPOINT: http://localhost:4318
31+
OTEL_EXPORTER_OTLP_HEADERS: x-api-key=my-api-key,x-another-header=value
32+
```
33+
34+
### Environment Variables
35+
36+
| Variable | Required | Description |
37+
|----------|----------|-------------|
38+
| `OTEL_PUSH_ENABLED` | Yes | Set to `true` to enable analytics export |
39+
| `OTEL_ENDPOINT` | Yes | The OTLP endpoint URL |
40+
| `OTEL_EXPORTER_OTLP_HEADERS` | No | Comma-separated headers in `key=value` format |
41+
42+
### Resource Attributes
43+
44+
You can configure arbitrary resource attributes of the OTel logs by setting a comma-separated value for `OTEL_RESOURCE_ATTRIBUTES`:
45+
46+
```yaml
47+
OTEL_SERVICE_NAME: portkey-gateway
48+
OTEL_RESOURCE_ATTRIBUTES: ApplicationShortName=gateway,AssetId=12323,deployment.service=production
49+
```
50+
51+
| Variable | Description |
52+
|----------|-------------|
53+
| `OTEL_SERVICE_NAME` | Service name for the telemetry data |
54+
| `OTEL_RESOURCE_ATTRIBUTES` | Comma-separated key=value pairs for additional resource attributes |
55+
56+
## Integration Options
57+
58+
Enterprise customers commonly use these analytics exports with:
59+
60+
- **Datadog**: Monitor and analyze your AI operations alongside other application metrics
61+
- **AWS S3**: Store analytics data for long-term retention and analysis
62+
- **Prometheus/Grafana**: Build custom dashboards and alerting
63+
- **Splunk**: Integrate with existing SIEM infrastructure
64+
- **Other OTel-compatible systems**: Any system that can ingest OpenTelemetry data
65+
66+
## Use Cases
67+
68+
This feature enables:
69+
70+
- Centralized observability across your entire tech stack
71+
- Long-term storage of analytics data
72+
- Custom analytics dashboards in your preferred tools
73+
- Integration with existing alerting systems
74+
- Compliance and audit trail requirements
75+
76+
## Getting Support
77+
78+
For additional assistance with setting up analytics data export:
79+
80+
- Join our [Discord community](https://portkey.sh/reddit-discord)
81+
- Email us at support@portkey.ai
82+
83+
Our team can help you with best practices for configuring your OTel collectors and integrating with your existing systems.
84+

0 commit comments

Comments
 (0)