Installation and Parameter Configuration
The process for installing the TPM Agent is as follows. However, it must be performed using the same OS account that was used to install the monitoring database.
1. Distribute the installation file
Distribute the compressed file "tpmagent_dist_{version}.tar.gz" to the server where the monitoring database is located, then extract the compressed file.
tar -zxvf java_tpmagent_dist_{version}.tar.gz2. application.yml file settings
Create the application.yml file in the directory where the "java_tpmagent_dist_{version}.tar.gz" compressed file was extracted, and apply the settings as follows:
Adjust the values of each parameter according to the YAML syntax.
agent-config:
id: "AAA1"
ip: "192.1.3.225"
port: 8292
freq: 1000
charset: "utf-8"
cpu-mem-proc-freq: 5000
disk-freq: 5000
sessioninfo-freq: 5000
dbsysinfo-freq: 5000
sqltrace-freq: 5000
log:
level: INFO
rotate-time-interval: 24
rotate-file-size: 50MB
max-log-file-number: 7
path: logs/The following is a description of the parameters set in this process.
agent-config
id
Instance ID
[Note] Must be the same as the INSTANCE ID value entered when registering the monitoring database instance in the web UI. Incorrect input will result in monitoring of incorrect Tibero installation machine status, session lists, and TSC network configurations, so please be careful.
O
agent-config
ip
IP address that can connect to the SysMaster DB server
O
agent-config
port
Port number for the TPM Agent to connect to the COLLECTOR_PORT of the SysMaster DB server
O
agent-config
freq
Collection interval (unit: msec)
[Note] If not set, it is set to 1000ms, resulting in a collection interval of 1 second.
X
agent-config
charset
Character set of the monitoring DB (confirmed via the NLS_CHARACTERSET parameter)
[Note] If not set, it is set to utf-8.
X
agent-config
cpu-mem-proc-freq
Collection interval for CPU, memory, and process list information (unit: ms) [Note] If not set, it is set to the "freq" value.
X
agent-config
disk-freq
The interval for retrieving disk information (unit: ms)
[Note] If not set, it is set to "freq × 60," and if set, collection proceeds at the specified interval.
X
agent-config
session-freq
The interval for retrieving session information (unit: ms)
[Note] If not set, it is set to the "freq" value.
X
agent-config
dbsysinfo-freq
The interval for retrieving system metric information from the monitoring DB (unit: ms)
[Note] If not set, it is set to the "freq" value.
X
agent-config
sqltrace-freq
The interval for retrieving SQL Trace information (unit: ms)
[Note] If not set, it is set to the "freq" value.
X
log
level
Log level:
FATAL
ERROR
WARN
INFO
DEBUG
TRACE
[Note] If not set, it is set to INFO.
If set to DEBUG or higher, the log volume may increase, causing data loss due to failure to collect data within the interval set for the TPM Agent. As a result, data may not be displayed during real-time data monitoring. Therefore, it is recommended not to set this option in production environments, and to set the log level only for issue analysis.
X
log
rotate-time-interval
The interval at which log files are archived (unit: h)
Archives the current log file at each interval and writes to a new log file
[Note] If not set, it is set to 24, archiving log files daily.
X
log
rotate-file-size
File size of archived log files (unit: MB)
When the log file reaches this size, the log file is archived and new log files are loaded.
[Note] If not set, it is set to 50, so log file archiving occurs when the log file reaches 50 MB.
X
log
max-log-file-number
Maximum number of archived files (unit: number)
When the number of archived files reaches the maximum, the oldest log files are deleted.
[Note] If not set, the default value is 7, so the maximum number of log files is 7.
X
log
path
Log file creation directory
[Note] If not set, the path is set to "tpmagent.jar" followed by "logs/"
X
Java TPM Agent supported Charset
The character sets supported by Tibero are as follows.
ASCII
EUC-KR
MSWIN949
UTF-8
UTF-16
SHIFT-JIS
JA16SJIS
JA16SJISTILDE
JA16EUC
JA16EUCTILDE
VN8VN3
GBK
WE8MSWIN1252
ZHT16HKSCS
CL8MSWIN1251
WE8ISO8859P1
EE8ISO8859P2
WE8ISO8859P9
WE8ISO8859P15
CL8KOI8R
CL8ISO8859P5
CP866
TH8TISASCII
EL8MSWIN1253
EL8ISO8859P7
AR8MSWIN1256
AR8ISO8859P6
SJISTILDE
ZHT16BIG5
ZHT16MSWIN950
GB18030
IW8ISO8859P8
EUC-TW
Setting via environment variables
The environment variables to be applied to the set.sh file in the directory where the compressed file "java_tpmagent_dist_{version}.tar.gz" is extracted are listed below. Apply the settings by creating the file as follows.
export BOOT_WITH_AUTO_DOWN_CLEAN=true
export ENABLE_DEBUG=false
export ENABLE_GC_LOG=false
export JAVA_MIN_HEAP_SIZE=300m
export JAVA_MAX_HEAP_SIZE=300mThe following is a description of the environment variables set during this process.
BOOT_WITH_AUTO_DOWN_CLEAN
Environment variable that determines whether to terminate existing processes and then execute the TPM Agent, if any are running. The default value is true.
X
ENABLE_DEBUG
Environment variable that determines whether to open the debug port when running the TPM Agent. The default value is false.
X
ENABLE_GC_LOG
Environment variable that determines whether to generate a JVM GC log file when running the TPM Agent. The default value is false.
X
JAVA_MIN_HEAP_SIZE
Environment variable for setting the initial heap size when running TPM Agent. The default value varies depending on the JVM implementation and is typically 1/64 of the current machine memory.
X
JAVA_MAX_HEAP_SIZE
Environment variable for setting the maximum heap size when running the TPM Agent. The default value varies depending on the JVM implementation and is typically 1/4 of the current machine memory.
X
Last updated