anka-prometheus-exporter

README

Anka Prometheus Exporter

Created and maintained by Veertu Inc.

This package retrieves data from your Anka Build Cloud and exports it for Prometheus at http://localhost/metrics.

Usage

1. Download the appropriate binary (anka-prometheus-exporter) from the releases page
2. Execute: ./anka-prometheus-exporter --controller_address http://{controller IP or URL}

---

Usage of anka-prometheus-exporter:
  --controller-address string
        Controller address to monitor (url as arg) (required)
  --ca-cert string
        Path to ca PEM/x509 file (cert file path as arg)
  --client-cert string
        Path to client cert PEM/x509 file (cert file path as arg)
  --client-cert-key string
        Path to client key PEM/x509 file (cert file path as arg)
  --disable-interval-optimizer
        Optimize interval according to /metric api requests receieved (no args)
  --interval int
        Seconds to wait between data requests to controller (int as arg) (default 15)
  --port int
        Port to server /metrics endpoint (int as arg) (default 2112)
  --skip-tls-verification
        Skip TLS verification (no args)
  --tls
        Enable TLS (no args)

LOG_LEVEL can be set using an environment variable

---

Adding a Prometheus target

Once running, add the scrape endpoint to your prometheus.yml:

host.docker.internal is only needed if running on the same host as your prometheus container

scrape_configs:
. . .
  - job_name: 'anka build cloud'
    static_configs:
      - targets: ['host.docker.internal:2112']

Running with Docker Compose

1. Add your controller's address to the docker-compose.yml (Required)
2. Edit docker-compose.yml for other configuration options
3. Run docker-compose up -d (if already built, run docker-compose up --build --force-recreate --remove-orphans -d)

Using TLS

The --tls flag is not required if your controller certificate is valid and no client authentication is configured. For all other TLS configuration options, --tls must be set.

For self signed certificates, you can either use --skip-tls-verification or provide your ca-cert with --ca-cert. If client authentication is set on the controller, use --client-cert and --client-cert-key

---

Exposed Metrics

Metric name	Description
anka_instance_state_count	Count of Instances in a particular State (label: state)
anka_instance_state_per_template_count	Count of Instances in a particular state, per Template (label: state, template_name)
anka_instance_state_per_group_count	Count of Instances in a particular state, per Group (label: state, group_name)
--	--
anka_node_instance_count	Count of Instances running on the Node
anka_node_instance_capacity	Total Instance slots (capacity) on the Node
anka_node_states	Node state (1 = current state) (label: id, name, state)
anka_node_states_count	Count of Nodes in a particular state (label: state)
anka_node_disk_free_space	Amount of free disk space on the Node in Bytes
anka_node_disk_total_space	Amount of total available disk space on the Node in Bytes
anka_node_disk_anka_used_space	Amount of disk space used by Anka on the Node in Bytes
anka_node_cpu_core_count	Number of CPU Cores in Node
anka_node_cpu_util	CPU utilization in node
anka_node_ram_gb	Total RAM available for the Node in GB
anka_node_ram_util	Total RAM utilized for the Node
anka_node_virtual_cpu_count	Total Virtual CPU cores for the Node
anka_node_virtual_ram_gb	Total Virtual RAM for the Node in GB
--	--
anka_node_group_nodes_count	Count of Nodes in a particular Group
anka_node_group_states_count	Count of Groups in a particular State (labels: group, state)
anka_node_group_instance_count	Count of Instances slots in use for the Group (and Nodes)
anka_node_group_disk_free_space	Amount of free disk space for the Group (and Nodes) in Bytes
anka_node_group_disk_total_space	Amount of total available disk space for the Group (and Nodes) in Bytes
anka_node_group_disk_anka_used_space	Amount of disk space used by Anka for the Group (and Nodes) in Bytes
anka_node_group_cpu_core_count	Number of CPU Cores for the Group (and Nodes)
anka_node_group_cpu_util	CPU utilization for the Group (and Nodes)
anka_node_group_ram_gb	Total RAM available for the Group (and Nodes) in GB
anka_node_group_ram_util	Total RAM utilized for the Group (and Nodes)
anka_node_group_virtual_cpu_count	Total Virtual CPU cores for the Group (and Nodes)
anka_node_group_virtual_ram_gb	Total Virtual RAM for the Group (and Nodes) in GB
anka_node_group_instance_capacity	Total Instance slots (capacity) for the Group (and Nodes)
--	--
anka_nodes_count	Count of total Anka Nodes
anka_nodes_instance_count	Count of Instance slots in use across all Nodes
anka_nodes_instance_capacity	Count of total Instance Capacity across all Nodes
anka_nodes_disk_free_space	Amount of free disk space across all Nodes in Bytes
anka_nodes_disk_total_space	Amount of total available disk space across all Nodes in Bytes
anka_nodes_disk_anka_used_space	Amount of disk space used by Anka across all Nodes in Bytes
anka_nodes_cpu_core_count	Count of CPU Cores across all Nodes
anka_nodes_cpu_util	Total CPU utilization across all Nodes
anka_nodes_ram_gb	Total RAM available across all Nodes in GB
anka_nodes_ram_util	Total RAM utilized across all Nodes
anka_nodes_virtual_cpu_count	Total Virtual CPU cores across all Nodes
anka_nodes_virtual_ram_gb	Total Virtual RAM across all Nodes
--	--
anka_registry_disk_total_space	Anka Build Cloud Registry total disk space
anka_registry_disk_free_space	Anka Build Cloud Registry free disk space
anka_registry_disk_used_space	Anka Build Cloud Registry used disk space

---

Development

make build-and-run