Merge pull request #330 from Portkey-AI/otel

otel + small changes

Author: vrushankportkey

docs.json

@@ -163,6 +163,7 @@
                   "product/enterprise-offering/access-control-management",
                   "product/enterprise-offering/budget-limits",
                   "product/enterprise-offering/security-portkey",
+                  "product/enterprise-offering/analytics-logs-export",
                   "product/enterprise-offering/logs-export",
                   "/product/enterprise-offering/audit-logs",
                   {

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

@@ -0,0 +1,50 @@
+---
+title: Analytics Logs Export
+---
+
+ Portkey supports exporting your Analytics data to OpenTelemetry (OTEL) compatible collectors, allowing you to integrate Portkey's analytics with your existing observability infrastructure.
+
+ ## Overview
+
+ 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.
+
+ ## Configuration
+
+ Portkey supports pushing your analytics data to an OTEL compatible endpoint. The following environment variables are needed for pushing to OTEL:
+
+ ```yaml
+ OTEL_PUSH_ENABLED: true
+ OTEL_ENDPOINT: http://localhost:4318
+ ```
+
+ Additionally, you can configure arbitrary resource attributes of the OTEL logs by setting a comma-separated value for `OTEL_RESOURCE_ATTRIBUTES`:
+
+ ```
+ OTEL_RESOURCE_ATTRIBUTES: ApplicationShortName=gateway,AssetId=12323,deployment.service=production
+ ```
+
+ ## Integration Options
+
+ Enterprise customers commonly use these analytics exports with:
+
+ - **Datadog**: Monitor and analyze your AI operations alongside other application metrics
+ - **AWS S3**: Store analytics data for long-term retention and analysis
+ - **Other OTEL-compatible systems**: Any system that can ingest OpenTelemetry data can be used with this feature
+
+ ## Use Cases
+
+ This feature enables:
+
+ - Centralized observability across your entire tech stack
+ - Long-term storage of analytics data
+ - Custom analytics dashboards in your preferred tools
+ - Integration with existing alerting systems
+
+ ## Getting Support
+
+ For additional assistance with setting up analytics data export:
+
+ - Join our [Discord community](https://portkey.sh/reddit-discord)
+ - Email us at [email protected]
+
+ Our team can help you with best practices for configuring your OTEL collectors and integrating with your existing systems.

product/guardrails/creating-raw-guardrails-in-json.mdx

@@ -14,7 +14,7 @@ With the Raw Guardrails mode, you can achieve all this.
 ### Example of a Raw Guardrail
 
 ```JSON
-"beforeRequestHooks": [{
+"before_request_hooks": [{
     "type": "guardrail",
     "id": "my_solid_guardrail",
     "checks": [{
@@ -35,7 +35,7 @@ In this example:
 ### Configuring Guardrail Actions
 
 ```JSON
-"beforeRequestHooks": [{
+"before_request_hooks": [{
     "type": "guardrail",
     "id": "my_solid_guardrail",
     "checks": [{