Installing the agent
What is an agent
The CoScale agent is the primary tool used to capture resource and application metrics from your servers. It is easy to configure and deploy in just a few minutes. The same agent can be installed on multiple servers. For example, you create one webserver agent that can be later installed on all of your webservers.
Creating the agent
To start with the configuration, go to your dashboard and use the sidebar to navigate to
Datasources > Agent. On this page you can configure the agent(s) you want to install on your servers. There is no limit on the maximum number of agents that you can create.
Click on the
Create new CoScale agent button. You have the option to deploy the agent as a package/executable or as a container:
Option 1: Package/Executable
1.1.Select the operating system on which the agent will be installed.
1.2. Enable some plugins
Enable all plugins you want to activate for this agent. The resource plugin is enabled by default, but you probably also want to enable other plugins. For a web server running Tomcat i.e. you would enable the Tomcat plugin by clicking on it. You can enable as many plugins as you like.
Some plugins require further configuration. Read and follow the instructions carefully. If necessary, apply the proposed changes to the server as shown in the instructions and fill in the required fields.
1.3. Review & download
Give your agent a clear, recognizable name: i.e. ‘Webserver’ and press the
1.4. Download & install
You have now created an agent which you can deploy on as many servers as you’d like. A “Download Agent” button is available with the installation files for your operating system. The instructions for installing the agent on your operating system are also shown on this screen.
After installing the agent it will check the configuration of all the selected plugins and will start to communicate with the CoScale platform. This can take a couple of minutes.
Option 2: Container
2.1. Select your deployment/orchestration system
2.2. Add images
The default configuration of the agent will allow CoScale to gather general metrics about the deployment system. We can also gather detailed metrics about the services running inside your Docker containers. Use the
Add image button to add a set of plugins that run inside of your containers to gather metrics of the running services.
2.3. Configure plugins for images
Provide the image name and tag (* can be used for tag). Select the plugin type and click on
Add new plugin. Follow the configuration steps provided on each screen and click
Save when finished.
2.4. Review & download
Give your agent a clear, recognizable name and press the
2.5. Install instructions
Copy the install instructions on the screen to start the CoScale agent in a Docker container. The CoScale agent will run in the foreground. Typically our users use systemd/upstart to make the agent start on every boot.
Checking the installation
You can get an overview of installed agents on the
Datasources > Agent page, accessible through the sidebar. Any configuration problems we detect will be shown here.
To get more information about the agent, you can always click the service icon, it will provide you with the latest log and status of all the plugins.
Agent successfully installed
The agent is now installed and running on your system. You can now repeat this process for servers that require a different set of plugins or configuration.