Log in
Sign up free
Releem
RELEEM HELP CENTER

Documentation

Installation and Usage
Сontents

Automatic Installation

Use this instruction to install Releem Agent automatically on every database server. Releem Agent will automatically collect metrics and recommend configuration.

  1. Click "Add Server" link at Releem Customer Portal
  2. Fill fields:
    - MySQL Root User Password (we don't store this password, it uses only to buid Installation command)
    - MySQL Memory Limit in Megabytes. Use this field only if in case there are installed other software on your server.
  3. Copy Installation command, past it in the terminal and execute as a root user.

Manual Installation

Use this instruction to install Releem Agent manually on every database server. Releem Agent will automatically collect metrics and recommend configuration.

1. Create read-only user "releem" in MySQL. Releem Agent will use it to collect metrics from MySQL
Change [Password] to your secret password

CREATE USER 'releem'@'127.0.0.1' identified by '[Password]';
GRANT SELECT, PROCESS,EXECUTE, REPLICATION CLIENT,SHOW DATABASES,SHOW VIEW ON *.* TO 'releem'@'127.0.0.1';
Installation without Docker
2. Run Installation command as a root user on the server:

RELEEM_MYSQL_PASSWORD='[Password]' RELEEM_MYSQL_LOGIN='releem' RELEEM_MYSQL_MEMORY_LIMIT=0 RELEEM_API_KEY=[Key] RELEEM_CRON_ENABLE=1 bash -c "$(curl -L https://releem.s3.amazonaws.com/v2/install.sh)"
Parameters:
  • RELEEM_MYSQL_LOGIN - MySQL User name to collect MySQL metrics
  • RELEEM_MYSQL_PASSWORD - MySQL User password to collect MySQL metrics
  • RELEEM_MYSQL_MEMORY_LIMIT - Change parameter in case there are other software installed on the server. Default value is 0 means use all memory.
  • RELEEM_API_KEY - API Key. Get it from Profile page in Releem Customer Portal.
  • RELEEM_MYSQL_HOST - use this variable in case MySQL listen different interface or connection available only through socket.
Docker Installation
2. Set the hostname for the MySQL container to prevent duplicating at Releem Customer Portal
3. Run the container using Docker or Docker compose
  • Docker
    The basic pattern for starting a Releem Agent instance is:

docker run -d -ti --name 'releem-agent' -e DB_HOST="[DB_HOST]" -e DB_PORT="[DB_PORT]" -e DB_PASSWORD="[RELEEM_MYSQL_PASSWORD]" -e DB_USER="releem" -e RELEEM_API_KEY="[RELEEM_API_KEY]" -e MEMORY_LIMIT=[MEMORY_LIMIT] releem/releem-agent
  • Docker Compose

version: '3.7'
services:
  releem-agent:
    image: releem/releem-agent
    container_name: releem-agent
    environment:
      MEMORY_LIMIT: "${MEMORY_LIMIT}"
      DB_USER: "releem"
      RELEEM_API_KEY: "${RELEEM_API_KEY}"
      DB_PASSWORD: "${RELEEM_MYSQL_PASSWORD}"
      DB_PORT: "${DB_PORT}"
      DB_HOST: "${DB_HOST}"
    restart: unless-stopped
    volumes:
      - /tmp/.mysqlconfigurer/:/tmp/.mysqlconfigurer/
      - /etc/mysql/releem.conf.d/:/etc/mysql/releem.conf.d/
Parameters:
  • RELEEM_API_KEY - Releem API Key. To get your Releem API Key, please sign up.
  • DB_USER - MySQL user name for data collection
  • DB_PASSWORD - MySQL user password name for data collection
  • DB_HOST - MySQL host for data collection
  • DB_PORT - MySQL port for data collection
  • MEMORY_LIMIT - RAM limit allocated for MySQL. Set to system RAM or limit for MySQL

Volumes:
  • /tmp/.mysqlconfigurer/
  • /etc/mysql/releem.conf.d/
4. To automate applying new settings and enable Performance Scheme and Slowlog please mount the following folder to the MySQL container. volumes:
  • /etc/mysql/releem.conf.d/:/etc/mysql/conf.d/

5. Add the following line to the my.cnf file of the MySQL container "!includedir /etc/mysql/conf.d"

Manual Installation for RDS

Use this instruction to install Releem Agent manually on the EC2 instance to tune AWS RDS. Releem Agent will automatically collect metrics and recommend configuration.

1. Create read-only user "releem" in MySQL. Releem Agent will use it to collect metrics from MySQL
Change [Password] to your secret password

CREATE USER 'releem'@'%' identified by '[Password]';
GRANT SELECT, PROCESS,EXECUTE, REPLICATION CLIENT,SHOW DATABASES,SHOW VIEW ON *.* TO 'releem'@'%';
2. Add IAM role releem-agent-role and apply it to the EC2 instance: 

{ 
  "Version": "2012-10-17", 
  "Statement": [ 
    { 
      "Action": [ 
        "rds:Describe*", 
        "cloudwatch:Get*", 
        "logs:Get*", 
        "ec2:Describe*" 
      ], 
      "Resource": "*", 
      "Effect": "Allow" 
    } 
  ] 
}
Installation without Docker
2. Run Installation command as a root user on the server:

RELEEM_MYSQL_HOST='[RDS_ENDPOINT]' RELEEM_MYSQL_PASSWORD='[Password]' RELEEM_MYSQL_LOGIN='releem' RELEEM_MYSQL_MEMORY_LIMIT=0 RELEEM_API_KEY=[Key] RELEEM_CRON_ENABLE=1 bash -c "$(curl -L https://releem.s3.amazonaws.com/v2/install.sh)"
Parameters:
  • RELEEM_MYSQL_LOGIN - MySQL User name to collect MySQL metrics
  • RELEEM_MYSQL_PASSWORD - MySQL User password to collect MySQL metrics
  • RELEEM_MYSQL_MEMORY_LIMIT - Change parameter in case there are other software installed on the server. Default value is 0 means use all memory.
  • RELEEM_API_KEY - API Key. Get it from Profile page in Releem Customer Portal.
  • RELEEM_MYSQL_HOST - use this variable in case MySQL listen different interface or connection available only through socket.

3. Add following lines to the /opt/releem/releem.conf:
Please change aws_region and aws_rds_db settings

instance_type="aws/rds"
aws_region="[AWS_REGION]"
aws_rds_db="[RDS_INSTANCE_NAME]"
4. Restart Releem Agent using the following command:

systemctl restart releem-agent

Example of Recommended MySQL Configuration

Example of the recommended configuration file /tmp/.mysqlconfigurer/z_aiops_mysql.cnf:

[mysqld]
query_cache_type = 1 ### Previous value : ON
query_cache_size = 128M ### Previous value : 134217728
query_cache_limit = 16M ### Previous value : 16777216
thread_cache_size = 8 ### Previous value : 8
key_buffer_size = 205520896 ### Previous value : 205520896
max_allowed_packet = 1073741824 ### Previous value : 67108864
sort_buffer_size = 16777216 ### Previous value : 25165824
read_rnd_buffer_size = 4194304 ### Previous value : 4194304
bulk_insert_buffer_size = 8M ### Previous value : 2097152
myisam_sort_buffer_size = 8388608 ### Previous value : 25165824
innodb_buffer_pool_instances = 2 ### Previous value : 3
innodb_buffer_pool_size = 3019898880 ### Previous value : 3019898880
max_heap_table_size = 256M ### Previous value : 268435456
tmp_table_size = 256M ### Previous value : 268435456
join_buffer_size = 8M ### Previous value : 8388608
max_connections = 151 ### Previous value : 151
table_open_cache = 3072 ### Previous value : 3072
table_definition_cache = 1920 ### Previous value : 1920
innodb_flush_log_at_trx_commit = 2 ### Previous value : 2
innodb_log_file_size = 377487360 ### Previous value : 805306368
innodb_write_io_threads = 4 ### Previous value : 4
innodb_read_io_threads = 4 ### Previous value : 4
innodb_file_per_table = 1 ### Previous value : ON
innodb_flush_method = O_DIRECT ### Previous value :
innodb_thread_concurrency = 0 ### Previous value : 0

How to apply the Recommended Configuration using Releem Agent

To apply recommended configuration just run the following command:
/bin/bash /opt/releem/mysqlconfigurer.sh -a

How to rollback to the previous configuration using Releem Agent

Also, you can rollback to the previous configuration. To do that just run:
/bin/bash /opt/releem/mysqlconfigurer.sh -r

How to apply the Recommended Configuration Manually

Releem Agent automatically stores Recommended Configuration at
/tmp/.mysqlconfigurer/z_aiops_mysql.cnf

To apply Recommended Configuration perform the following steps:
1. Copy Recommended Configuration to MySQL configuration folder: 

cp /tmp/.mysqlconfigurer/z_aiops_mysql.cnf /etc/mysql/conf.d/
In CentOS instead /etc/mysql/conf.d you should use /etc/my.cnf.d/ folder.

2. Restart MySQL to apply configuration:

service mysqld restart
In case of change 'innodb_log_file_size' only in MySQL 5.6.7 or earlier perform the following commands:

mysql -e"SET GLOBAL innodb_fast_shutdown = 1" 
service mysql stop
mv /var/lib/mysql/ib_logfile[01] /tmp
service mysql start

How to update Releem Agent

Steps to update Releem Agent
To update Releem Agent perform the following command:
    
/opt/releem/mysqlconfigurer.sh -u

    How to uninstall Releem Agent

    Steps to uninstall Releem Agent
    To uninstall Releem Agent from the server, you should perform the following step:
    1. Stop Releem Agent using the following command:
      /opt/releem/releem-agent stop
    2. Remove Releem Agent service using the following command:
      /opt/releem/releem-agent remove
    3. Delete /opt/releem folder. To delete, run the following command:
    4. rm -r /opt/releem
    5. Edit crontab and remove commands containing 'releem'. To edit crontab, run the following command:
      crontab -e

    How to update Payment Information

    Releem is integrated with Paddle to automate subscriptions. You can manage Payment Information in Receipt Email you received from Paddle.

    If you have any questions just wrote us at hello@releem.com.

    How to cancel Releem Subscription

    Releem is integrated with Paddle to automate subscriptions. You can cancel Releem subscription in Receipt Email you received from Paddle.