Configuring Prometheus Exporter

Explore this Page

Overview

This page describes the exporter's configuration file and settings, and explains how to update your connection credentials after installation.

The exporter stores its settings, and what each setting controls, in a configuration file the installer creates at C:\ProgramData\DataCore SANsymphony Prometheus Exporter\config.yaml. The password is stored encrypted, and the file's permissions are limited to SYSTEM and Administrators. The following example shows a typical configuration file.

Copy
Command 
url: https://10.12.110.11
user: administrator
pass: "enc:<base64>"
host: 10.12.110.11
insecure: true
listen: ":9876"
log_level: info
perf_workers: 8
retries: 2
retry_delay: 200ms

Settings

The table below lists every setting stored in config.yaml and what it controls.

Setting Description
url The address of the SANsymphony REST API. https:// is added automatically if not included.
user The Windows account used to sign in to the SANsymphony management server.
pass The account password. Stored encrypted and never shown in plain text.
host The management server address used to identify the target server. Defaults to the host portion of url.
insecure When set to true (the default), a self signed management certificate is accepted. Set to false if your SANsymphony server uses a certificate this computer already trusts.
listen The address and port the exporter listens on for Prometheus. A port number by itself is accepted and normalized to a full address such as :9876.
log_level How much detail is written to the log file. Options are debug, info, warn, and error. The default is info.
perf_workers How many SANsymphony performance requests the exporter makes at the same time during each scrape. The default is 8.
retries How many times the exporter retries a request to SANsymphony after a temporary failure. The default is 2.
retry_delay How long the exporter waits before the first retry after a failed request. The default is 200 milliseconds.

The password is encrypted for this specific computer only. If config.yaml is copied to a different computer, the password cannot be decrypted there, and the exporter will need to be reconfigured on that computer instead. The password is never stored in plain text or shown on screen after it is entered.

Reconfiguring Credentials

The SANsymphony server, username, password, and log level can be changed safely at any time after installation using the steps below.

Procedure:

  1. Open an elevated Command Prompt and run the following command with the -configure option. The path shown is the default install location; if you chose a different folder during installation, run the command from that location instead.
    Copy
    Command 
    "C:\Program Files\DataCore SANsymphony Prometheus Exporter\DcsPrometheusExporter.exe" -configure
  2. Follow the menu to update the SANsymphony server, username, password, or log level, or all of them. Press Enter, or choose 0, to cancel without making changes.
  3. When prompted for a password, type the new value or leave it blank to keep the current password. The password is masked as you type.
  4. Restart is required for changes to take effect. You can restart the service from the Services console, or run the following commands.
    Copy
    Command 
    sc stop DcsPrometheusExporter
    sc start DcsPrometheusExporter

Learn More

Metrics and Dashboards

Logging and Upgrade

Troubleshooting