Installing Prometheus Exporter

Explore this Page

• Overview
• Installing with the Setup Wizard
• Installing Silently from the Command Line
• Verifying the Installation

Overview

This page explains how to install the exporter using the setup wizard or silently from the command line, and how to verify that installation succeeded.

Before you begin, confirm your environment meets the requirements in Prerequisites. The exporter is installed using a Windows Installer package, DataCoreSANsymphonyPrometheusExporter-1.0.0.msi.

Installing with the Setup Wizard

Procedure:

1. Download the installer from datacore.com/downloads and run it. Accept the User Account Control prompt if shown.
2. Accept the license agreement. You may optionally change the install folder.
3. On the SANsymphony connection page, enter the following details.

   Field	Example	Description
   SANsymphony REST server	https://10.12.110.11	The hostname, IP address, or URL of the management server. https:// is assumed if not entered. If a hostname is not accepted, enter the management IP address instead.
   Username	administrator	A Windows account on the SANsymphony management server. This is not the login for the computer the exporter is being installed on.
   Password	••••••••	The password for the account above. It is masked as you type and stored encrypted.
   Metrics listen address	9876	The port the exporter listens on. A port number by itself is accepted (normalized to :9876), or you can enter a full host:port.

4. Select Next. The wizard verifies the connection using the details you entered. If the connection fails, a message explains why, and you can correct the details and try again. Nothing is installed until the connection succeeds.
5. Complete the wizard. The installer saves the encrypted configuration, registers the DcsPrometheusExporter service, and starts it.

The installer automatically creates an inbound Windows Firewall rule for the metrics port you entered, so Prometheus can reach /metrics right away with no manual firewall configuration. The rule is removed automatically when you uninstall the exporter. If the Windows Firewall service is disabled on the target host, installation fails; enable the service and run the installer again.

Installing Silently from the Command Line

For unattended deployments, open an elevated Command Prompt and run the following command, providing the properties shown below.

msiexec /i DataCoreSANsymphonyPrometheusExporter-1.0.0.msi /qn ^
  SSV_URL=https://10.12.110.11 ^
  SSV_USER=administrator ^
  SSV_PASS=YourPassword ^
  SSV_LISTEN=9876

All four properties are required on a first time install: SSV_URL, SSV_USER, SSV_PASS, and SSV_LISTEN. A log of the installation is written to %TEMP%\MSI*.LOG. Unlike the wizard, a silent install does not verify the connection in advance, so confirm the installation afterward using the steps in Verifying the Installation.

Verifying the Installation

Procedure:

1. Confirm the service is running. Run the following command.
   Copy

   Command

   sc query DcsPrometheusExporter

2. Confirm the metrics endpoint responds. Run the following command.
   Copy

   Command

   curl http://localhost:9876/metrics | findstr ssv_up

ssv_up{collector="…"} 1 for each collector confirms the exporter reached SANsymphony successfully.

After installation, see Configuring Prometheus Exporter to review or change any settings.

Learn More

Configuring Prometheus Exporter

Logging and Upgrade

Troubleshooting