From 584bf63b0d90df7c2e43f6c308c9881692357622 Mon Sep 17 00:00:00 2001 From: hegerchr Date: Wed, 12 Mar 2025 15:44:20 +0100 Subject: [PATCH 1/7] Added use case description for LLM. --- docs/use-cases/llm/index.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 docs/use-cases/llm/index.md diff --git a/docs/use-cases/llm/index.md b/docs/use-cases/llm/index.md new file mode 100644 index 00000000..b1bad976 --- /dev/null +++ b/docs/use-cases/llm/index.md @@ -0,0 +1,28 @@ +# LLM Observability with EDOT + +We currently support LLM observability with our EDOT Java, EDOT Node.js and EDOT Python as tech preview. + +# Supported Technologies + +| Technology | EDOT Java | EDOT Node.js | EDOT Python | +|:---------|:---------|:---------|:---------| +| OpenAI Client | :red_circle: | :red_circle: | :red_circle: | +| AWS Bedrock | :red_circle: | :red_circle: | :red_circle: | + +See the [Supported Technologies section in the corresponding EDOT SDK](../../_edot-sdks/) for detailed information on supported versions. + +# Quickstart Kubernetes + +This quick start describes the setup and collection of OpenTelemetry data for applications running on Kubernetes with Elastic Cloud Serverless. For other options see the [quick start overview](../../quickstart/) and choose your prefered environment and target system. + +1. **Setup Elastic Cloud Serverless** + +Follow the instructions to [setup your Elastic Cloud serverless project](../../quickstart/serverless/index.md). + +2. **Collect Data** + +Setup the collection of OpenTelemetry data for applications running on Kubernetes following the [quickstart for Kubernetes](../../quickstart/serverless/k8s.md). + +3. **Configuration** + +See the [Configuration section in the corresponding EDOT SDK](../../_edot-sdks/) to enable and disable specific instrumentations and to what instrumentation is enabled by default. \ No newline at end of file From 63401bbda97d6d8f598904e7ea5825934615a8ce Mon Sep 17 00:00:00 2001 From: hegerchr Date: Wed, 12 Mar 2025 15:54:38 +0100 Subject: [PATCH 2/7] Fixed broken links. --- docs/use-cases/llm/index.md | 18 +++++++----------- 1 file changed, 7 insertions(+), 11 deletions(-) diff --git a/docs/use-cases/llm/index.md b/docs/use-cases/llm/index.md index b1bad976..fb7d40ce 100644 --- a/docs/use-cases/llm/index.md +++ b/docs/use-cases/llm/index.md @@ -9,20 +9,16 @@ We currently support LLM observability with our EDOT Java, EDOT Node.js and EDOT | OpenAI Client | :red_circle: | :red_circle: | :red_circle: | | AWS Bedrock | :red_circle: | :red_circle: | :red_circle: | -See the [Supported Technologies section in the corresponding EDOT SDK](../../_edot-sdks/) for detailed information on supported versions. +See the [Supported Technologies section in the corresponding EDOT SDK](../../_edot-sdks/index.md) for detailed information on supported versions. -# Quickstart Kubernetes +# Quickstart -This quick start describes the setup and collection of OpenTelemetry data for applications running on Kubernetes with Elastic Cloud Serverless. For other options see the [quick start overview](../../quickstart/) and choose your prefered environment and target system. +This quick start describes the setup and collection of OpenTelemetry data for LLM applications. -1. **Setup Elastic Cloud Serverless** +1. **Setup** -Follow the instructions to [setup your Elastic Cloud serverless project](../../quickstart/serverless/index.md). +Choose the environment and target system from the [quick start overview](../../quickstart/index.md) and follow the setup instructions for your environment, target system and to instrument your LLM application. The instrumentation for the supported technologies is enabled by default. -2. **Collect Data** +2. **Configuration** -Setup the collection of OpenTelemetry data for applications running on Kubernetes following the [quickstart for Kubernetes](../../quickstart/serverless/k8s.md). - -3. **Configuration** - -See the [Configuration section in the corresponding EDOT SDK](../../_edot-sdks/) to enable and disable specific instrumentations and to what instrumentation is enabled by default. \ No newline at end of file +See the [Configuration section in the corresponding EDOT SDK](../../_edot-sdks/index.md) to enable and disable specific instrumentations and to see what instrumentation is enabled by default. \ No newline at end of file From 378030431b6e9d232e4f4b82afc49b0a9db8c51c Mon Sep 17 00:00:00 2001 From: Alexander Wert Date: Thu, 13 Mar 2025 16:43:44 +0100 Subject: [PATCH 3/7] Update docs/use-cases/llm/index.md --- docs/use-cases/llm/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/use-cases/llm/index.md b/docs/use-cases/llm/index.md index fb7d40ce..fe9e1c64 100644 --- a/docs/use-cases/llm/index.md +++ b/docs/use-cases/llm/index.md @@ -17,7 +17,7 @@ This quick start describes the setup and collection of OpenTelemetry data for LL 1. **Setup** -Choose the environment and target system from the [quick start overview](../../quickstart/index.md) and follow the setup instructions for your environment, target system and to instrument your LLM application. The instrumentation for the supported technologies is enabled by default. +Choose the environment and target system from the [quick start overview](../../quickstart/index) and follow the setup instructions to instrument your LLM application. The instrumentation for the supported technologies is enabled by default. 2. **Configuration** From 0ad8919aed6a07a39c61f52f765f0d252ad025bd Mon Sep 17 00:00:00 2001 From: Alexander Wert Date: Thu, 13 Mar 2025 16:43:52 +0100 Subject: [PATCH 4/7] Update docs/use-cases/llm/index.md --- docs/use-cases/llm/index.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/use-cases/llm/index.md b/docs/use-cases/llm/index.md index fe9e1c64..366e3206 100644 --- a/docs/use-cases/llm/index.md +++ b/docs/use-cases/llm/index.md @@ -1,3 +1,9 @@ +--- +title: LLM Observability +layout: default +nav_order: 5 +parent: Use Cases +--- # LLM Observability with EDOT We currently support LLM observability with our EDOT Java, EDOT Node.js and EDOT Python as tech preview. From e6aaddc5b46100d5857f2293d54ad9ec48e6ab51 Mon Sep 17 00:00:00 2001 From: Alexander Wert Date: Thu, 13 Mar 2025 16:44:03 +0100 Subject: [PATCH 5/7] Update docs/use-cases/llm/index.md --- docs/use-cases/llm/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/use-cases/llm/index.md b/docs/use-cases/llm/index.md index 366e3206..4a8d11fe 100644 --- a/docs/use-cases/llm/index.md +++ b/docs/use-cases/llm/index.md @@ -15,7 +15,7 @@ We currently support LLM observability with our EDOT Java, EDOT Node.js and EDOT | OpenAI Client | :red_circle: | :red_circle: | :red_circle: | | AWS Bedrock | :red_circle: | :red_circle: | :red_circle: | -See the [Supported Technologies section in the corresponding EDOT SDK](../../_edot-sdks/index.md) for detailed information on supported versions. +See the [Supported Technologies section in the corresponding EDOT SDK](../../_edot-sdks/index) for detailed information on supported versions. # Quickstart From 1e418b5032889120e60b40cd5744f4069e87bcb4 Mon Sep 17 00:00:00 2001 From: Alexander Wert Date: Thu, 13 Mar 2025 16:44:20 +0100 Subject: [PATCH 6/7] Update docs/use-cases/llm/index.md --- docs/use-cases/llm/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/use-cases/llm/index.md b/docs/use-cases/llm/index.md index 4a8d11fe..4f1ea3b8 100644 --- a/docs/use-cases/llm/index.md +++ b/docs/use-cases/llm/index.md @@ -27,4 +27,4 @@ Choose the environment and target system from the [quick start overview](../../q 2. **Configuration** -See the [Configuration section in the corresponding EDOT SDK](../../_edot-sdks/index.md) to enable and disable specific instrumentations and to see what instrumentation is enabled by default. \ No newline at end of file +See the [Configuration section in the corresponding EDOT SDK](../../_edot-sdks/index) to enable and disable specific instrumentations and to see what instrumentation is enabled by default. \ No newline at end of file From cdccb9b59b12f618549e4faa026abd89ab5b46b6 Mon Sep 17 00:00:00 2001 From: hegerchr Date: Fri, 21 Mar 2025 09:29:38 +0100 Subject: [PATCH 7/7] updated table of supported technolgies and added intro and outro. --- docs/use-cases/llm/index.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/use-cases/llm/index.md b/docs/use-cases/llm/index.md index 4f1ea3b8..c191acfd 100644 --- a/docs/use-cases/llm/index.md +++ b/docs/use-cases/llm/index.md @@ -6,14 +6,16 @@ parent: Use Cases --- # LLM Observability with EDOT -We currently support LLM observability with our EDOT Java, EDOT Node.js and EDOT Python as tech preview. +Applications make more and more use of Generative Artificial Intelligence (GenAI). Telemetry data in terms of spans, metrics and logs when communicating with the GenAI APIs becomes more and more important to operate the application in production and understand the application's behavior and health state. + +We currently support LLM observability with our EDOT Java, EDOT Node.js and EDOT Python as tech preview. In the following, the supported technologies are listed as well as quickstart instructions to instrument your application to get telemetry data. # Supported Technologies | Technology | EDOT Java | EDOT Node.js | EDOT Python | |:---------|:---------|:---------|:---------| -| OpenAI Client | :red_circle: | :red_circle: | :red_circle: | -| AWS Bedrock | :red_circle: | :red_circle: | :red_circle: | +| OpenAI Client | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| AWS Bedrock | :x: | :x: | :white_check_mark: | See the [Supported Technologies section in the corresponding EDOT SDK](../../_edot-sdks/index) for detailed information on supported versions. @@ -27,4 +29,6 @@ Choose the environment and target system from the [quick start overview](../../q 2. **Configuration** -See the [Configuration section in the corresponding EDOT SDK](../../_edot-sdks/index) to enable and disable specific instrumentations and to see what instrumentation is enabled by default. \ No newline at end of file +See the [Configuration section in the corresponding EDOT SDK](../../_edot-sdks/index) to enable and disable specific instrumentations and to see what instrumentation is enabled by default. + +When you finish the setup and the configuration of the EDOT SDK and there is a workload on your application, you should start to see telemetry data in Kibana. If there is no telemetry data showing up, please see the troubleshooting of the EDOT SDK, \ No newline at end of file