Guide

Enable the metrics exporter

Security Connector as a DNS Forwarder contains a metrics exporter that you can enable to collect information on the Security Connector system and its performance. You can use this data to monitor Security Connector within your environment.

This data is in a format that you can use with Prometheus or any standard monitoring tool. The data is available in <SC_ID>.metrics.sc.akaetp.net, where <SC_ID> is the identification number that’s associated with Security Connector. This ID is shown on the Security Connector page (Threat Protection > Clients & Connectors > Security Connectors) in Enterprise Center.

After enabling the Security Connector metrics exporter, you can configure Prometheus to access this endpoint.

📘

This feature is currently in beta.

To enable the metrics exporter:

  1. In the Security Connector main menu, press 8 or use the arrow keys to select Advanced, and press Enter.
  2. Press 4 or use the arrow keys to select Configure Metrics Exporter and press Enter.
  3. Press C to configure the metrics exporter and press Enter.
  4. Press E to enable the exporter and press Enter.
  5. Enter the port number that Prometheus or your monitoring tool uses to get data and press Enter.
  6. Enter the username and password that you want to use for accessing exported data. You provide these credentials in Prometheus or in the monitoring tool you use.
  7. Press C to confirm this update.

Next Steps:

Configure Prometheus or the monitoring tool you’re using to receive data from <SC_ID>.metrics.sc.akaetp.net. Complete these steps in Prometheus:

  1. In the prometheus.yml file, add the following URL endpoint as a new job under scrape_configs: https://<SC_ID>.metrics.sc.akaetp.net.
    Make sure you include any required authentication settings. For more information, see the Prometheus documentation.
  2. Reload Prometheus. Verify that the new target is available in the Prometheus "targets" route path or if you’re using the user interface for Prometheus, go to Status > Target Health. If the configuration was successful, the state is shown as UP.

📘

You may need to create and add ssh keys in order to access https://<SC_ID>.metrics.sc.akaetp.net.

Updated about 2 hours ago