rename clickstack folder

Author: lio-p

.gitignore

@@ -1,3 +1,4 @@
 **.idea
 **.venv
 .DS_Store
+node_modules

ClickStack/librechat-llm-observability/Dockerfile.mcp

@@ -6,6 +6,7 @@ RUN python3 -m pip install --no-cache-dir --break-system-packages \
    opentelemetry-exporter-otlp
 
 RUN opentelemetry-bootstrap -a install
+
 RUN python3 -m pip uninstall -y pip_system_certs
 
 RUN mkdir -p /app/logs

ClickStack/librechat-llm-observability/Dockerfile.otel

@@ -16,9 +16,9 @@ EXPOSE 3080
 # Replace CMD with OpenTelemetry-instrumented version
 # Redirect stdout and stderr to a file
 CMD sh -c "NODE_ENV=production \
-  DEFAULT_HDX_NODE_ADVANCED_NETWORK_CAPTURE=true \
+  HDX_NODE_ADVANCED_NETWORK_CAPTURE=true \
   OTEL_EXPORTER_OTLP_ENDPOINT=$OTEL_EXPORTER_OTLP_ENDPOINT \
-  HYPERDX_API_KEY=$HYPERDX_API_KEY \
+  HYPERDX_API_KEY=$CLICKSTACK_API_KEY \
   OTEL_SERVICE_NAME=librechat-api \
   npx opentelemetry-instrument api/server/index.js \
   >> /app/api/logs/console.log 2>&1"

ClickStack/librechat-llm-observability/README.md

@@ -2,39 +2,53 @@
 
 ## Deploy ClickStart
 
-The easiest to get ClickStack up and running is to run it locally using docker. You can follow the [documentation](https://clickhouse.com/docs/use-cases/observability/clickstack/getting-started#deploy-stack-with-docker) here to get started.
+The easiest way to get ClickStack up and running is to run it locally using Docker. For more details, refer to the [documentation](https://clickhouse.com/docs/use-cases/observability/clickstack/getting-started#deploy-stack-with-docker).
 
-Once ClickStack is up and running, get the [Ingestion API Key](https://clickhouse.com/docs/use-cases/observability/clickstack/getting-started/sample-data#copy-ingestion-api-key) from the Team settings menu.
+```
+docker run -p 8080:8080 -p 4317:4317 -p 4318:4318 docker.hyperdx.io/hyperdx/hyperdx-all-in-one
+```
+
+Once ClickStack is running, get the [Ingestion API Key](https://clickhouse.com/docs/use-cases/observability/clickstack/getting-started/sample-data#copy-ingestion-api-key) from the Team settings menu.
 
 ## Configure librechat
 
-Librechat requires an access to LLM to work. This demo has been tested only with Anthropic models, but other LLM provider should provide similar experience. 
+LibreChat requires access to an LLM to function. This demo has been tested only with Anthropic models but other LLM providers should work similarly.
 
-Rename the file env.example to .env and edit to put your LLM Api key. See librechat [documentation](https://www.librechat.ai/docs/configuration/dotenv#anthropic) for more information.
+Rename the file `.env.example` to `.env` and provide your LLM API key. 
 
-On top the `.env` file, copy the Ingestion API Key from ClickStack under the value `HYPERDX_API_KEY`. 
+By example for Anthropic, scroll down to find the key `ANTHROPIC_API_KEY` and provide your API Key.
 
-## Configure ClickHouse MCP Server
+See the LibreChat [documentation](https://www.librechat.ai/docs/configuration/dotenv#anthropic) for more information.
 
-[ClickHouse MCP Server](https://github.com/ClickHouse/mcp-clickhouse) allows LLM to query ClickHouse. 
+In addition to the LLM key, copy the Ingestion API Key from ClickStack and assign it to the variable `CLICKSTACK_API_KEY` in the .env file.
 
-You need to configure ClickHouse MCP Server to connect to your ClickHouse deployment. 
+## Configure ClickHouse MCP Server
 
-Edit the following environment variables in the file `.env`:
+[ClickHouse MCP Server](https://github.com/ClickHouse/mcp-clickhouse) allows LLMs to query ClickHouse.
 
-- `CLICKHOUSE_HOST`: ClickHouse deployment URL
-- `CLICKHOUSE_USER`: Clickhouse username
-- `CLICKHOUSE_PASSWORD`: Clickhouse password
+You need to configure ClickHouse MCP Server to connect to your ClickHouse deployment.
 
-By default, the environement is configured to connect to the public [ClickHouse SQL Playground](https://sql.clickhouse.com/). 
+By default, the MCP server is configured to connect to the public [ClickHouse SQL Playground](https://sql.clickhouse.com/).
+
+To connect to your own ClickHouse deployment, edit the following environment variables in the `.env` file:
+    - `CLICKHOUSE_HOST`: ClickHouse deployment URL
+	- `CLICKHOUSE_USER`: ClickHouse username
+	- `CLICKHOUSE_PASSWORD`: ClickHouse password
 
 ## Start librechat locally. 
 
-Run `docker compose up` to start librechat.
+Run `docker compose up` to start LibreChat.
+
+You can access it at `http://localhost:3080` and sign up to get started.
 
-You can access it at `http://localhost:3080`. 
+On the main page, you need to select the configured LLM and the ClickHouse MCP Server before typing your question. 
 
+![](./img/librechat.png)
 
+Here are examples of prompts to get you started if the MCP server is connected to the default SQL Playground. 
+- What are the datasets available? 
+- How does the USD relate to GBP? 
+- Who is the most frequent contributor to Clickhouse git repo using the available git stat data?
 
 
 

ClickStack/librechat-llm-observability/docker-compose.yaml

@@ -24,7 +24,7 @@ services:
       - RAG_API_URL=http://rag_api:${RAG_PORT:-8000}
       - OTEL_EXPORTER_OTLP_ENDPOINT=http://host.docker.internal:4318
       - OTEL_SERVICE_NAME=librechat-api
-      - HYPERDX_API_KEY=${HYPERDX_API_KEY}
+      - CLICKSTACK_API_KEY=${CLICKSTACK_API_KEY}
       - CONSOLE_JSON=true
       - DEBUG_CONSOLE=true
     volumes:
@@ -120,7 +120,7 @@ services:
     volumes:
       - ./logs/mcp-clickhouse:/app/logs
     environment:
-      - HYPERDX_API_KEY=${HYPERDX_API_KEY}
+      - CLICKSTACK_API_KEY=${CLICKSTACK_API_KEY}
       - OTEL_EXPORTER_OTLP_ENDPOINT=http://host.docker.internal:4317
       - OTEL_EXPORTER_OTLP_TRACES_ENDPOINT=http://host.docker.internal:4317
       - OTEL_SERVICE_NAME=mcp-clickhouse