[prom] Section

This section provides information on configuration options for Prometheus support.

Feature configuration

Prometheus support can be configured through:

• command line arguments
• [prom] section in startup cfg/conf file (for master CS)
• prom section in application configuration object

There are basically three places where the options can be specified. First of all, this is a command line. The second is for master server in configuration file and the service can in configuration object. So if this options as specified in command line or configuration file, they take effect immediately. A upon start time before even a configuration object is red. If they are specified only in the configuration object, then. They take effect upon startup or immediately as soon as configuration is read from. From the configuration either database or master server.

Command line

• prom-port <port>
• prom-transport <transport_parameters>
• prom-debug <debug_level>
• lport-prom <port>

If <transport_parameters> contain whitespace characters, the string must be enclosed in quotation marks.

The value -lport-prom persistently overrides the Prometheus port specified elsewhere.

If it is specified in the command line, -prom-transport, if required, must also be specified on the command line.

In this case <port> and <transport_parameters> specified in startup file and/or application object are ignored, and their effective values cannot be changed at runtime.

Startup cfg/conf file - for master CS

[prom]
port=<port>
transport=<transport_parameters>
debug=<debug_level>

Application object

[prom]
port=<port>
transport=<transport_parameters>
debug=<debug_level>

If specified in command line and/or startup configuration file, the Prometheus port is opened upon startup immediately.

If specified in application object, Prometheus port is opened once configuration is read.

The set of options in command line takes precedence over that in startup file.

Unless command line specifies -lport-prom. options specified in application object prevail over command line and startup file.

If application object's settings differ from those in command line or startup file, the port is reopened according to application object's settings once they are read.

<port>

Default: 0
Valid values:

• 0 - the feature is disabled
  
• integer 1-65534 - specifies Prometheus port
  

Changes Take Effect: Immediately, if changed the port is closed and reopened.

Specifies Prometheus http/https port.

<transport_parameters>

Default: none -- Prometheus port is open for unsecure http connection.
Valid values:
Refer to "Common Configuration Options" "Transport Parameter Options" section and "Genesys 8.5 Security Deployment Guide” “Secure Connections (TLS)" section.
Changes Take Effect: Immediately, if changed the port is closed and reopened.

Optionally, specify TLS parameters for https secure Prometheus connection. Transport parameters set at Application and/or Host level do not apply to Prometheus port.

<debug _level>

Default: 0
Valid values:

• 0 - debug logging is disabled
  
• 1 - log http message headers
  
• 2 – log complete http messages
  

Changes Take Effect: Immediately

Enables additional debug-level logging for the feature.