Install MariaDB Agent Manager

Overview

The MariaDB Agent Manager coordinates deployment of the agents needed to consolidate and push data to the SkySQL Observability service.

MariaDB Agent Manager transmits monitoring metrics and topology status data to the SkySQL Observability service.

MariaDB Agent Manager can be installed using a binary tarball.

Compatibility

MariaDB Products

  • MariaDB Community Server 10.3

  • MariaDB Community Server 10.4

  • MariaDB Community Server 10.5

  • MariaDB Community Server 10.6

  • MariaDB Enterprise ColumnStore 5

  • MariaDB Enterprise ColumnStore 6

  • MariaDB Enterprise ColumnStore 22.08

  • MariaDB Enterprise ColumnStore 23.02

  • MariaDB Enterprise Server 10.3

  • MariaDB Enterprise Server 10.4

  • MariaDB Enterprise Server 10.5

  • MariaDB Enterprise Server 10.6

  • MariaDB MaxScale 2.5

  • MariaDB MaxScale 6

  • MariaDB MaxScale 22.08

  • MariaDB MaxScale 23.02

  • MariaDB Xpand 5.3

  • MariaDB Xpand 6.0

  • MariaDB Xpand 6.1

Operating Systems

  • CentOS 7

  • Red Hat Enterprise Linux 7

  • Red Hat Enterprise Linux 8

  • Rocky Linux 8

  • Ubuntu 18.04 LTS

  • Ubuntu 20.04 LTS

  • Ubuntu 22.04 LTS

Step 1: Login as Appropriate OS User

Login as the appropriate user, which depends on which systemd mode MariaDB Agent Manager uses for your operating system:

  • On operating systems that use MariaDB Agent Manager in user systemd mode, perform the procedure as the non-root OS user that will run the services. When logging in, do not use su to switch to the user, because a full login session is required to start the systemd user manager instance used by MariaDB Agent Manager's systemd services. The user account is required to be in the sudo group during installation, but the user can be removed from the group after installation.

  • On operating systems that use MariaDB Agent Manager in system systemd mode, perform the procedure as the root OS user.

Step 2: Download Agent Manager

On each Forwarding Host and Monitored Host, MariaDB Agent Manager must be downloaded.

This step shows how to download MariaDB Agent Manager using your web browser. For alternative details on how to download MariaDB Agent Manager via command-line interface, see "Alternative: Download Agent Manager via CLI".

Perform the following steps:

  1. Download the MariaDB Agent Manager binary tarball.

  2. Copy the binary tarball to each host.

  3. On each host, extract the files from the binary tarball:

    $ tar -xvzf mariadb-agent-manager-for-pdc-v1.3.0.linux-amd64.tar.gz
$ cd mariadb-agent-manager-for-pdc-v1.3.0.linux-amd64

Step 3: Install MariaDB Agent Manager

On each Forwarding Host and Monitored Host, MariaDB Agent Manager must be installed by executing the mariadb_agent_manager install sub-command:

$ ./mariadb_agent_manager install

As part of the installation process, the MariaDB Agent Manager components are copied to the installation directories.

On MariaDB Server and MariaDB MaxScale nodes, the installer will ask if you would like to create a database user account or MaxScale user account for use with SkySQL Observability.

For database user accounts, the user accounts should be created on different nodes on different topologies:

  • With Single Node Server, the user account should be created on the server node.

  • With the Xpand topology, the user account should be created on a single node in the Xpand cluster, and the Xpand cluster replicates the user account to all nodes.

  • With the Replicated Transactions and Multi-Node Analytics topologies, the user account should be created on the primary node, and the primary node replicates the user to all replica nodes.

  • With the Galera Cluster topology, the user account should be created on a single node in the Primary Component, and the node replicates the user account to all nodes in the Primary Component.

  • With any topology that uses MaxScale, the MaxScale user should be created on each individual MaxScale node.

If you do not create database user accounts and MaxScale user accounts during this step of the procedure, they can still be created after installation using the mariadb_agent_manager create-user sub-command or by manually creating the user accounts.

Step 4: Remove User from sudo Group (User Systemd Mode)

If MariaDB Agent Manager runs in user systemd mode on your operating system, the user account can be removed from the sudo group after installation is complete:

$ gpasswd -d mariadbagent sudo

Step 5: Update PATH (User Systemd Mode)

If MariaDB Agent Manager runs in user systemd mode on your operating system, the PATH environment variable for the user account can be updated to include Agent Manager's executables directory:

$ export PATH="$PATH:/home/$USER/.local/bin"

Alternative: Download Agent Manager via CLI

For users who don't want to download MariaDB Agent Manager via their browser, MariaDB Corporation customers can download MariaDB Agent Manager via command-line interface with their Customer Download Token.

Retrieve Customer Download Token

MariaDB Corporation customers can retrieve their Customer Download Token through the MariaDB Customer Portal.

Note

MariaDB Corporation's Customer Download Tokens are customer-specific. Protect the token as you would any security credential.

To retrieve the Customer Download Token for your account:

  1. Navigate to the Customer Download Token at the MariaDB Customer Portal.

  2. Log in using your MariaDB ID.

  3. Copy the Customer Download Token.

Download Binary Tarball via CLI

MariaDB Corporation provides an interface to download binary files using command-line tools or automation.

Binary files can be downloaded using command-line tools or automation from the MariaDB Download interface with the Customer Download Token. The URL is in the following format:

https://dlm.mariadb.com/CUSTOMER_DOWNLOAD_TOKEN/FILE

Download a binary file using the following procedure:

  1. In your web browser, visit the MariaDB Download interface for the MariaDB Agent Manager binary tarball.

  2. In your web browser, navigate to the binary file that you would like to download and copy the URL.

    For example, to download a binary tarball of MariaDB Agent Manager 1.3.0, the URL is:

    https://dlm.mariadb.com/FILE_ID/monitoring/agent-manager/mariadb-agent-manager-for-pdc-v1.3.0.linux-amd64.tar.gz

    FILE_ID is an internal identifier that is different for each file.

  3. Extract the FILE path from the copied URL.

    For example, to download the file mentioned above, the FILE path is:

    FILE_ID/monitoring/agent-manager/mariadb-agent-manager-for-pdc-v1.3.0.linux-amd64.tar.gz

  4. Use your Customer Download Token and the FILE path to construct your customer-specific URL to download the file using command-line tools or automation.

    For example, to download the file mentioned above, the customer-specific URL is:

    https://dlm.mariadb.com/CUSTOMER_DOWNLOAD_TOKEN/FILE_ID/monitoring/agent-manager/mariadb-agent-manager-for-pdc-v1.3.0.linux-amd64.tar.gz

  5. Use your customer-specific URL to download the file using command-line tools or automation:

    For example, to download the file mentioned above using wget:

    $ wget https://dlm.mariadb.com/CUSTOMER_DOWNLOAD_TOKEN/FILE_ID/monitoring/agent-manager/mariadb-agent-manager-for-pdc-v1.3.0.linux-amd64.tar.gz

    Or using curl:

    $ curl -LO https://dlm.mariadb.com/CUSTOMER_DOWNLOAD_TOKEN/FILE_ID/monitoring/agent-manager/mariadb-agent-manager-for-pdc-v1.3.0.linux-amd64.tar.gz