docs: Traceloop SDK integration documentation#9514
docs: Traceloop SDK integration documentation#9514mendonk merged 22 commits intolangflow-ai:docs-1.6from
Conversation
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the WalkthroughAdds a new Instana/Traceloop integration guide to the docs and registers it in the sidebar under Observability → Monitoring → Integrations. No code or API changes. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested labels
Suggested reviewers
✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
Status, Documentation and Community
|
|
@mendonk Hey, could you please review the PR. Thanks |
github-actions
bot
added
documentation
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Nitpick comments (7)
docs/sidebars.js (1)
138-145: Optional: keep the Integrations list alphabetizedCurrent order is mostly alphabetical (Arize → Langfuse → Langsmith → Langwatch → Opik). Consider placing
integrations-instana-traceloopafter Arize to preserve sort order.Apply this minimal move:
"Integrations/integrations-arize", + "Integrations/integrations-instana-traceloop", "Integrations/integrations-langfuse", "Integrations/integrations-langsmith", "Integrations/integrations-langwatch", "Integrations/integrations-opik", - "Integrations/integrations-instana-traceloop",docs/docs/Integrations/integrations-instana-traceloop.mdx (6)
10-19: Minor grammar/style fixes in “About” sections
- Prefer “the Traceloop SDK” and “the Instana observability platform”.
- Use short, direct sentences and second person.
-## About Traceloop +## About Traceloop @@ -Traceloop SDK is a lightweight instrumentation toolkit designed for LLM (Large Language Model) applications. It enables developers to automatically capture and export traces, metrics, and key observability signals from their LLM-powered workflows. +The Traceloop SDK is a lightweight instrumentation toolkit for LLM (large language model) applications. It automatically captures and exports traces, metrics, and key observability signals from LLM-powered workflows. @@ -When combined with Instana, the exported telemetry data from Traceloop provides end-to-end visibility—allowing users to visualize traces, analyze performance bottlenecks, and ensure reliable operation of LLM-driven applications. +When you connect Traceloop to Instana, you get end‑to‑end visibility: visualize traces, analyze performance bottlenecks, and improve reliability for LLM‑driven applications. @@ -Instana is IBM’s observability platform that provides real-time visibility into application performance. In this integration, Instana acts as the backend for viewing and analyzing the traces and metrics exported using the Traceloop SDK. It allows developers to monitor Langflow’s LLM workflows, visualize trace spans, and analyze performance metrics, making it easier to identify bottlenecks and ensure smooth operation. +Instana is IBM’s observability platform for real‑time application performance. In this integration, Instana is the backend for traces and metrics exported by the Traceloop SDK. You monitor Langflow workflows, visualize spans, and analyze performance metrics.
22-26: Prerequisites: grammar and clarity
- Remove backticks around plain nouns.
- Fix “Checkout” → “Check out”, extra space, and “setup” → “set up”.
-Before setting up observability, ensure you have: -- A `Traceloop API key` (for Traceloop integration): Navigate to the [Traceloop API Key settings](https://app.traceloop.com/settings/api-keys) to generate your API keys. -- An `Instana endpoint` and `Instana key` (for Instana integration): Checkout [Instana Documentation](https://www.ibm.com/docs/en/instana-observability/1.0.302) for reference. -- A running Langflow application setup +Before you set up observability, make sure you have: +- A Traceloop API key: go to the [Traceloop API keys](https://app.traceloop.com/settings/api-keys) page to generate your key. +- An Instana endpoint and API key: check the [Instana documentation](https://www.ibm.com/docs/en/instana-observability/1.0.302) to obtain these values. +- A running Langflow application.
57-62: Use language hint for the command and reference env vars docAdd shell highlighting and a pointer to our env vars guide for alternatives to
--env-file.-```bash -uv run langflow run --env-file .env -``` +```bash +uv run langflow run --env-file .env +``` + +See also: [Environment variables](../Configuration/environment-variables).
67-83: UI wording and style (bold UI elements; sentence case)Use bold for UI, sentence case for steps, and keep wording concise.
-1. **Run a flow in Langflow:** - - In Langflow, select the "Simple Agent" starter project - - In the **Agent** component's **API Key** field, enter your LLM API key - - Click **Playground** - - Ask your Agent several questions to generate test traffic +1. Run a flow in Langflow + - In Langflow, open the “Simple Agent” starter project. + - In the **Agent** Component, set your LLM **API key**. + - Click **Playground**. + - Ask the agent a few questions to generate test traffic. @@ -2. **View Traces in Instana:** - - Open Instana and select `Applications` from the sidebar. - - Click on `Services` tab in the Navbar (Top). - - Search for `Langflow` and click on it to view and analyze the associated calls. +2. View traces in Instana + - In Instana, go to **Applications** → **Services**. + - Search for **Langflow** and open it to analyze calls and spans. @@ -3. **View Metrics in Instana:** - - Open Instana and select `Infrastructure`. - - Click on `Analyse Infrastructure`. - - Search for `Otel LLMonitor`. - - Select `LLM:DC1@your_machine_name.local` to view your Metrics dashboard. +3. View metrics in Instana + - Go to **Infrastructure** → **Analyse infrastructure**. + - Search for **OTel LLMonitor**. + - Select **LLM:DC1@your_machine_name.local** to open the metrics dashboard.
84-97: Troubleshooting: convert to admonitions and tighten copyAdmonitions draw attention to issues per our docs guidelines.
-## Troubleshooting - -If you don't see traces appearing: -- Verify that your API keys and endpoints are correct in the `.env` file -- Ensure the `.env` file is in the correct root directory -- Confirm that Langflow is starting with the `--env-file .env` parameter -- Check that you've generated sufficient test traffic through the Playground - -If you don’t see metrics appearing: -- Ensure the OpenTelemetry (Otel) Data Collector is running without errors. -- Verify that the Otel DC config.yaml is configured as described above. -- Confirm that the Instana endpoint and the service port (e.g., service.port: 8000) are correctly exposed and accessible. -- Check whether the metrics are being logged in the Otel DC terminal output. +## Troubleshooting + +:::warning No traces in Instana +- Verify API keys and endpoints in your `.env`. +- Ensure you start Langflow with `--env-file .env` (or equivalent env setup). +- Generate enough test traffic in the **Playground**. +::: + +:::tip No metrics in Instana +- Confirm the OpenTelemetry (OTel) Collector is running without errors. +- Re-check the collector `config.yaml` and service port (for example, `8000`) exposure. +- Look for exporter/processor errors in the collector logs. +:::
98-98: Link wording and versioningUse current, version-agnostic doc links when possible and keep link text concise.
-For additional configuration options and advanced features, refer to the respective platform documentation for [Traceloop](https://www.traceloop.com/docs/introduction) or [Instana](https://www.ibm.com/docs/en/instana-observability/current). +For advanced configuration, see the docs for [Traceloop](https://www.traceloop.com/docs/introduction) and [Instana](https://www.ibm.com/docs/en/instana-observability/current).
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
docs/docs/Integrations/integrations-instana-traceloop.mdx(1 hunks)docs/sidebars.js(1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
docs/sidebars.js
📄 CodeRabbit inference engine (.cursor/rules/docs_development.mdc)
Sidebar navigation must be updated in docs/sidebars.js to reflect new or reorganized documentation content.
Files:
docs/sidebars.js
docs/docs/**/*.{md,mdx}
📄 CodeRabbit inference engine (.cursor/rules/docs_development.mdc)
docs/docs/**/*.{md,mdx}: All documentation content must be written in Markdown or MDX files located under docs/docs/, following the prescribed directory structure for guides, reference, how-to, concepts, and API documentation.
All documentation Markdown and MDX files must begin with a frontmatter block including at least title and description fields.
Use admonitions (:::tip, :::warning, :::danger) in Markdown/MDX files to highlight important information, warnings, or critical issues.
All images referenced in documentation must include descriptive alt text for accessibility.
All code examples included in documentation must be tested and verified to work as shown.
Internal links in documentation must be functional and not broken.
Content must follow the style guide: professional but approachable tone, second person voice, present tense, short paragraphs, sentence case headers, inline code with backticks, bold for UI elements, italic for emphasis, and parallel structure in lists.
Use consistent terminology: always capitalize Langflow, Component, Flow, and uppercase API and JSON.
Files:
docs/docs/Integrations/integrations-instana-traceloop.mdx
🧠 Learnings (1)
📚 Learning: 2025-07-18T18:26:42.027Z
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-07-18T18:26:42.027Z
Learning: Applies to docs/sidebars.js : Sidebar navigation must be updated in docs/sidebars.js to reflect new or reorganized documentation content.
Applied to files:
docs/sidebars.js
🪛 LanguageTool
docs/docs/Integrations/integrations-instana-traceloop.mdx
[grammar] ~8-~8: There might be a mistake here.
Context: ...ation Guide This guide explains how to integrate Instana observability platform using Tr...
(QB_NEW_EN)
[grammar] ~8-~8: There might be a mistake here.
Context: ...ntegrate Instana observability platform using Traceloop SDK with your Langflow applic...
(QB_NEW_EN)
[grammar] ~22-~22: There might be a mistake here.
Context: ...tting up observability, ensure you have: - A Traceloop API key (for Traceloop int...
(QB_NEW_EN)
[grammar] ~23-~23: There might be a mistake here.
Context: ...gs/api-keys) to generate your API keys. - An Instana endpoint and Instana key ...
(QB_NEW_EN)
[grammar] ~24-~24: There might be a mistake here.
Context: ...na-observability/1.0.302) for reference. - A running Langflow application setup ##...
(QB_NEW_EN)
[grammar] ~29-~29: There might be a mistake here.
Context: ... Step 1: Configure Environment Variables 1. Create a .env file in the root directo...
(QB_NEW_EN)
[grammar] ~42-~42: There might be a mistake here.
Context: ...e OTEL Data Collector is up and running. - In otel-dc config.yaml, add the follow...
(QB_NEW_EN)
[grammar] ~57-~57: There might be a mistake here.
Context: ...tart Langflow with Environment Variables Launch your Langflow application using t...
(QB_NEW_EN)
[grammar] ~67-~67: There might be a mistake here.
Context: ...correctly: 1. Run a flow in Langflow: - In Langflow, select the "Simple Agent" s...
(QB_NEW_EN)
[grammar] ~75-~75: There might be a mistake here.
Context: ...k on Services tab in the Navbar (Top). - Search for Langflow and click on it to...
(QB_NEW_EN)
[grammar] ~86-~86: There might be a mistake here.
Context: ...ting If you don't see traces appearing: - Verify that your API keys and endpoints ...
(QB_NEW_EN)
[grammar] ~93-~93: There might be a mistake here.
Context: ...ata Collector is running without errors. - Verify that the Otel DC config.yaml is c...
(QB_NEW_EN)
🔇 Additional comments (2)
docs/sidebars.js (1)
138-145: Add Instana/Traceloop doc to Monitoring → Integrations — LGTMThe new entry points to the correct doc id (
Integrations/integrations-instana-traceloop) and follows the existing pattern.docs/docs/Integrations/integrations-instana-traceloop.mdx (1)
33-37: Please verify environment variables and OTel Collector configurationBefore merging, confirm the following against the vendor documentation:
• OTEL_METRIC_EXPORT_INTERVAL
– The OpenTelemetry spec defines this environment variable with the singular form (METRIC), notMETRICS(opentelemetry.opendocs.io, opentelemetry.io). If you choose to expose a metric-export interval in this guide, use exactlyOTEL_METRIC_EXPORT_INTERVALor note that you rely on the 60 000 ms default.• TRACELOOP_METRICS_ENDPOINT
– The Traceloop-specific variable expects a bare host:port (no protocol or path), as shown in the Instana LLM Data Collector examples (e.g.otel-dc-llm.llm-monitoring.svc:8000) (community.ibm.com, ibm.com).• Collector YAML keys
– Ensure yourconfig.yamlfor the OpenTelemetry Data Collector uses the Instana-recommended fields (for example:
•otel.agentless.mode
•otel.backend.url
•otel.backend.using.http
•callback.interval
•otel.service.name
•otel.service.port
) exactly as documented by Instana (ibm.com).Applicable sections:
– Environment block (lines 33–37)
– Collector YAML snippet (lines 45–55)
– Deployment example (lines 79–83)
github-actions
bot
added
documentation
github-actions
bot
added
documentation
2getsandesh
force-pushed
the
docs-traceloop-sdk-integration
branch
from
57cf91e to
717079c
Compare
github-actions
bot
added
documentation
2getsandesh
force-pushed
the
docs-traceloop-sdk-integration
branch
from
717079c to
cffaf12
Compare
github-actions
bot
added
documentation
2getsandesh
force-pushed
the
docs-traceloop-sdk-integration
branch
from
cffaf12 to
e8218c3
Compare
github-actions
bot
removed
the
documentation
2getsandesh
force-pushed
the
docs-traceloop-sdk-integration
branch
from
d1639f3 to
4482a10
Compare
github-actions
bot
added
documentation
2getsandesh
force-pushed
the
docs-traceloop-sdk-integration
branch
from
4482a10 to
dc5757d
Compare
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Edwin Jose <edwinjose900@gmail.com>
Co-authored-by: Mendon Kissling <59585235+mendonk@users.noreply.github.com>
Co-authored-by: Mendon Kissling <59585235+mendonk@users.noreply.github.com>
Co-authored-by: Mendon Kissling <59585235+mendonk@users.noreply.github.com>
Co-authored-by: Mendon Kissling <59585235+mendonk@users.noreply.github.com>
2getsandesh
force-pushed
the
docs-traceloop-sdk-integration
branch
from
dc5757d to
3b18c73
Compare
github-actions
bot
removed
the
documentation
|
3 participants
This PR introduces a new documentation page for integrating Instana with Langflow using the Traceloop SDK. The guide provides end-to-end instructions for setting up observability to monitor and analyze LLM workflows within Langflow.
Related PR : #9317 — Implements Traceloop tracing support
Summary by CodeRabbit