Installation and Parameter Configuration
This is the process of installing SysMaster DB 8.3 in a Docker-compose and Podman-compose environment.
1. Load Docker/Podman image
In the directory where the installation files are prepared, execute the following command to load the Docker/Podman image.
Docker:
docker load -i sysmaster-db-{version}.tarPodman:
podman load -i sysmaster-db-{version}.tar
The list of loaded container images is as follows.
sysmaster-db-client:{version}
sysmaster-db-sdm:{version}
sysmaster-db-tibero-master:{version}
sysmaster-db-collector:{version}
sysmaster-db-analyzer:{version}
sysmaster-db-tmaxopensql-postgres:{version}
sysmaster-db-schema-registry:{version}
sysmaster-db-kafka-loggable:{version}
sysmaster-db-zookeeper-loggable:{version}
2. Docker / Podman Service Definition
Open the docker-compose.yml file in the installation directory and define the 10 services to be created in the Docker-compose / Podman-compose environment. The description of each service is as follows.
client
The web server that users will access through their browsers
SDM
API server that retrieves collected information and communicates with clients
tibero-master
A server that performs status checks on the monitoring database and admin functions
collector
A server that collects data from the monitoring database
analyzer
A server that processes, analyzes, and stores collected information
metadb
DB server that stores UI-related setting information
repodb
A DB server that stores monitoring database collection data
zookeeper
Manages the status of Kafka Broker servers
broker
Kafka Broker server
Schema Registry
Kafka message protocol management
3. Set installation parameters
Open the .env file in the installation directory and set the parameter values required for installing SysMaster DB 8.3.
Each parameter should be separated by a line break, and there should be no spaces between the parameter name and value; simply enter an equal sign (=).
CLIENT_PORT=80
ADMIN_USERNAME=admin
ADMIN_PASSWORD=admin
COLLECTOR_PORT=8292
METADB_PORT=25432
METADB_USER=sysmaster
METADB_PASSWORD=sysmaster
METADB_PATH=./meta
METADB_CONF_PATH=./meta.conf
REPODB_PORT=15432
REPODB_USER=sysmaster
REPODB_PASSWORD=sysmaster
REPODB_PATH=./repo
REPODB_CONF_PATH=./repo.conf
RETENTION_DAY=7
LOG_PATH=./logs
LOG_RETENTION_DAY=1
LOG_FILE_SIZE=100MB
LOG_TOTAL_SIZE=1000MB
LOG_LEVEL=info
CONTAINER_LOG_PATH=/sysmaster/logs
KAFKA_MESSAGE_MAX_BYTES=20971520
TIME_ZONE=Asia/Seoul
SQL_FLUSH_THRESHOLD=100
SQL_RS_FETCH_SIZE=1000
# SKIP_DB_USER_COUNT_MIGRATION_PATCH=true
# SKIP_DAILY_SEGMENT_MIGRATION_PATCH=true
# SKIP_V8_2_1_TO_V8_3_0_MIGRATION_PATCH=true
# RETENTION_DAY_FOR_V8_2_1_TO_V8_3_0_MIGRATION_PATCH=7
SDM_HEAP_SIZE_MAX=
SDM_HEAP_SIZE_MIN=
ANALYZER_HEAP_SIZE_MAX=
ANALYZER_HEAP_SIZE_MIN=
COLLECTOR_HEAP_SIZE_MAX=
COLLECTOR_HEAP_SIZE_MIN=
TBM_HEAP_SIZE_MAX=
TBM_HEAP_SIZE_MIN=
PERFORMANCE_LOGGING=
LIMIT_SQL_HASH_COUNT=
# NGINX_RESOLVER=127.0.0.11 The parameters set in this process are described as follows.
CLIENT_PORT
Port number of the UI connection URL
8
ADMIN_USERNAME
Admin account username
admin
ADMIN_PASSWORD
Password for the Admin account
admin
COLLECTOR_PORT
Port number for the collection module (TPM Agent) to connect to [Note] Must be open on the SysMaster server to allow access from the monitoring DB
829
METADB_PORT
Meta DB connection port number
25432
METADB_USER
Meta DB super user name
sysmaster
METADB_PASSWORD
Meta DB super user password
sysmaster
METADB_PATH
Meta DB data file path
./meta
METADB_CONF_PATH
Path to the Meta DB configuration file
./meta.conf
REPODB_PORT
The port number for connecting to the repository DB
15432
REPODB_USER
Super user name for the repository DB
sysmaster
REPODB_PASSWORD
Repository DB super user password
sysmaster
REPODB_PATH
Repository DB data file path
./repo
REPODB_CONF_PATH
Path to the repository DB configuration file
./repo.conf
RETENTION_DAY
Retention period for collected information
7
LOG_PATH
Log creation location
./logs
LOG_RETENTION_DAY
Log file retention period
1
LOG_FILE_SIZE
Maximum size of a single log file
100MB
LOG_TOTAL_SIZE
Maximum log storage capacity per module
1000MB
LOG_LEVEL
Log level for each module
info
CONTAINER_LOG_PATH
Set the container internal log path
/sysmaster/logs
KAFKA_MESSAGE_MAX_BYTES
Set the Kafka message size, Can be set within the range of 1MB to 2GB
20971520 bytes
TIME_ZONE
SysMaster DB server time zone setting
Asia/Seoul
SQL_FLUSH_THRESHOLD
Limits the number of pieces of information that can be contained in a single SQL-related message. For SQL Plans, this value is limited to 10 times the specified value.
100 per monitoring DB
SQL_RS_FETCH_SIZE
The number of SQL-related information rows retrieved from the monitoring DB at one time.
1,000 per monitoring database
SKIP_DB_USER_COUNT_MIGRATION_PATCH
(When applying patches to an existing environment,) whether to skip the patch that creates the DB_USER_COUNT table data in the Repository DB based on previously collected data. If necessary, refer to [Note 1] below and configure accordingly.
true (disabled via comment)
SKIP_DAILY_SEGMENT_MIGRATION_PATCH
(When applying patches to an existing environment,) whether to skip the patch that creates data in the DAILY_SEGMENT table of the Repository DB based on existing data. If necessary, refer to [Reference 1] below and configure accordingly.
true (disabled via comment)
SKIP_V8_2_1_TO_V8_3_0_MIGRATION_PATCH
(When applying the patch to an existing environment,) whether to skip the migration of existing data collected in v8.2.1 or earlier for tables targeted by the new schema in v8.3.0. If necessary, refer to [Reference 2] below and configure accordingly.
true (disabled via comment)
RETENTION_DAY_FOR_V8_2_1_TO_V8_3_0_MIGRATION_PATCH
(When applying patches to an existing environment,) the migration scope (daily period) for data collected in v8.2.1 or earlier that is subject to migration in tables where the new schema has been applied in v8.3.0. If necessary, refer to [Note 2] below and configure accordingly.
7 (Not applied via comment)
SDM_HEAP_SIZE_MAX
Maximum heap size for SDM
1/4 of the total memory of the current container (refer to the "total mem" output of the "free" command). [Note] The current default Docker image is openjdk:17-alpine.
SDM_HEAP_SIZE_MIN
Minimum heap size for SDM
It is 1/64 of the total memory of the current container (refer to the total mem of the free command). [Note] The current default Docker image is openjdk:17-alpine.
ANALYZER_HEAP_SIZE_MAX
Maximum heap size for the analyzer
1/4 of the current container's total memory (refer to the total mem value from the free command). [Note] The current default Docker image is openjdk:17-alpine.
ANALYZER_HEAP_SIZE_MIN
Analyzer's minimum heap size
1/64 of the current container's total memory (refer to the total mem value from the free command). [Note] The current default Docker image is openjdk:17-alpine.
COLLECTOR_HEAP_SIZE_MAX
Maximum heap size for the collector
1/4 of the current container's total memory (refer to the total mem value from the free command). [Note] The current default Docker image is openjdk:17-alpine.
COLLECTOR_HEAP_SIZE_MIN
Minimum heap size for the collector
1/64 of the current container's total memory (refer to the total mem value from the free command). [Note] The current default Docker image is openjdk:17-alpine.
TBM_HEAP_SIZE_MAX
Maximum heap size for TBM
1/4 of the current container's total memory (refer to the total mem value from the free command). [Note] The current default Docker image is openjdk:17-alpine.
TBM_HEAP_SIZE_MIN
Minimum heap size for TBM
It is 1/64 of the current container's total memory (refer to the total mem value from the free command). [Note] The current default Docker image is openjdk:17-alpine.
PERFORMANCE_LOGGING
Whether to enable performance-related logging [Note] Since this uses additional CPU and disk resources, setting this to Y may cause performance degradation.
N
LIMIT_SQL_HASH_COUNT
The maximum number of SQL plan hash value + cost combinations stored in memory to prevent duplicate collection, and the maximum number of SQL text hash values at the same time.
1 million [Note] This occupies approximately 300MB of memory in total.
NGINX_RESOLVER
Podman environment-specific setting Specifies the gateway address of the Sysmaster internal DNS network for DNS name resolution in NGINX. This setting is only required in the Podman environment and does not require additional configuration in other runtimes such as Docker.
Can be verified using `podman network inspect script_sysmaster`.
3.1 DNS Resolver Settings in Podman Environment
In a rootless Podman environment, the NGINX_RESOLVER parameter must be set separately. This is necessary for reconnection when individual containers are restarted after the sysmaster is started, and it uses the gateway IP address of the sysmaster network. This value may vary depending on the environment or Podman startup.
The following example shows the process of setting NGINX_RESOLVER=10.89.0.1 and booting the sysmaster.
[tibero@smdb-podman ~]$ podman compose up --no-start
[tibero@smdb-podman ~]$ podman network inspect script_sysmaster
[
{
"name": "script_sysmaster",
"id": "e014d8811e9b51f417d578358ab41e2624a465d9026c7916f9ba7e4ce382f699",
"driver": "bridge",
"network_interface": "cni-podman1",
"created": "2025-08-04T22:55:11.345378476-04:00",
"subnets": [
{
"subnet": "10.89.0.0/24",
"gateway": "10.89.0.1" /// -> Use this address
}
],
"ipv6_enabled": false,
"internal": false,
"dns_enabled": true,
"labels": {
"com.docker.compose.project": "script",
"io.podman.compose.project": "script"
},
"ipam_options": {
"driver": "host-local"
}
}
]
/// Set parameters on .env file
[tibero@smdb-podman ~]$ podman compose up -d4. Setting Meta DB and Repository DB Parameters
The users can check the Meta DB and Repository DB parameter values in the meta.conf and repo.conf files in the installation directory. These conf files use the default settings provided, but the parameters described below should be set manually by the user according to the runtime environment if necessary.
pg_max_connections
Maximum number of connections to the Meta DB (or Repository DB)
pg_owner_id
The user ID (uid) of the host OS for setting access permissions to the DB data directory. If the users want to directly access the container DB directory from a specific user on the host machine, set this to the user ID of that user.
pg_group_id
The user group ID (gid) of the host OS for setting access permissions to the DB data directory. If the users want to directly access the container DB directory from a specific user on the host machine, set this to the group ID of that user.
log_timezone
Time zone for logs in the Meta DB (or Repository DB).
Last updated