From ace551811dd64bd965d6510b0e75dda112dcb9ad Mon Sep 17 00:00:00 2001 From: CChislett Date: Mon, 12 Oct 2026 15:59:20 +0100 Subject: [PATCH] Link API-key references to the canonical app page Per John, every "generate an API key" reference should link straight to the canonical app page rather than describe a nav path. Replace the inline paths and step lists with a direct link to https://app.opspilot.com/organization/api-keys across the OpenTelemetry instrumentation and shipping guides, the Collector step, the MCP and Kubernetes guides, the landing page, and the API Keys page itself. Co-Authored-By: Claude Opus 4.8 --- docs/Admin-and-data/api-keys.md | 2 +- docs/Monitor-your-data/Kubernetes-monitoring/Shipping.md | 2 +- docs/Monitor-your-data/MCP/MCP.md | 4 ++-- .../Monitor-your-data/OpenTelemetry/Instrumentation/Cpp.md | 2 +- .../OpenTelemetry/Instrumentation/DotNet.md | 2 +- .../OpenTelemetry/Instrumentation/Erlang.md | 2 +- docs/Monitor-your-data/OpenTelemetry/Instrumentation/Go.md | 2 +- .../OpenTelemetry/Instrumentation/Java.md | 2 +- .../OpenTelemetry/Instrumentation/Kotlin.md | 2 +- .../Monitor-your-data/OpenTelemetry/Instrumentation/PHP.md | 2 +- .../OpenTelemetry/Instrumentation/Python.md | 2 +- .../OpenTelemetry/Instrumentation/Ruby.md | 2 +- .../OpenTelemetry/Instrumentation/Rust.md | 2 +- .../OpenTelemetry/Instrumentation/Swift.md | 2 +- .../OpenTelemetry/Instrumentation/node.md | 2 +- docs/Monitor-your-data/OpenTelemetry/Shipping/Collector.md | 4 +--- .../OpenTelemetry/Shipping/Grafana-agent.md | 2 +- docs/Monitor-your-data/OpenTelemetry/Troubleshooting.md | 7 ++----- docs/Monitor-your-data/OpenTelemetry/getting-started.md | 2 +- docs/index.md | 2 +- 20 files changed, 22 insertions(+), 27 deletions(-) diff --git a/docs/Admin-and-data/api-keys.md b/docs/Admin-and-data/api-keys.md index a1e49ea..abc7e79 100644 --- a/docs/Admin-and-data/api-keys.md +++ b/docs/Admin-and-data/api-keys.md @@ -2,7 +2,7 @@ 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. +Open the [API Keys page](https://app.opspilot.com/organization/api-keys) in OpsPilot, under **Data and Licenses** in the left-hand sidebar. ## Viewing & managing keys diff --git a/docs/Monitor-your-data/Kubernetes-monitoring/Shipping.md b/docs/Monitor-your-data/Kubernetes-monitoring/Shipping.md index 01444fc..6ac5ddc 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** \> **Data and Licenses** \> **API Keys** + [Manage your API keys](https://app.opspilot.com/organization/api-keys) in OpsPilot. ## Procedure diff --git a/docs/Monitor-your-data/MCP/MCP.md b/docs/Monitor-your-data/MCP/MCP.md index 156ae7e..903319d 100644 --- a/docs/Monitor-your-data/MCP/MCP.md +++ b/docs/Monitor-your-data/MCP/MCP.md @@ -11,7 +11,7 @@ To connect your AI tooling to OpsPilot using MCP, follow the steps below. You’ll need an API key so your tooling can authenticate with the OpsPilot MCP. !!! info - [Generate an OpsPilot API key](/Admin-and-data/api-keys/#creating-a-new-key) + [Generate an OpsPilot API key](https://app.opspilot.com/organization/api-keys) --- @@ -34,7 +34,7 @@ The simplest way to get started is by using the prebuilt Grafana MCP Docker imag 3. **Claude Desktop, Claude Code, or another MCP host** must be installed. - This example uses Claude Desktop. 4. **An OpsPilot API Key** is required. - - [Generate an OpsPilot API key](/Admin-and-data/api-keys/#creating-a-new-key) + - [Generate an OpsPilot API key](https://app.opspilot.com/organization/api-keys) --- diff --git a/docs/Monitor-your-data/OpenTelemetry/Instrumentation/Cpp.md b/docs/Monitor-your-data/OpenTelemetry/Instrumentation/Cpp.md index 04486e6..fb751b2 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 **Data and Licenses > API Keys** in OpsPilot. +* **OpsPilot API Key**: [Generate one](https://app.opspilot.com/organization/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 f63682c..089fde5 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 **Data and Licenses > API Keys** in OpsPilot. +* **OpsPilot API Key**: [Generate one](https://app.opspilot.com/organization/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 19006f2..017bd18 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 **Data and Licenses > API Keys** in OpsPilot. +* **OpsPilot API Key**: [Generate one](https://app.opspilot.com/organization/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 81f2eaf..8a72860 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 **Data and Licenses > API Keys** in OpsPilot. +* **OpsPilot API Key**: [Generate one](https://app.opspilot.com/organization/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 0c504fe..a0ef88a 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 **Data and Licenses > API Keys** in OpsPilot. +* **OpsPilot API Key**: [Generate one](https://app.opspilot.com/organization/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 8cc9fdf..9dce75d 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 **Data and Licenses > API Keys** in OpsPilot. +* **OpsPilot API Key**: [Generate one](https://app.opspilot.com/organization/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 7ec918b..9c11dc8 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 **Data and Licenses > API Keys** in OpsPilot. +* **OpsPilot API Key**: [Generate one](https://app.opspilot.com/organization/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 fd54f77..292c2ae 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 **Data and Licenses > API Keys** in OpsPilot. +* **OpsPilot API Key**: [Generate one](https://app.opspilot.com/organization/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 48c0407..2772bda 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 **Data and Licenses > API Keys** in OpsPilot. +* **OpsPilot API Key**: [Generate one](https://app.opspilot.com/organization/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 33478c9..2082650 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 **Data and Licenses > API Keys** in OpsPilot. +* **OpsPilot API Key**: [Generate one](https://app.opspilot.com/organization/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 2895b2c..d8dbd7c 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 **Data and Licenses > API Keys** in OpsPilot. +* **OpsPilot API Key**: [Generate one](https://app.opspilot.com/organization/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 278ef18..ea89ec1 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 **Data and Licenses > API Keys** in OpsPilot. +* **OpsPilot API Key**: [Generate one](https://app.opspilot.com/organization/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 ed8f0e0..f6f8c0b 100644 --- a/docs/Monitor-your-data/OpenTelemetry/Shipping/Collector.md +++ b/docs/Monitor-your-data/OpenTelemetry/Shipping/Collector.md @@ -71,9 +71,7 @@ service: ### **Step 2:** Obtain your API Key -1. Log in to **OpsPilot**. -2. Navigate to **Data and Licenses > API Keys**. -3. Generate a new key and save it securely. +[Generate an API key](https://app.opspilot.com/organization/api-keys) in OpsPilot 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 0c406ef..81782a0 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 **Data and Licenses > API Keys**. +* **OpsPilot API Key**: [Generate one](https://app.opspilot.com/organization/api-keys) in OpsPilot. * **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 e47e6fb..72f5289 100644 --- a/docs/Monitor-your-data/OpenTelemetry/Troubleshooting.md +++ b/docs/Monitor-your-data/OpenTelemetry/Troubleshooting.md @@ -113,10 +113,7 @@ otelcol.exporter.otlphttp "fusionreactor" { } ``` -To get your API key: -1. Log in to **OpsPilot** -2. Navigate to **Data and Licenses > API Keys** -3. Generate a new key or copy an existing one +To get your API key, [generate or copy one](https://app.opspilot.com/organization/api-keys) in OpsPilot. #### Network Connectivity @@ -729,7 +726,7 @@ failed to export: 401 Unauthorized **Cause**: Invalid or missing API key. **Solution**: -1. Verify API key in OpsPilot: **Data and Licenses > API Keys** +1. Verify your API key on the [API Keys page](https://app.opspilot.com/organization/api-keys) in OpsPilot 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 4932c66..9c6cc14 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 **Data and Licenses > API Keys** in OpsPilot +* **OpsPilot API Key**: [Generate one](https://app.opspilot.com/organization/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. diff --git a/docs/index.md b/docs/index.md index 387b3b7..6d4d79f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -35,7 +35,7 @@ When setup finishes, you land on the **Overview** - your observability dashboard Send telemetry from your applications using OpenTelemetry or the [FusionReactor agent](/Data-insights/Features/Integrations/SDKs/fusionreactor/). !!! info "You'll need an API key" - OpenTelemetry data is authenticated with an OpsPilot **API key**. Create one from the [API Keys](/Admin-and-data/api-keys/) page - or click **Create** on the **Services** card on your Overview - then add it to your exporter configuration. + OpenTelemetry data is authenticated with an OpsPilot **API key**. Create one from the [API Keys](https://app.opspilot.com/organization/api-keys) page - or click **Create** on the **Services** card on your Overview - then add it to your exporter configuration. Select your language: