From 4ed5e544b0d7e8bad60dfcde334d81331551fbee Mon Sep 17 00:00:00 2001
From: Nir Gazit <nirga@users.noreply.github.com>
Date: Mon, 15 Jan 2024 04:15:02 +0100
Subject: [PATCH] docs: added openllmetry observability (#369)

---
 .../docs/modules/observability/_category_.yml |  1 +
 apps/docs/docs/modules/observability/index.md | 35 +++++++++++++++++++
 2 files changed, 36 insertions(+)
 create mode 100644 apps/docs/docs/modules/observability/_category_.yml
 create mode 100644 apps/docs/docs/modules/observability/index.md

diff --git a/apps/docs/docs/modules/observability/_category_.yml b/apps/docs/docs/modules/observability/_category_.yml
new file mode 100644
index 000000000..cebf0fd89
--- /dev/null
+++ b/apps/docs/docs/modules/observability/_category_.yml
@@ -0,0 +1 @@
+label: Observability
diff --git a/apps/docs/docs/modules/observability/index.md b/apps/docs/docs/modules/observability/index.md
new file mode 100644
index 000000000..75ab36e49
--- /dev/null
+++ b/apps/docs/docs/modules/observability/index.md
@@ -0,0 +1,35 @@
+# Observability
+
+LlamaIndex provides **one-click observability** 🔭 to allow you to build principled LLM applications in a production setting.
+
+A key requirement for principled development of LLM applications over your data (RAG systems, agents) is being able to observe, debug, and evaluate
+your system - both as a whole and for each component.
+
+This feature allows you to seamlessly integrate the LlamaIndex library with powerful observability/evaluation tools offered by our partners.
+Configure a variable once, and you'll be able to do things like the following:
+
+- View LLM/prompt inputs/outputs
+- Ensure that the outputs of any component (LLMs, embeddings) are performing as expected
+- View call traces for both indexing and querying
+
+Each provider has similarities and differences. Take a look below for the full set of guides for each one!
+
+## OpenLLMetry
+
+[OpenLLMetry](https://github.com/traceloop/openllmetry-js) is an open-source project based on OpenTelemetry for tracing and monitoring
+LLM applications. It connects to [all major observability platforms](https://www.traceloop.com/docs/openllmetry/integrations/introduction) and installs in minutes.
+
+### Usage Pattern
+
+```bash
+npm install @traceloop/node-server-sdk
+```
+
+```js
+import * as traceloop from "@traceloop/node-server-sdk";
+
+traceloop.initialize({
+  apiKey: process.env.TRACELOOP_API_KEY,
+  disableBatch: true,
+});
+```
-- 
GitLab