Skip to main content

Install Releem for MySQL on Linux

Run the applicable installation command as root. Replace bracketed placeholders with the values for this server.

Use this guide for a self-managed MySQL server on Linux.

Supported versions are MySQL 5.5–8.0. Install the Agent on the database host when possible. For a remote database, restrict the database listener and firewall to the exact Agent source address.

CloudLinux

After installation, complete the CloudLinux-specific CageFS and MySQLGovernor steps.

Prerequisites​

Use these task links for the complete flow: requirements, permissions, automatic installation, manual installation, parameters, expected result, verification, troubleshooting, update, and uninstall.

Automatic installation​

Use this path when the installer may create the releem monitoring user. The installer asks for the MySQL administrative password if it needs one.

RELEEM_MYSQL_TYPE=1 RELEEM_DB_MEMORY_LIMIT=[MYSQL_MEMORY_LIMIT_MB] RELEEM_API_KEY='[RELEEM_API_KEY]' RELEEM_CRON_ENABLE=1 RELEEM_QUERY_OPTIMIZATION=true bash -c "$(curl -L https://releem.s3.amazonaws.com/v2/install.sh)"

Do not add an administrative password to the command. Continue with the expected result.

Manual installation​

Use this path when a DBA has already created the monitoring user according to the MySQL permissions guide:

RELEEM_MYSQL_TYPE=1 RELEEM_MYSQL_PASSWORD='[MONITORING_PASSWORD]' RELEEM_MYSQL_LOGIN='releem' RELEEM_DB_MEMORY_LIMIT=[MYSQL_MEMORY_LIMIT_MB] RELEEM_API_KEY='[RELEEM_API_KEY]' RELEEM_CRON_ENABLE=1 RELEEM_QUERY_OPTIMIZATION=true bash -c "$(curl -L https://releem.s3.amazonaws.com/v2/install.sh)"

Add RELEEM_MYSQL_HOST or RELEEM_MYSQL_PORT before bash -c only when the database does not use the local default connection.

The installer writes the Agent configuration to /opt/releem/releem.conf. Keep this file readable only by authorized administrators.

Installer parameters​

  • RELEEM_API_KEY identifies the server in Releem.
  • RELEEM_HOSTNAME overrides the name displayed in the Dashboard.
  • RELEEM_DB_MEMORY_LIMIT reserves memory for other software; 0 lets Releem consider all memory. See Limit MySQL Memory.
  • RELEEM_CRON_ENABLE=1 enables the automatic daily update. Set it to 0 to disable scheduled updates. See Update the Agent.
  • RELEEM_MYSQL_TYPE=1 explicitly selects the MySQL-family path. MySQL is already the default.
  • RELEEM_MYSQL_HOST defaults to 127.0.0.1, RELEEM_MYSQL_PORT defaults to 3306, and RELEEM_MYSQL_LOGIN and RELEEM_MYSQL_PASSWORD configure the MySQL-family monitoring connection.
  • RELEEM_MYSQL_ROOT_LOGIN sets the MySQL-family administrative login and defaults to root. Do not put a root-password variable in a reusable example; use the installer's masked prompt.
  • RELEEM_QUERY_OPTIMIZATION=true enables query collection after you grant the required query permissions. Remove this flag for baseline monitoring only.

For the installed Agent's settings, see Configure the Releem Agent.

Expected result​

The installer completes without an error, the Agent service starts, and the new server appears in the Releem Dashboard.

Verify the installation​

Open the Dashboard and confirm both that Agent Status: Connected is shown and that the Dashboard has a current data timestamp or updated metrics. If the service is connected but current data is absent, review the Agent logs and continue to troubleshooting.

Troubleshooting​

If the server does not connect, use Troubleshoot the Releem Agent. Recheck this installation guide, database permissions, network source restrictions, and installed configuration. For lifecycle tasks, use the dedicated update and uninstall guides.