MySQL Database Setup

👀 Overview

GermainUX supports MySQL as an on-premise datastore.

MySQL may be appropriate when:

Elasticsearch remains the preferred datastore for new, high-volume GermainUX deployments. Before selecting MySQL, review the Datastore Recommendation and Benchmark.

📦 MySQL Deployment Options

GermainUX can use a standard MySQL deployment or a highly available MySQL architecture approved by your organization.

A clustered architecture can provide:

The appropriate architecture depends on data volume, retention, availability requirements, and internal MySQL standards.

📋 Before You Begin

Confirm with Germain Software:

Do not install or upgrade MySQL independently of GermainUX compatibility requirements.

✅ Requirements

Prepare:

See:

⬇️ Install MySQL

Use your organization’s approved MySQL distribution and installation process.

🐧 Debian or Ubuntu

Update the package index and install MySQL Server:

sudo apt update
sudo apt install mysql-server

Confirm that the service is running:

sudo systemctl status mysql

Run the MySQL security configuration provided by the installed distribution and configure an administrative account according to your security policies.

If a specific MySQL version is required, obtain it from the MySQL Community Downloads archive or your approved internal repository.

🔴 Red Hat Enterprise Linux or Compatible Distribution

Configure an approved MySQL repository for the operating-system version, then install and start MySQL Server using the system package manager.

Example:

sudo dnf install mysql-community-server
sudo systemctl enable --now mysqld
sudo systemctl status mysqld

Repository names and commands vary by operating-system and MySQL version. Use the current package provided for your distribution rather than an obsolete repository package.

🪟 Windows

Download and install:

1. Download the MySQL Installer for Windows.

2. Run the installer with administrator privileges.

3. Select Server Only for a production database host, or Custom when additional tools are required.

4. Configure the MySQL service.

5. Configure the administrative account.

6. Enable TCP/IP connectivity.

7. Configure TLS.

8. Complete the installation.

9. Confirm that the MySQL Windows service is running.

Install MySQL Workbench only when a graphical administration tool is required.

🛡️ Secure MySQL

Before creating the GermainUX databases:

Do not use the MySQL root account as the GermainUX runtime account.

🗄️ Create the GermainUX Databases

GermainUX uses two MySQL databases:

The release package includes the SQL scripts required to create and initialize these databases.

1️⃣ 1. Extract the Service Distribution

Extract the GermainUX Service release package to a directory referenced below as:

$SERVICE_HOME

2️⃣ 2. Review the Database Instructions

Open:

$SERVICE_HOME/install/databases/readme.txt

This file defines the scripts and execution order for the specific GermainUX release.

Always follow the instructions supplied with the release being installed.

🔍 3. Locate the MySQL Scripts

The MySQL scripts are located under:

$SERVICE_HOME/install/databases/mysql

✏️ 4. Update the Initial Setup Script

Open:

$SERVICE_HOME/install/databases/mysql/basic-setup.sql

Replace the example passwords associated with:

apm_config
apm_datamart

Use strong, unique credentials approved by your organization.

Do not retain example credentials such as:

apm_config / apm_config
apm_datamart / apm_datamart

These values are placeholders only and must not be used in production.

⚙️ 5. Run basic-setup.sql

Execute:

basic-setup.sql

The script creates:

Review the script before execution to confirm that database names, users, hosts, and permissions match your architecture.

✨ 6. Initialize apm_config

Select:

apm_config

Run each:

config-*.sql

script in the sequence specified by:

$SERVICE_HOME/install/databases/readme.txt

✨ 7. Initialize apm_datamart

Select:

apm_datamart

Run each:

datamart-*.sql

script in the required sequence.

Do not skip scripts or change the order unless instructed by Germain Software.

⚙️ Configure GermainUX Enterprise

Configure GermainUX Enterprise with:

The default MySQL port is commonly:

3306

Use the actual port configured in your environment.

Place the supported MySQL JDBC driver in the location specified by the GermainUX Enterprise installation guide.

📋 Validate the Setup

Before starting production monitoring:

1. Connect to MySQL using each GermainUX service account.

2. Confirm that both databases exist.

3. Confirm that all required tables and indexes were created.

4. Verify that GermainUX Enterprise can connect.

5. Start GermainUX Enterprise.

6. Review logs for schema or permission errors.

7. Confirm that GermainUX configuration can be saved.

8. Ingest a limited monitoring workload.

9. Confirm that data is written to apm_datamart.

10. Open representative dashboards and analyses.

11. Test retention and cleanup.

12. Measure query and ingestion performance.

💾 Backup and Recovery

Configure backups for both:

apm_config
apm_datamart

The backup strategy should include:

The configuration and datamart databases may have different recovery and retention requirements.

📈 Performance and Capacity

Monitor:

Reassess capacity when monitoring scope, Session Replay, data retention, or user volume increases.

✅ Production Checklist

For supported versions, database scripts, migration assistance, or production sizing, contact Germain Software.