From 9ab118b044e9bf86fe155633ea325954b65eeacf Mon Sep 17 00:00:00 2001 From: Rohith Panditi Date: Mon, 1 Jun 2026 17:35:45 +0530 Subject: [PATCH 1/2] added the wme-ai-observability-setup --- .../wme-ai-observability-setup.md | 165 ++++++++++++++++++ sidebar/sidebars/studioSidebar.js | 4 + 2 files changed, 169 insertions(+) create mode 100644 docs/studio/offerings/wme/installation/common-steps/wme-ai-observability-setup.md diff --git a/docs/studio/offerings/wme/installation/common-steps/wme-ai-observability-setup.md b/docs/studio/offerings/wme/installation/common-steps/wme-ai-observability-setup.md new file mode 100644 index 0000000..85a372e --- /dev/null +++ b/docs/studio/offerings/wme/installation/common-steps/wme-ai-observability-setup.md @@ -0,0 +1,165 @@ +--- +title: Setting Up WME AI Observability +last_update: { author: "RohithPanditi" } +id: wme-ai-observability-setup +sidebar_label: WME AI Observability Setup +--- + +WME AI Observability is a monitoring and analytics service that provides visibility into your AI workloads running on the WaveMaker platform. Install and run this service on the **WME AI Observability instance**. + +## Step 1 — Download and Extract Package + +#### Download the Package + +Download the package using the link shared by the WaveMaker team: + +```bash +wget https://s3.us-east-1.amazonaws.com/downloads.wavemaker.com/wme//rhel/ai-observability-.tar.gz +``` + +#### Create Directory + +```bash +mkdir ai-observability +``` + +#### Extract the Package + +```bash +tar -xzf ai-observability-.tar.gz -C ai-observability +``` + +## Step 2 — Package Structure + +The extracted package contains installation scripts, Docker images, and configuration files. + +#### Directory Structure + +``` +ai-observability-1.0.0/ +├── INSTALL.md +├── certs/ +├── docker-compose.yml +├── env.example +├── images.tar.gz +├── init-db.sql +├── install-ai-observability.sh +└── nginx.conf.template +``` + +## Step 3 — Installation Scenarios + +### Case 1 — Installation Without Public Domain + +Use this method when accessing the application using: + +``` +http://:5050 +``` + +:::caution +This method uses unencrypted HTTP access. It is recommended only for internal or non-production environments. Use Case 2 for secure HTTPS access. +::: + +#### Run the Installation Script + +```bash +cd ai-observability- +bash install-ai-observability.sh +``` + +During execution, provide the following inputs: + +| Prompt | Value | +| -------------------------------------------------------------------------------------- | ---------------------------------- | +| `Public domain for Analytics UI [analytics.example.com]:` | Press Enter | +| `Run nginx reverse proxy (HTTPS on 443) for analytics.example.com? [Y/n]` | `n` | +| `WaveMaker platform instance IP (leave blank to skip Consul registration) [127.0.0.1]` | Platform Private IP | +| `Private IP for Langfuse (registered in Consul; usually this host)` | Private IP of WME AI Observability | +| `Langfuse project PUBLIC key (blank = auto-generate)` | Press Enter | +| `Langfuse project SECRET key (blank = auto-generate)` | Press Enter | +| `Analytics API key (blank = auto-generate)` | Press Enter | + +#### Accessing the Application + +After successful installation, access the application at: + +``` +http://:5050 +``` + +#### Login Password + +The login password is the generated `ANALYTICS_API_KEY`. You can find this value in the terminal output after execution of `install-ai-observability.sh`. + +### Case 2 — Installation With Public Domain and SSL + +Use this method when accessing the application through a domain with HTTPS enabled. + +#### SSL Certificate Preparation + +Place the SSL certificate files inside: + +``` +ai-observability-/certs/ +``` + +Required file names: + +| File | Required Name | +| ---------------- | ------------- | +| Certificate File | `bundle.crt` | +| Private Key File | `private.key` | + +Directory example: + +``` +certs/ +├── bundle.crt +└── private.key +``` + +#### Run the Installation Script + +```bash +cd ai-observability- +bash install-ai-observability.sh +``` + +During execution, provide the following inputs: + +| Prompt | Value | +| -------------------------------------------------------------------------------------- | ------------------- | +| `Public domain for Analytics UI [analytics.example.com]:` | `` | +| `Run nginx reverse proxy (HTTPS on 443) for ? [Y/n]` | `Y` | +| `Also expose Langfuse UI via nginx? (otherwise internal only) [y/N]` | `y` | +| `Domain for Langfuse []` | Press Enter | +| `Also expose MinIO API via nginx? (otherwise internal only) [y/N]` | `y` | +| `Domain for MinIO [minio.]` | Press Enter | +| `WaveMaker platform instance IP (leave blank to skip Consul registration) [127.0.0.1]` | Platform Private IP | +| `Langfuse project PUBLIC key (blank = auto-generate)` | Press Enter | +| `Langfuse project SECRET key (blank = auto-generate)` | Press Enter | +| `Analytics API key (blank = auto-generate)` | Press Enter | +| `TLS certs directory [./certs]` | Press Enter | + +:::note +By pressing Enter for `TLS certs directory [./certs]`, the installer automatically uses: + +- `ai-observability-/certs/bundle.crt` +- `ai-observability-/certs/private.key` + +::: + +#### Accessing the Application + +After successful installation, access the application at: + +``` +https:// +``` + +The **Analytics URL** will also be displayed in the terminal output after execution of `install-ai-observability.sh`. + +#### Login Password + +The login password is the generated `ANALYTICS_API_KEY`. You can find this value in the terminal output after installation completes. diff --git a/sidebar/sidebars/studioSidebar.js b/sidebar/sidebars/studioSidebar.js index bb3ee2d..d229f47 100644 --- a/sidebar/sidebars/studioSidebar.js +++ b/sidebar/sidebars/studioSidebar.js @@ -202,6 +202,10 @@ export default [ type: 'doc', id: 'studio/offerings/wme/installation/common-steps/apply-license', }, + { + type: 'doc', + id: 'studio/offerings/wme/installation/common-steps/wme-ai-observability-setup', + }, ], }, ], From 6b67ea5ef2a924df33d57e37673fd307dd00192a Mon Sep 17 00:00:00 2001 From: Rohith Panditi Date: Mon, 1 Jun 2026 20:08:03 +0530 Subject: [PATCH 2/2] --amend --- .../wme-ai-observability-setup.md | 22 +++++++++++-------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/docs/studio/offerings/wme/installation/common-steps/wme-ai-observability-setup.md b/docs/studio/offerings/wme/installation/common-steps/wme-ai-observability-setup.md index 85a372e..303d49b 100644 --- a/docs/studio/offerings/wme/installation/common-steps/wme-ai-observability-setup.md +++ b/docs/studio/offerings/wme/installation/common-steps/wme-ai-observability-setup.md @@ -1,11 +1,11 @@ --- title: Setting Up WME AI Observability -last_update: { author: "RohithPanditi" } +last_update: { author: "rohithp_500308" } id: wme-ai-observability-setup sidebar_label: WME AI Observability Setup --- -WME AI Observability is a monitoring and analytics service that provides visibility into your AI workloads running on the WaveMaker platform. Install and run this service on the **WME AI Observability instance**. +WME AI Observability is a monitoring and analytics service that provides visibility into your AI workloads running on the WaveMaker Enterprise platform. It is built on **Langfuse** for LLM tracing and a custom **Analytics** service. Install and run this service on the **WME AI Observability instance**. ## Step 1 — Download and Extract Package @@ -36,7 +36,7 @@ The extracted package contains installation scripts, Docker images, and configur #### Directory Structure ``` -ai-observability-1.0.0/ +ai-observability-/ ├── INSTALL.md ├── certs/ ├── docker-compose.yml @@ -63,8 +63,10 @@ This method uses unencrypted HTTP access. It is recommended only for internal or #### Run the Installation Script +Navigate into the extracted directory and run the installation script: + ```bash -cd ai-observability- +cd ai-observability/ai-observability- bash install-ai-observability.sh ``` @@ -101,7 +103,7 @@ Use this method when accessing the application through a domain with HTTPS enabl Place the SSL certificate files inside: ``` -ai-observability-/certs/ +ai-observability/ai-observability-/certs/ ``` Required file names: @@ -121,8 +123,10 @@ certs/ #### Run the Installation Script +Navigate into the extracted directory and run the installation script: + ```bash -cd ai-observability- +cd ai-observability/ai-observability- bash install-ai-observability.sh ``` @@ -145,8 +149,8 @@ During execution, provide the following inputs: :::note By pressing Enter for `TLS certs directory [./certs]`, the installer automatically uses: -- `ai-observability-/certs/bundle.crt` -- `ai-observability-/certs/private.key` +- `ai-observability/ai-observability-/certs/bundle.crt` +- `ai-observability/ai-observability-/certs/private.key` ::: @@ -155,7 +159,7 @@ By pressing Enter for `TLS certs directory [./certs]`, the installer automatical After successful installation, access the application at: ``` -https:// +https://wmai-analytics.[mycompany].com ``` The **Analytics URL** will also be displayed in the terminal output after execution of `install-ai-observability.sh`.