From 6f3454efdda9f05af7e338ca941183da7dd44b44 Mon Sep 17 00:00:00 2001 From: CChislett Date: Mon, 12 Oct 2026 10:03:54 +0100 Subject: [PATCH 1/3] Correct the API Keys navigation path The API Keys page moved to Data and Licenses > API Keys. Update every place that still pointed at the old location: the Collector guide's Step 2, Grafana-agent, the OpenTelemetry getting-started, all eleven instrumentation pages, and Troubleshooting (which had a third variant, User Menu > Account > API Keys). Also state the path on the API Keys page itself so it is the single source of truth. Co-Authored-By: Claude Opus 4.8 --- docs/Admin-and-data/api-keys.md | 2 ++ docs/Monitor-your-data/OpenTelemetry/Instrumentation/Cpp.md | 2 +- .../Monitor-your-data/OpenTelemetry/Instrumentation/DotNet.md | 2 +- .../Monitor-your-data/OpenTelemetry/Instrumentation/Erlang.md | 2 +- docs/Monitor-your-data/OpenTelemetry/Instrumentation/Go.md | 2 +- docs/Monitor-your-data/OpenTelemetry/Instrumentation/Java.md | 2 +- .../Monitor-your-data/OpenTelemetry/Instrumentation/Kotlin.md | 2 +- docs/Monitor-your-data/OpenTelemetry/Instrumentation/PHP.md | 2 +- .../Monitor-your-data/OpenTelemetry/Instrumentation/Python.md | 2 +- docs/Monitor-your-data/OpenTelemetry/Instrumentation/Ruby.md | 2 +- docs/Monitor-your-data/OpenTelemetry/Instrumentation/Rust.md | 2 +- docs/Monitor-your-data/OpenTelemetry/Instrumentation/Swift.md | 2 +- docs/Monitor-your-data/OpenTelemetry/Instrumentation/node.md | 2 +- docs/Monitor-your-data/OpenTelemetry/Shipping/Collector.md | 2 +- .../Monitor-your-data/OpenTelemetry/Shipping/Grafana-agent.md | 2 +- docs/Monitor-your-data/OpenTelemetry/Troubleshooting.md | 4 ++-- docs/Monitor-your-data/OpenTelemetry/getting-started.md | 2 +- 17 files changed, 19 insertions(+), 17 deletions(-) diff --git a/docs/Admin-and-data/api-keys.md b/docs/Admin-and-data/api-keys.md index a1ab6805..0860db4d 100644 --- a/docs/Admin-and-data/api-keys.md +++ b/docs/Admin-and-data/api-keys.md @@ -2,6 +2,8 @@ The **API Keys** page lets you manage access credentials used by services and agents to communicate with OpsPilot. +Navigate to **Data and Licenses > API Keys** in the left-hand sidebar. + ![Screenshot](../images/get-started-services.png) ## Viewing & managing keys diff --git a/docs/Monitor-your-data/OpenTelemetry/Instrumentation/Cpp.md b/docs/Monitor-your-data/OpenTelemetry/Instrumentation/Cpp.md index 75dacfb7..04486e61 100644 --- a/docs/Monitor-your-data/OpenTelemetry/Instrumentation/Cpp.md +++ b/docs/Monitor-your-data/OpenTelemetry/Instrumentation/Cpp.md @@ -4,7 +4,7 @@ This guide demonstrates how to instrument a C++ application with OpenTelemetry t ## Prerequisites -* **OpsPilot API Key**: Obtain this from **Account Settings > API Keys** in OpsPilot. +* **OpsPilot API Key**: Obtain this from **Data and Licenses > API Keys** in OpsPilot. * **C++ Compiler**: C++17 or later (GCC 9+, Clang 10+, or MSVC 2019+) * **CMake**: Version 3.20 or later * **Telemetry Pipeline**: You must have either an [OpenTelemetry Collector](/Monitor-your-data/OpenTelemetry/Shipping/Collector/) or [Grafana Alloy](/Monitor-your-data/OpenTelemetry/Shipping/Grafana-agent/) configured and running to receive data from your C++ application. diff --git a/docs/Monitor-your-data/OpenTelemetry/Instrumentation/DotNet.md b/docs/Monitor-your-data/OpenTelemetry/Instrumentation/DotNet.md index f8f435c4..f63682c7 100644 --- a/docs/Monitor-your-data/OpenTelemetry/Instrumentation/DotNet.md +++ b/docs/Monitor-your-data/OpenTelemetry/Instrumentation/DotNet.md @@ -4,7 +4,7 @@ This guide demonstrates how to instrument a .NET application with OpenTelemetry ## Prerequisites -* **OpsPilot API Key**: Obtain this from **Account Settings > API Keys** in OpsPilot. +* **OpsPilot API Key**: Obtain this from **Data and Licenses > API Keys** in OpsPilot. * **.NET**: .NET 6.0 or later installed on your system. * **Telemetry Pipeline**: You must have either an [OpenTelemetry Collector](/Monitor-your-data/OpenTelemetry/Shipping/Collector/) or [Grafana Alloy](/Monitor-your-data/OpenTelemetry/Shipping/Grafana-agent/) configured and running to receive data from your .NET application. diff --git a/docs/Monitor-your-data/OpenTelemetry/Instrumentation/Erlang.md b/docs/Monitor-your-data/OpenTelemetry/Instrumentation/Erlang.md index 1ec7ea4b..19006f2e 100644 --- a/docs/Monitor-your-data/OpenTelemetry/Instrumentation/Erlang.md +++ b/docs/Monitor-your-data/OpenTelemetry/Instrumentation/Erlang.md @@ -7,7 +7,7 @@ This guide demonstrates how to instrument an Erlang or Elixir application with O ## Prerequisites -* **OpsPilot API Key**: Obtain this from **Account Settings > API Keys** in OpsPilot. +* **OpsPilot API Key**: Obtain this from **Data and Licenses > API Keys** in OpsPilot. * **Erlang/OTP**: 22+ or **Elixir**: 1.11+ installed on your system. * **Telemetry Pipeline**: You must have either an [OpenTelemetry Collector](/Monitor-your-data/OpenTelemetry/Shipping/Collector/) or [Grafana Alloy](/Monitor-your-data/OpenTelemetry/Shipping/Grafana-agent/) configured and running to receive data from your application. diff --git a/docs/Monitor-your-data/OpenTelemetry/Instrumentation/Go.md b/docs/Monitor-your-data/OpenTelemetry/Instrumentation/Go.md index 7b73f192..81f2eafe 100644 --- a/docs/Monitor-your-data/OpenTelemetry/Instrumentation/Go.md +++ b/docs/Monitor-your-data/OpenTelemetry/Instrumentation/Go.md @@ -7,7 +7,7 @@ This guide demonstrates how to instrument a Go application with OpenTelemetry to ## Prerequisites -* **OpsPilot API Key**: Obtain this from **Account Settings > API Keys** in OpsPilot. +* **OpsPilot API Key**: Obtain this from **Data and Licenses > API Keys** in OpsPilot. * **Go**: Go 1.21 or later installed on your system. * **Telemetry Pipeline**: You must have either an [OpenTelemetry Collector](/Monitor-your-data/OpenTelemetry/Shipping/Collector/) or [Grafana Alloy](/Monitor-your-data/OpenTelemetry/Shipping/Grafana-agent/) configured and running to receive data from your Go application. diff --git a/docs/Monitor-your-data/OpenTelemetry/Instrumentation/Java.md b/docs/Monitor-your-data/OpenTelemetry/Instrumentation/Java.md index a788f9c2..0c504fe9 100644 --- a/docs/Monitor-your-data/OpenTelemetry/Instrumentation/Java.md +++ b/docs/Monitor-your-data/OpenTelemetry/Instrumentation/Java.md @@ -4,7 +4,7 @@ This guide demonstrates how to instrument a Java application with OpenTelemetry ## Prerequisites -* **OpsPilot API Key**: Obtain this from **Account Settings > API Keys** in OpsPilot. +* **OpsPilot API Key**: Obtain this from **Data and Licenses > API Keys** in OpsPilot. * **Java**: Java 8 or later installed on your system. * **Telemetry Pipeline**: You must have either an [OpenTelemetry Collector](/Monitor-your-data/OpenTelemetry/Shipping/Collector/) or [Grafana Alloy](/Monitor-your-data/OpenTelemetry/Shipping/Grafana-agent/) configured and running to receive data from your Java application. diff --git a/docs/Monitor-your-data/OpenTelemetry/Instrumentation/Kotlin.md b/docs/Monitor-your-data/OpenTelemetry/Instrumentation/Kotlin.md index c1d15fa8..8cc9fdfe 100644 --- a/docs/Monitor-your-data/OpenTelemetry/Instrumentation/Kotlin.md +++ b/docs/Monitor-your-data/OpenTelemetry/Instrumentation/Kotlin.md @@ -7,7 +7,7 @@ This guide demonstrates how to instrument a Kotlin application with OpenTelemetr ## Prerequisites -* **OpsPilot API Key**: Obtain this from **Account Settings > API Keys** in OpsPilot. +* **OpsPilot API Key**: Obtain this from **Data and Licenses > API Keys** in OpsPilot. * **Kotlin**: Kotlin 1.8+ with JVM target installed on your system. * **Telemetry Pipeline**: You must have either an [OpenTelemetry Collector](/Monitor-your-data/OpenTelemetry/Shipping/Collector/) or [Grafana Alloy](/Monitor-your-data/OpenTelemetry/Shipping/Grafana-agent/) configured and running to receive data from your Kotlin application. diff --git a/docs/Monitor-your-data/OpenTelemetry/Instrumentation/PHP.md b/docs/Monitor-your-data/OpenTelemetry/Instrumentation/PHP.md index 6a40558f..7ec918b6 100644 --- a/docs/Monitor-your-data/OpenTelemetry/Instrumentation/PHP.md +++ b/docs/Monitor-your-data/OpenTelemetry/Instrumentation/PHP.md @@ -4,7 +4,7 @@ This guide demonstrates how to instrument a PHP application with OpenTelemetry t ## Prerequisites -* **OpsPilot API Key**: Obtain this from **Account Settings > API Keys** in OpsPilot. +* **OpsPilot API Key**: Obtain this from **Data and Licenses > API Keys** in OpsPilot. * **PHP**: PHP 8.0 or later with the following extensions: - `ext-json` - `ext-curl` diff --git a/docs/Monitor-your-data/OpenTelemetry/Instrumentation/Python.md b/docs/Monitor-your-data/OpenTelemetry/Instrumentation/Python.md index 0d4c6cff..fd54f775 100644 --- a/docs/Monitor-your-data/OpenTelemetry/Instrumentation/Python.md +++ b/docs/Monitor-your-data/OpenTelemetry/Instrumentation/Python.md @@ -4,7 +4,7 @@ This guide demonstrates how to instrument a Python application with OpenTelemetr ## Prerequisites -* **OpsPilot API Key**: Obtain this from **Account Settings > API Keys** in OpsPilot. +* **OpsPilot API Key**: Obtain this from **Data and Licenses > API Keys** in OpsPilot. * **Python**: Python 3.8 or later installed on your system. * **Telemetry Pipeline**: You must have either an [OpenTelemetry Collector](/Monitor-your-data/OpenTelemetry/Shipping/Collector/) or [Grafana Alloy](/Monitor-your-data/OpenTelemetry/Shipping/Grafana-agent/) configured and running to receive data from your Python application. diff --git a/docs/Monitor-your-data/OpenTelemetry/Instrumentation/Ruby.md b/docs/Monitor-your-data/OpenTelemetry/Instrumentation/Ruby.md index 21085134..48c0407c 100644 --- a/docs/Monitor-your-data/OpenTelemetry/Instrumentation/Ruby.md +++ b/docs/Monitor-your-data/OpenTelemetry/Instrumentation/Ruby.md @@ -4,7 +4,7 @@ This guide demonstrates how to instrument a Ruby application with OpenTelemetry ## Prerequisites -* **OpsPilot API Key**: Obtain this from **Account Settings > API Keys** in OpsPilot. +* **OpsPilot API Key**: Obtain this from **Data and Licenses > API Keys** in OpsPilot. * **Ruby**: Ruby 3.0 or later installed on your system. * **Telemetry Pipeline**: You must have either an [OpenTelemetry Collector](/Monitor-your-data/OpenTelemetry/Shipping/Collector/) or [Grafana Alloy](/Monitor-your-data/OpenTelemetry/Shipping/Grafana-agent/) configured and running to receive data from your Ruby application. diff --git a/docs/Monitor-your-data/OpenTelemetry/Instrumentation/Rust.md b/docs/Monitor-your-data/OpenTelemetry/Instrumentation/Rust.md index 7c825bda..33478c9a 100644 --- a/docs/Monitor-your-data/OpenTelemetry/Instrumentation/Rust.md +++ b/docs/Monitor-your-data/OpenTelemetry/Instrumentation/Rust.md @@ -7,7 +7,7 @@ This guide demonstrates how to instrument a Rust application with OpenTelemetry ## Prerequisites -* **OpsPilot API Key**: Obtain this from **Account Settings > API Keys** in OpsPilot. +* **OpsPilot API Key**: Obtain this from **Data and Licenses > API Keys** in OpsPilot. * **Rust**: Rust 1.65 or later installed on your system. * **Telemetry Pipeline**: You must have either an [OpenTelemetry Collector](/Monitor-your-data/OpenTelemetry/Shipping/Collector/) or [Grafana Alloy](/Monitor-your-data/OpenTelemetry/Shipping/Grafana-agent/) configured and running to receive data from your Rust application. diff --git a/docs/Monitor-your-data/OpenTelemetry/Instrumentation/Swift.md b/docs/Monitor-your-data/OpenTelemetry/Instrumentation/Swift.md index 16a3d3c9..2895b2ce 100644 --- a/docs/Monitor-your-data/OpenTelemetry/Instrumentation/Swift.md +++ b/docs/Monitor-your-data/OpenTelemetry/Instrumentation/Swift.md @@ -7,7 +7,7 @@ This guide demonstrates how to instrument a Swift application with OpenTelemetry ## Prerequisites -* **OpsPilot API Key**: Obtain this from **Account Settings > API Keys** in OpsPilot. +* **OpsPilot API Key**: Obtain this from **Data and Licenses > API Keys** in OpsPilot. * **Swift**: Swift 5.7 or later installed on your system. * **Telemetry Pipeline**: You must have either an [OpenTelemetry Collector](/Monitor-your-data/OpenTelemetry/Shipping/Collector/) or [Grafana Alloy](/Monitor-your-data/OpenTelemetry/Shipping/Grafana-agent/) configured and running to receive data from your Swift application. diff --git a/docs/Monitor-your-data/OpenTelemetry/Instrumentation/node.md b/docs/Monitor-your-data/OpenTelemetry/Instrumentation/node.md index b357c396..278ef183 100644 --- a/docs/Monitor-your-data/OpenTelemetry/Instrumentation/node.md +++ b/docs/Monitor-your-data/OpenTelemetry/Instrumentation/node.md @@ -7,7 +7,7 @@ This guide demonstrates how to instrument a Node.js application with OpenTelemet ## Prerequisites -* **OpsPilot API Key**: Obtain this from **Account Settings > API Keys** in OpsPilot. +* **OpsPilot API Key**: Obtain this from **Data and Licenses > API Keys** in OpsPilot. * **Docker Desktop**: [Install Docker Desktop](https://www.docker.com/products/docker-desktop/) to build and run the application container. * **Telemetry Pipeline**: You must have either an [OpenTelemetry Collector](/Monitor-your-data/OpenTelemetry/Shipping/Collector/) or [Grafana Alloy](/Monitor-your-data/OpenTelemetry/Shipping/Grafana-agent/) configured and running to receive data from your Node.js application. diff --git a/docs/Monitor-your-data/OpenTelemetry/Shipping/Collector.md b/docs/Monitor-your-data/OpenTelemetry/Shipping/Collector.md index 098cda6e..ed8f0e05 100644 --- a/docs/Monitor-your-data/OpenTelemetry/Shipping/Collector.md +++ b/docs/Monitor-your-data/OpenTelemetry/Shipping/Collector.md @@ -72,7 +72,7 @@ service: ### **Step 2:** Obtain your API Key 1. Log in to **OpsPilot**. -2. Navigate to **Account Settings > API Keys**. +2. Navigate to **Data and Licenses > API Keys**. 3. Generate a new key and save it securely. diff --git a/docs/Monitor-your-data/OpenTelemetry/Shipping/Grafana-agent.md b/docs/Monitor-your-data/OpenTelemetry/Shipping/Grafana-agent.md index ea1bfc93..0c406efe 100644 --- a/docs/Monitor-your-data/OpenTelemetry/Shipping/Grafana-agent.md +++ b/docs/Monitor-your-data/OpenTelemetry/Shipping/Grafana-agent.md @@ -12,7 +12,7 @@ Alloy acts as a programmable intermediary. It receives OTLP data from your instr ### Prerequisites -* **OpsPilot API Key**: Obtain this from **Account Settings > API Keys**. +* **OpsPilot API Key**: Obtain this from **Data and Licenses > API Keys**. * **Docker Desktop**: Ensure Docker is installed and running. * **Port Availability**: Ensure ports **4317**, **4318**, and **12345** are not in use by other services (like a standard OTel Collector). diff --git a/docs/Monitor-your-data/OpenTelemetry/Troubleshooting.md b/docs/Monitor-your-data/OpenTelemetry/Troubleshooting.md index b5b77efb..e47e6fb6 100644 --- a/docs/Monitor-your-data/OpenTelemetry/Troubleshooting.md +++ b/docs/Monitor-your-data/OpenTelemetry/Troubleshooting.md @@ -115,7 +115,7 @@ otelcol.exporter.otlphttp "fusionreactor" { To get your API key: 1. Log in to **OpsPilot** -2. Navigate to **User Menu > Account > API Keys** +2. Navigate to **Data and Licenses > API Keys** 3. Generate a new key or copy an existing one #### Network Connectivity @@ -729,7 +729,7 @@ failed to export: 401 Unauthorized **Cause**: Invalid or missing API key. **Solution**: -1. Verify API key in OpsPilot: **User Menu > Account > API Keys** +1. Verify API key in OpsPilot: **Data and Licenses > API Keys** 2. Check API key is correctly set in your pipeline configuration 3. Ensure no extra spaces or characters in the API key diff --git a/docs/Monitor-your-data/OpenTelemetry/getting-started.md b/docs/Monitor-your-data/OpenTelemetry/getting-started.md index 44159844..4932c662 100644 --- a/docs/Monitor-your-data/OpenTelemetry/getting-started.md +++ b/docs/Monitor-your-data/OpenTelemetry/getting-started.md @@ -78,7 +78,7 @@ This quickstart provides the fastest path to see OpenTelemetry data flowing into ### Prerequisites -* **OpsPilot API Key**: Get this from **Account Settings > API Keys** in OpsPilot +* **OpsPilot API Key**: Get this from **Data and Licenses > API Keys** in OpsPilot * **Docker & Docker Compose**: For running the Collector ([Install Docker](https://docs.docker.com/get-docker/)) * **Your language runtime**: Python, Java, Node.js, Go, .NET, etc. From d123093edda1a4c7ead9ad21573b2e6c3c83ab2b Mon Sep 17 00:00:00 2001 From: CChislett Date: Mon, 12 Oct 2026 10:05:04 +0100 Subject: [PATCH 2/3] Remove the mismatched header image from the API Keys page The top screenshot was get-started-services.png - a services getting- started image, not the API Keys page - so drop it. Co-Authored-By: Claude Opus 4.8 --- docs/Admin-and-data/api-keys.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/Admin-and-data/api-keys.md b/docs/Admin-and-data/api-keys.md index 0860db4d..a1e49eaa 100644 --- a/docs/Admin-and-data/api-keys.md +++ b/docs/Admin-and-data/api-keys.md @@ -4,8 +4,6 @@ The **API Keys** page lets you manage access credentials used by services and ag Navigate to **Data and Licenses > API Keys** in the left-hand sidebar. -![Screenshot](../images/get-started-services.png) - ## Viewing & managing keys Each listed API key displays: From fe9902f662fbc9299dde883cac5e71603e11260b Mon Sep 17 00:00:00 2001 From: CChislett Date: Mon, 12 Oct 2026 10:19:05 +0100 Subject: [PATCH 3/3] Fix the API Keys path in the Kubernetes shipping guide This one sat outside the OpenTelemetry tree and still had the old User Menu > Account > API Keys path. Correct it to Data and Licenses. Co-Authored-By: Claude Opus 4.8 --- docs/Monitor-your-data/Kubernetes-monitoring/Shipping.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Monitor-your-data/Kubernetes-monitoring/Shipping.md b/docs/Monitor-your-data/Kubernetes-monitoring/Shipping.md index adeaa9cc..01444fc2 100644 --- a/docs/Monitor-your-data/Kubernetes-monitoring/Shipping.md +++ b/docs/Monitor-your-data/Kubernetes-monitoring/Shipping.md @@ -33,7 +33,7 @@ Prior to beginning, ensure you have the following: - A valid OpsPilot user in your account, with access to OpsPilot. !!! tip - API keys can be managed under **OpsPilot** \> **User Menu** \> **Account** \> **API Keys** + API keys can be managed under **OpsPilot** \> **Data and Licenses** \> **API Keys** ## Procedure