Getting started for    

Running the agent on Linux (Ubuntu)

The agent itself is a self-contained piece of software which runs alongside your main application code, and you must also set up hooks in your application code to talk to the agent, passing it logs, program state, metadata and exceptions.

This article walks you through the process of getting the agent on a device running Linux (Ubuntu).


To install the agent on a device running Ubuntu 16.04 and onwards, you have two options. The first, recommended option is to use our PPA which installs a .deb file which contains the latest version of the code and all dependencies. The second is to install the agent from source, which works on all Debian-based distributions and can be found by selecting "Linux - Debian" from the dropdown above.

sudo add-apt-repository
sudo apt-get update

If the add-apt-repository command fails, you may need to run sudo apt-get install software-properties-common.

sudo apt-get install overlock-agent

The agent will start running as soon as it is installed. You can check it is running and view the logs with the following commands:

systemctl status overlock-agent
journalctl -u overlock-agent -f


You have to set several configuration options for the agent to operate correctly. The easiest way to do this is through a config file. Add the following contents to a new file saved to /etc/overlock.conf. Each of the values are specific to your project.

# Overlock Configuration
node_id=<your node id>
product_name=<your product name>
project_id=<your project id>
project_key=<your project key>

For advanced configuration, please see agent configuration


We're here to help - please reach out on the forums with any problems!