Integrate Grafana Monitoring

Overview

You can configure a Grafana integration to record file transfer activities and device status changes as Grafana annotations for monitoring.

Once configured, whenever a selected event occurs—such as Transfer Started, Transfer Completed, Device Connected, or Device Disconnected—an annotation is created in Grafana. You can filter annotations in Grafana dashboards using the specified Default Tags.

The overall process consists of two steps:

① Generate a Service Account Token → ② Configure the Integration in the Product

Prerequisites

Before you begin, verify the following requirements.

Generate a Grafana Service Account Token

To record annotations in Grafana, create a Service Account and generate a Service Account Token.

Step 1. Create a Service Account

In Grafana, navigate to:

Administration → Users and access → Service accounts → Add service account

Enter a service account name and assign a role.

An Editor role or higher is required to create annotations.

Step 2. Generate a Service Account Token

Open the created service account and click Add service account token.

Enter a token name (and optionally an expiration date), then click Generate.

The token is displayed only once when it is created, so copy and store it securely.

A Service Account Token grants the same level of access as a password. Do not expose it in public repositories or external documents.

If the token is compromised, delete it and generate a new one.

Step 3. Verify the Grafana Base URL

Confirm the URL of the Grafana instance where annotations will be recorded.

Example:

Verification

✔ An Editor (or higher) Service Account has been created.

✔ A Service Account Token has been generated.

✔ The Grafana Base URL has been confirmed.

Configure the Grafana Integration

Enter the collected information into the product.

Open the Monitoring settings page.

Step 1. Enter the Grafana Base URL

Enter the Grafana instance URL in the Grafana Base URL field.

Step 2. Enter the Service Account Token

Enter the generated token in the Service Account Token (Bearer) field.

Step 3. Enter Default Tags

Enter the default annotation tags in the Default Tags field, separated by commas.

Example:

These tags can be used to filter annotations in Grafana dashboards.

Step 4. Select Events

Select the events to monitor.

Multiple events can be selected. Annotations are created in Grafana only for the selected events.

Step 5. Save the Configuration

After completing the configuration, click Add to save the integration.

Verification

✔ The Grafana Base URL has been entered.

✔ The Service Account Token has been entered.

✔ The Default Tags have been entered.

✔ The monitoring events have been selected.

Verify the Integration

Verify that the integration is operating correctly.

Step 1. Generate a Test Event

Start a transfer or trigger one of the selected events.

Step 2. Verify in Grafana

Verify that an annotation with the specified tags has been created in the Grafana dashboard.

Verification

✔ An annotation has been created in Grafana.

✔ The event has been delivered successfully.

Configuration Complete

After the configuration is saved, the integration becomes active.

From this point forward, whenever one of the selected events occurs, a Grafana annotation is automatically created.

Troubleshooting