The Metrics Aggregator collects, groups, and securely exports Prometheus metrics for an enterprise environment. This section describes how to configure a Metrics Aggregator on an AppGate system.
Before adding a Metrics Aggregator
Before configuring a Metrics Aggregator, ensure the appliance-to-appliance communication is set up correctly:
AppGate uses single packet authorization (SPA) for appliance-to-appliance communication. Firewalls configured to allow all TLS traffic can interfere with SPA. It is therefore recommended to allow TCP port 443 between appliances.
The Metrics Aggregator accepts incoming traffic from peer appliances. Other members of the Collective establish connections to send audit logs and metrics (see Audit logs for details).
A static IP address or resolvable hostname must be configured in System Settings.
Configuring a Metrics Aggregator
To configure a Metrics Aggregator:
In the Add/Edit Appliance page, select the Metrics Aggregator checkbox in the Functions tab.
Complete the following configuration fields:
Site Settings
Appliance Site. Select the Site from the dropdown list.
System TLS Connection (using SPA)
These settings are used for peer‑to‑peer traffic:
TLS Port. The inbound TLS connection port to the appliance.
Allowed Sources. Select +Add to add one or more allowed sources by adding the Address, Netmask Length, and the Network Interface. The requesting IP address must match at least one allowed source.
SPA Mode. Allows the SPA mode to be changed for a specific appliance. Select one of the following:
No override
Check TCP SPA key before allowing connections
Check UDP (and TCP) SPA key before allowing connections
Enable proxy protocol. When enabled, the appliance accepts only packets that include a proxy protocol header. AppGate ZTNA supports proxy protocol versions 1 and 2.
NOTE
When traffic originates from a known source, add that source to Allowed Sources. Failure to do so introduces a security risk.
Prometheus Exporter Settings
Configure the following fields:
Metrics Aggregation Source.Select the Sites whose appliances will export metrics to this Metrics Aggregator.
By default, all Sites will be exported.
All the appliances in the selected Site(s) will have their metrics collected by the Metrics Aggregator.
If an appliance's metrics have never been collected, its health status switches to Warning. Once metrics collection is established, the appliance health can also switch to Warning if no metrics are collected for two minutes.
To configure the warning interval:
SSH in to the Metrics Aggregator appliance.
Run the following command:
cz-config set metricsAggregator/pollingIntervalWarning XWhere
Xis the interval in seconds. The default value is 120 seconds.
Select from the following aggregation options:
Aggregate metrics from all appliances.
Aggregate metrics from appliances in specific Sites. Selecting this option displays the Sites field. Select +Add, then choose a Site from the Site to Aggregate dropdown. Optionally, you can select Aggregate metrics from appliances without an assigned Site.
Metric Data. Select from the following options:
Return all labels. Returns all labels without exclusions.
Exclude these labels. Opens the Excluded Labels list. Select the labels exclude. Exclude
metric_idsif they are not required, it as they can significantly increase data size.
Port. The default Prometheus exporter port is 5556.
Allow Access. To allow inbound traffic to the metrics endpoint, the requesting IP address must match at least one of these source addresses. Select +Add to specify the Address, Netmask Length, and the Network Interface. Access behavior:
If the list is empty, no connections are allowed.
If address, netmask and interface are specified, both subnet and interface must match.
If only address and netmask are specified, only the subnet must match.
If only an interface is specified, only the interface must match.
Enable HTTPS. Enabled by default. Allows HTTPS for aggregated metrics export. Metrics scraping requires a PKCS#12 file containing a certificate signed by a trusted CA (for the appliance hostname) and the corresponding private key. These are required to terminate the inbound HTTPS connection.
HTTPS Certificate - PKCS#12. Select +Add to upload the PKCS #12 file. See Adding third-party certificates for more details.
Enable Basic Authentication. Enables Basic Authentication for metrics access. Use with HTTPS to avoid exposing credentials.
Allowed Users. Select +Add and enter a username and password for each allowed user. These credentials must match those configured on the Prometheus server.
After completing the Metrics Aggregator configuration, continue on to the Miscellaneous tab.