Skip to content

Same agent Smaller bill. The tools and infrastructure to get more work from your AI. Fewer tokens. Less compute. Lower cost.

docs: add parseable telemetry destination (#1478)

Praveen K Bd8dce339e902
diff --git a/docs/docs.json b/docs/docs.json
index d305b68d..9952c71e 100644
--- a/docs/docs.json
+++ b/docs/docs.json
@@ -390,6 +390,7 @@
"latest/sdk/destinations/elastic",
"latest/sdk/destinations/hyperdx",
"latest/sdk/destinations/oneuptime",
+ "latest/sdk/destinations/parseable",
"latest/sdk/destinations/openobserve",
"latest/sdk/destinations/highlight",
"latest/sdk/destinations/middleware",
diff --git a/docs/latest/sdk/destinations/overview.mdx b/docs/latest/sdk/destinations/overview.mdx
index 3288abc8..19843591 100644
--- a/docs/latest/sdk/destinations/overview.mdx
+++ b/docs/latest/sdk/destinations/overview.mdx
@@ -2734,6 +2734,19 @@ The OpenLIT SDK can send AI observability data (traces, metrics, logs) from LLMs
</svg>
}
></Card>
+ <Card
+ title="Parseable"
+ href="/latest/sdk/destinations/parseable"
+ icon={
+ <svg width="512" height="512" viewBox="0 0 512 512" fill="none" xmlns="http://www.w3.org/2000/svg">
+ <path d="M382.773 157.268C397.535 142.483 421.487 142.465 436.272 157.227C451.056 171.989 451.074 195.941 436.313 210.725L209.118 438.268C194.356 453.052 170.404 453.07 155.619 438.308C140.835 423.547 140.816 399.594 155.578 384.81L382.773 157.268Z" fill="#17181C" />
+ <path d="M252.088 66.3252C260.324 58.1127 253.929 43.9364 242.382 44.8067C193.082 48.4586 144.758 69.1201 106.893 106.879C69.0268 144.638 48.0602 193.072 43.9897 242.641C43.0212 254.296 57.0531 260.856 65.289 252.598L252.088 66.3252Z" fill="#17181C" />
+ <path d="M445.222 259.741C453.472 251.543 467.744 257.877 466.886 269.356C463.287 318.365 442.574 366.428 404.644 404.123C366.714 441.818 318.018 462.733 268.155 466.854C256.431 467.835 249.809 453.897 258.105 445.699L445.222 259.741Z" fill="#17181C" />
+ <path d="M193.421 287.684L355.277 126.213C373.428 107.827 367.604 77.2794 343.884 66.6349L343.225 66.3675C328.748 59.8827 311.691 63.0294 300.607 74.303L138.937 235.588C124.295 250.418 124.633 274.077 139.692 288.488C154.75 302.899 178.781 302.56 193.422 287.73L193.421 287.684Z" fill="#17181C" />
+ <path d="M135.028 330.482C135.028 350.426 118.477 366.593 98.0599 366.593C77.643 366.593 61.0918 350.426 61.0918 330.482C61.0918 310.538 77.643 294.37 98.0599 294.37C118.477 294.37 135.028 310.538 135.028 330.482Z" fill="#17181C" />
+ </svg>
+ }
+ ></Card>
<Card
title="OpenObserve"
href="/latest/sdk/destinations/openobserve"
diff --git a/docs/latest/sdk/destinations/parseable.mdx b/docs/latest/sdk/destinations/parseable.mdx
new file mode 100644
index 00000000..5bf2e380
--- /dev/null
+++ b/docs/latest/sdk/destinations/parseable.mdx
@@ -0,0 +1,12 @@
+---
+title: 'Parseable'
+description: 'Send OpenLIT traces, metrics and logs to Parseable through an OpenTelemetry Collector'
+---
+
+import Intro from '/snippets/destinations/parseable/intro.mdx';
+import SDK from '/snippets/destinations/parseable/sdk.mdx';
+import Conclusion from '/snippets/destinations/parseable/conclusion.mdx';
+
+<Intro />
+<SDK />
+<Conclusion />
diff --git a/docs/snippets/destinations/parseable/conclusion.mdx b/docs/snippets/destinations/parseable/conclusion.mdx
new file mode 100644
index 00000000..acb92fc2
--- /dev/null
+++ b/docs/snippets/destinations/parseable/conclusion.mdx
@@ -0,0 +1,15 @@
+### 3. Explore your telemetry
+
+Run your application and confirm that Parseable receives records in these datasets:
+
+- `openlit-traces`
+- `openlit-metrics`
+- `openlit-logs`
+
+Filter by `service.name` to isolate your application. If a dataset is empty, check the Collector logs, Parseable URL, and API key permissions.
+
+### Related links
+
+- [OpenLIT configuration](/latest/sdk/configuration)
+- [Parseable OpenTelemetry documentation](https://www.parseable.com/docs/ingest-data/otel)
+- [Parseable API keys](https://www.parseable.com/docs/user-guide/api-keys)
diff --git a/docs/snippets/destinations/parseable/intro.mdx b/docs/snippets/destinations/parseable/intro.mdx
new file mode 100644
index 00000000..0b83da42
--- /dev/null
+++ b/docs/snippets/destinations/parseable/intro.mdx
@@ -0,0 +1,86 @@
+Send OpenLIT traces, metrics and logs to Parseable through an OpenTelemetry Collector.
+
+### 1. Configure OpenTelemetry Collector
+
+Parseable requires different dataset and source headers for each signal. Configure the Collector to add those headers and route each signal to its dataset.
+
+**Install the Collector**
+
+Skip installation when you run a Collector. To install one, follow the [OpenTelemetry Collector installation guide](https://opentelemetry.io/docs/collector/installation/).
+
+**Configure the Collector**
+
+The Collector accepts OTLP over HTTP and gRPC and sends each signal to a separate Parseable dataset.
+
+<Accordion title="Collector configuration">
+```yaml
+receivers:
+ otlp:
+ protocols:
+ grpc:
+ endpoint: 0.0.0.0:4317
+ http:
+ endpoint: 0.0.0.0:4318
+
+processors:
+ batch:
+ memory_limiter:
+ limit_mib: 1500
+ spike_limit_mib: 512
+ check_interval: 5s
+
+exporters:
+ otlphttp/parseable_traces:
+ endpoint: "${env:PARSEABLE_URL}"
+ encoding: json
+ headers:
+ X-API-Key: "${env:PARSEABLE_API_KEY}"
+ X-P-Stream: openlit-traces
+ X-P-Log-Source: otel-traces
+
+ otlphttp/parseable_metrics:
+ endpoint: "${env:PARSEABLE_URL}"
+ encoding: json
+ headers:
+ X-API-Key: "${env:PARSEABLE_API_KEY}"
+ X-P-Stream: openlit-metrics
+ X-P-Log-Source: otel-metrics
+
+ otlphttp/parseable_logs:
+ endpoint: "${env:PARSEABLE_URL}"
+ encoding: json
+ headers:
+ X-API-Key: "${env:PARSEABLE_API_KEY}"
+ X-P-Stream: openlit-logs
+ X-P-Log-Source: otel-logs
+
+service:
+ pipelines:
+ traces:
+ receivers: [ otlp ]
+ processors: [ memory_limiter, batch ]
+ exporters: [ otlphttp/parseable_traces ]
+ metrics:
+ receivers: [ otlp ]
+ processors: [ memory_limiter, batch ]
+ exporters: [ otlphttp/parseable_metrics ]
+ logs:
+ receivers: [ otlp ]
+ processors: [ memory_limiter, batch ]
+ exporters: [ otlphttp/parseable_logs ]
+```
+
+Set these environment variables before starting the Collector:
+
+```shell
+export PARSEABLE_URL="https://YOUR_PARSEABLE_HOST"
+export PARSEABLE_API_KEY="YOUR_PARSEABLE_API_KEY"
+```
+
+Replace:
+
+1. `YOUR_PARSEABLE_HOST` with your Parseable host. Do not append `/v1/traces`, `/v1/metrics`, or `/v1/logs`.
+2. `YOUR_PARSEABLE_API_KEY` with a Parseable API key that has ingest access.
+
+If your Parseable deployment uses Basic Auth, replace `X-API-Key` with `Authorization: "Basic YOUR_BASE64_CREDENTIALS"` in each exporter.
+</Accordion>
diff --git a/docs/snippets/destinations/parseable/sdk.mdx b/docs/snippets/destinations/parseable/sdk.mdx
new file mode 100644
index 00000000..87123529
--- /dev/null
+++ b/docs/snippets/destinations/parseable/sdk.mdx
@@ -0,0 +1,62 @@
+### 2. Instrument your application
+
+<Tabs>
+<Tab title="SDK">
+<Tabs>
+<Tab title="Function Arguments">
+```python
+import openlit
+
+openlit.init(
+ otlp_endpoint="http://YOUR_OTELCOL_HOST:4318"
+)
+```
+
+Replace `http://YOUR_OTELCOL_HOST:4318` with the HTTP endpoint, including the scheme, of your OpenTelemetry Collector.
+
+- Local Collector: `http://127.0.0.1:4318`
+- Kubernetes: `http://otel-collector.monitoring.svc.cluster.local:4318`
+</Tab>
+
+<Tab title="Environment Variables">
+```python
+import openlit
+
+openlit.init()
+```
+
+Set the Collector endpoint, including the scheme:
+
+```shell
+export OTEL_EXPORTER_OTLP_ENDPOINT="http://YOUR_OTELCOL_HOST:4318"
+```
+</Tab>
+</Tabs>
+</Tab>
+
+<Tab title="CLI">
+<Tabs>
+<Tab title="CLI Arguments">
+```shell
+openlit-instrument \
+ --otlp-endpoint "http://YOUR_OTELCOL_HOST:4318" \
+ --service-name "my-ai-service" \
+ --deployment-environment "production" \
+ python app.py
+```
+</Tab>
+
+<Tab title="Environment Variables">
+```shell
+export OTEL_EXPORTER_OTLP_ENDPOINT="http://YOUR_OTELCOL_HOST:4318"
+export OTEL_SERVICE_NAME="my-ai-service"
+export OTEL_DEPLOYMENT_ENVIRONMENT="production"
+
+openlit-instrument python app.py
+```
+</Tab>
+</Tabs>
+
+See the OpenLIT [Python SDK repository](https://github.com/openlit/openlit/tree/main/sdk/python) for more configuration options.
+</Tab>
+</Tabs>