Installing the agent

Once you have registered with Mackerel and created an organization, you will be able to install the agent and register your hosts. For installation instructions, refer to the help documentation for your OS. For supported environments, refer to Supported Environments.

Installation instructions

For installation instructions, refer to the help documentation for each OS.

Communication during agent installation

When installing the agent using the setup script, communication will occur with the following destinations. In environments where outbound internet access is restricted, please allow communication to these destinations before installing the agent.

  • https://mackerel.io/
  • Repository
    • For Amazon Linux / CentOS / Red Hat Enterprise Linux derivatives:
      • http://yum.mackerel.io/
    • For Ubuntu / Debian:
      • http://apt.mackerel.io/
    • Repositories are hosted on Amazon S3. For the IP address ranges used by Amazon S3, refer to AWS IP address ranges

Communication when the agent is running

After the agent is installed, communication will occur with the following destinations. If communication is unavailable, the agent will fail to start and metrics cannot be posted.

For servers that cannot communicate directly with the internet, the agent supports the use of a proxy server.

Agent configuration file

The agent configuration file is located at the following paths. For details on what can be configured using this file, refer to mackerel-agent specifications.

  • For Amazon Linux / CentOS / Red Hat Enterprise Linux derivatives / Ubuntu / Debian:
    • /etc/mackerel-agent/mackerel-agent.conf
    • KCPS version: /etc/mackerel-agent/mackerel-agent-kcps.conf
  • For Windows Server:
    • 64-bit: C:\Program Files\Mackerel\mackerel-agent\mackerel-agent.conf
    • 32-bit: C:\Program Files (x86)\Mackerel\mackerel-agent\mackerel-agent.conf

Uninstalling the agent

Uninstallation instructions are available in the installation instructions help documentation for each OS.

Files not deleted when uninstalling the agent

The agent configuration file and id file under the following directories will not be deleted even when the agent is uninstalled. If you reinstall the agent while these files remain, you can reuse the host ID and configuration. However, if the host with that ID has already been retired, the ID cannot be reused and the agent will fail to start. In this case, please delete the id file before starting the agent.

  • For Amazon Linux / CentOS / Red Hat Enterprise Linux derivatives / Ubuntu / Debian:
    • /var/lib/mackerel-agent
    • KCPS version: /var/lib/mackerel-agent-kcps
  • For Windows Server:
    • 64-bit: C:\Program Files\Mackerel\mackerel-agent
    • 32-bit: C:\Program Files (x86)\Mackerel\mackerel-agent