Paperspace Metrics

This repo contains an Ansible playbook and associated roles for deploying Prometheus Node Exporter, DCGM Exporter, PS Agent, and (optionally) New Relic Openmetrics Integration on a Paperspace machine.

Requirements

Ansible

Target Machine

Python 2.7 or 3.5+
Ubuntu 20.04+

Operation

Basic

Clone this repository.
Create an inventory file inventory with the IPs of the target machines.
Run the playbook: ansible-playbook -i inventory metrics.yml

Example Usage

The following command will install Docker, Prometheus Node Exporter, DCGM Exporter, and the Paperspace Agent on the target machines specified in the inventory file. It will configure New Relic Openmetrics Integration to scrape their metrics endpoints. Take care as it will also restart Docker service on the target machines after installing the DCGM Exporter.

ansible-playbook -i inventory metrics.yml -u paperspace -e new_relic_license_key=1234567890abcdefg --private-key ~/.ssh/id_rsa -e install_new_relic_integration=True -e restart_docker=True

Ansible Primer

Depending on how you have your Ansible environment configured, you may need to specify the SSH user and/or SSH key to use when connecting to the target machines. This can be done by adding the following to the ansible-playbook command:

-u <username> to specify the SSH user
-k to prompt for the SSH password
-K to prompt for the sudo password
-i <path> to specify the inventory file
-e <key>=<value> to specify extra variables
--private-key <path> to specify the SSH key

Extra Variables

Name	Description	Default
`docker_install`	Whether to install Docker on the target machine. If set to False, the playbook will assume that Docker is already installed and will skip the installation step.	True
`node_exporter_install`	Whether to install Prometheus Node Exporter on the target machine.	True
`ps_agent_install`	Whether to install the Paperspace Agent on the target machine.	True
`dcgm_exporter_install`	Whether to install DCGM Exporter on the target machine.	True
`restart_docker`	Whether to restart the Docker service on the target machine after installing the DCGM Exporter. This may be necessary for the DCGM Exporter to be able to access the GPU metrics.	False
`install_new_relic_integration`	Whether to install the New Relic Openmetrics Integration on the target machine.	False
`new_relic_license_key`	New Relic license key for use by the the New Relic Openmetrics Integration.	NULL
`new_relic_cluster_name`	Cluster name for New Relic Openmetrics Integration.	Paperspace

Paperspace / machine-metrics