Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/Admin-and-data/api-keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/Monitor-your-data/Kubernetes-monitoring/Shipping.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/Monitor-your-data/MCP/MCP.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

---

Expand All @@ -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)

---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/Monitor-your-data/OpenTelemetry/Instrumentation/Go.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
4 changes: 1 addition & 3 deletions docs/Monitor-your-data/OpenTelemetry/Shipping/Collector.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.



Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
7 changes: 2 additions & 5 deletions docs/Monitor-your-data/OpenTelemetry/Troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/Monitor-your-data/OpenTelemetry/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
Loading