Integrate Prometheus Monitoring

Overview

You can configure a Prometheus integration to send file transfer activities and device status changes for monitoring.

Although Prometheus typically uses a pull-based collection model, this integration pushes data using the Prometheus Remote Write Receiver.

Once configured, whenever a selected event occurs—such as Transfer Started, Transfer Completed, Device Connected, or Device Disconnected—the corresponding data is sent to Prometheus.

The overall process consists of the following steps:

① Prepare the Prometheus Remote Write Receiver → ② Configure the Integration in the Product

Prerequisites

Before you begin, verify the following requirements.

Prepare the Prometheus Remote Write Receiver

Before the product can send data to Prometheus, enable the Remote Write Receiver and verify the endpoint and authentication settings.

Step 1. Enable the Remote Write Receiver

Start Prometheus with the following command-line option:

The Remote Write Receiver accepts requests at:

If this feature is not enabled, data transmission fails with a 404 Not Found error and the following message:

Step 2. Verify the Endpoint and Authentication

Verify the Prometheus endpoint.

Example:

If authentication is required, configure Bearer Token authentication through a reverse proxy (such as nginx) or the Prometheus web configuration, then obtain the corresponding token.

If Prometheus is used in a trusted internal network without authentication, leave the Auth Token field empty.

Treat the Auth Token like a password. Do not expose it in public repositories or external documentation.

Verification

✔ The Remote Write Receiver has been enabled.

✔ The Prometheus endpoint has been verified.

✔ An Auth Token has been prepared if required.

Configure the Prometheus Integration

Enter the endpoint and authentication information into the product.

When you open the Monitoring configuration page, the following screen is displayed.

Step 1. Enter the Prometheus Endpoint

Enter the Prometheus endpoint.

Example:

Step 2. Enter the Auth Token

If authentication is enabled, enter the Auth Token.

If authentication is not used, leave this field blank.

Step 3. Select Events

Select the events to monitor.

Multiple events can be selected. Only the selected events will be sent to Prometheus.

Step 4. Save the Configuration

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

Verification

✔ The Prometheus endpoint has been entered.

✔ The Auth Token has been entered if required.

✔ 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 monitoring events.

Step 2. Verify in Prometheus

Open the Prometheus UI and verify that the metrics have been received successfully.

Verification

✔ Metrics have been received by Prometheus.

✔ The generated 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, the corresponding data is automatically sent to Prometheus.

Troubleshooting