Server section

The Server Section was introduced starting from ImageMaster 9.14.2.1 and includes HTTPS-related configuration options.

listenhost

In case it is required to retrieve monitoring data collected and exposed by this Metric Gateway from another machine it is required to add the Metrics Gateway host machine. To accept incoming connections from all addresses, set listenhost to "0:0:0:0"

This value sets the host name where the service is running. Use “localhost” if it is intended to be used only internally on this machine. You should define the FQDN (fully qualified domain name) if accessibility is required outside of your local machine. Examples:

listenhost="MetricsHost.imagemaster.de"

listenhost="localhost"

listenport

This value defines the port on which the /metrics URL is offered for Prometheus. The default is 12080. In combination with “listenhost” it looks like follows from Prometheus side for the adjusted port according to the example:

MetricsHost.imagemaster.local:32080/metrics

Example:

listenport=32080

protocol

Specifies the protocol Metrics Gateway uses to deliver metrics. By default, this is “http”.

Examples:

protocol="http"  // or "https" if encryption is needed

If set to “https”, a certificate and private key are required for HTTPS communication, configured with the following properties:

httpsKeystorePath="./keystore.p12"               // Path to keystore file

httpsKeystorePassword="M8FMeLr1nXIyQ7Sblt15MA==" // Password to unlock keystore

httpsCertPassword="LwFGc2j91FnQQkvNKODx8A=="     // Password for private key

Basic authentication

Metrics Gateway supports basic authentication to protect exposed metrics data. Only clients with a specified username and password (stored in configuration in encoded format) can access the metrics. It’s recommended to enable basic authentication alongside the HTTPS protocol for security.

user="824TtRbtGUuurl/54pu5QA==" 

password="NpMfsYMGDb7fJ9qDe3QFaQ=="