4.3 Environment variables available in Pods

The following are configuration items in the OPENMARU APM khan-agent.conf file that can be set as environment variables in the Deployment Config of NAVER CLOUD PLATFORM.

Configuration item Description Default value

OMAPM_APPLICATION_NAME

Specifies the application group name. However, the build number is not displayed.

Example) If hostname is equal to "jboss-eap-egov-65-zs95r", then the + eap-${HOSTNAME} will be returned as eap-${HOSTNAME:-:5} ⇒ eap-65

OMAPM_HOST

OMAPM_PORT

443

OMAPM_TLS

true

OMAPM_AGENT_IP

OMAPM_USER_KEY

NIL

OMAPM_INSTANCE_ID

Specifies the instance name.

If specified, it will be displayed as "[Setting]-BuildNumber-LambdaValue".

If not specified, the Deployment name is used.

Example) If hostname is equal to "jboss-eap-egov-65-zs95r", it will be displayed as +. eap-${HOSTNAME:-:5}-${HOSTNAME:-:6} ⇒ eap-65-zs95r

case1: instanceid-${RANDOM:4} =⇒ instanceid-qfPb
case1: instanceid-${RANDOM:4}-s =⇒ instanceid-qfPb-s
case1: instanceid-${IPADDR:3} =⇒ instanceid-23-10 (ip=192.168.23.10)
case1: instanceid-${HOSTNAME:-:2} =⇒ instanceid-apm (hostname=test-apm)
case1: instanceid-${HOSTNAME:-:2}-${IPADDR:3}-${RANDOM:4}-s =⇒ instanceid-apm-23.10-afcg-s (hostname=test-apm, ip=192.168.23.10)

OMAPM_AGENT_TYPE

WAS

OMAPM_AGENT_COMPRESS_TYPE

Specifies the type of compression algorithm for the agent.

lzw (default=snappy)

OMAPM_APDEX_THRESHOLD

Specifies the user-satisfactory response time for the APDEX (default 3 seconds)

3.0

OMAPM_TRANSACTION_TRACE_ENABLED

Specifies whether to enable transaction traces.

true

OMAPM_TRANSACTION_TRACE_THRESHOLD

Specifies the response time to collect transaction traces (in ms).

Default: 500 ms

500

OMAPM_TRANSACTION_TRACE_THRESHOLD_UNDER_DETAIL_ENABLED

false

OMAPM_SQL_CAPTURE_ENABLED

Specifies whether to collect SQL statements when tracing transactions.

true

OMAPM_TRANSACTION_TRACE_SQL_PARAMETERIZE

false

OMAPM_TRANSACTION_SAMPLING_INTERVAL

Specifies the interval for collecting transactions for the same URL.

If you specify 10, only 1 out of 10 traces are kept for the same URL.

1

OMAPM_TRANSACTION_TRACE_SQL_STACKTRACE_THRESHOLD

Sets the stacktrace threshold for SQL queries to ms.

30000

OMAPM_TRANSACTION_TRACE_HEADER_ENABLED

Specifies whether to enable tracing the header of the requested value.

true

OMAPM_TRANSACTION_TRACE_HEADER_KEYS

Key values of the requested HEADER.

OMAPM_TRANSACTION_TRACE_COOKIE_ENABLED

Specifies whether the requested cookie trace is enabled.

false

OMAPM_TRANSACTION_TRACE_COOKIE_KEYS

Key values of the requested cookies

JSESSIONID

OMAPM_TRANSACTION_TRACE_PARAMETER_KEYS

Additional parameters from the URL

OMAPM_DATABASE_FETCH_WARNINGS

Displays a warning when fetching a specified number of comma separated SQL ResultSet.

10000,20000,30000

OMAPM_DATABASE_CONN_LEAK_WARNING

DB connection leak warning

false

OMAPM_DATABASE_POOL_STAT_ENABLED

Specify whether to enable statistics monitoring for the entire DB pool

false

OMAPM_DATABASE_POOL_STAT_INCLUDE_PATTERNS

Specify a list of patterns to include by separating datasource names with commas

OMAPM_DATABASE_POOL_STAT_EXCLUDE_PATTERNS

Specifies a comma-separated list of patterns to exclude from datasource names.

OMAPM_INCLUDE_PACKAGES

OMAPM_TRANSACTION_EXCLUDE_URL_PATTERNS

URLs to exclude from monitoring (regular expression)

예) /test/test.**,\*/abc/test.*

\\*

OMAPM_TRANSACTION_EXCLUDE_URL_SUFFIX

.gif,.swf,.css,.hwp,.xls,.xlsx,.eot,.pptx,.ppt,.asf,.pdf,.txt,.flv,.mp3,.mp4,.doc,.html,.wmv,.jpg,.zip,.wav,.png,.ttf,.mov,.ico,.js,.woff,.xml,.htc,.NewProxyConnection,.DelegatingConnection,.SqlSessionTemplate,.CUBRIDConnection,.PoolableConnection,.WrappedConnection,/bea_wls_deployment_internal/DeploymentService,.GIF,.SWF,.CSS,.HWP,.XLS,.XLSX,.EOT,.PPTX,.PPT,.ASF,.PDF,.TXT,.FLV,.MP3,.MP4,.DOC,.HTML,.WMV,.JPG,.ZIP,.WAV,.PNG,.TTF,.MOV,.ICO,.JS,.WOFF,.XML,.HTC

OMAPM_TRANSACTION_EXCLUDE_URL_SUFFIX_EXCLUDE

true

OMAPM_TRANSACTION_EXCLUDE_USER_AGENT_PATTERNS

^openmaru-health-check$

OMAPM_TRANSACTION_ERRORPAGE_URL_PATTERNS

/session/force500.*,/test/test500.*

OMAPM_TRANSACTION_WITH_EXCEPTION_VIEW_ENABLED

true

OMAPM_TRANSACTION_WITH_EXTERNAL_HTTP_ERROR_VIEW_ENABLED

true

OMAPM_TRANSACTION_WITH_EXTERNAL_HTTP_ERROR_CODES

OMAPM_TRAFFIC_CONTROL_ENABLED

true

OMAPM_TRAFFIC_CONTROL_PATTERN_1

Specifies the maximum number of simultaneous requests of the specified pattern to allow

/test/slow., 100

OMAPM_TRAFFIC_CONTROL_PATTERN_2

Specify the maximum number of simultaneous requests of the specified pattern to allow

/test/test., 100

OMAPM_TRAFFIC_CONTROL.PATTERN_3

Specifies the maximum number of simultaneous requests of the specified pattern to allow

/test/TestServlet., 100

OMAPM_UBT_CHECK_ENABLED

false

OMAPM_UBT_CHECK_TYPE

ip

OMAPM_UBT_CHECK_USER_COUNT

100

OMAPM_UBT_CHECK_TIME_INTERVAL

1

OMAPM_UBT_CHECK_ALERT_DUP_PREVENT

30

OMAPM_USER_TRACKING_MODE

Specify user tracking mode 0 : Client IP 1 : JSESSIONID Cookie 2 : KHANUSER Cookie - default

2

OMAPM_USER_THINKTIME_MINUTES

5

OMAPM_ENABLE_FILTER_INTERCEPTOR

false

OMAPM_ENABLE_IBATIS_INTERCEPTOR

false

OMAPM_ENABLE_MYBATIS_INTERCEPTOR

false

OMAPM_ENABLE_HTTP_INTERCEPTOR

false

OMAPM_ENABLE_SPRINGBATCH_INTERCEPTOR

false

OMAPM_ENABLE_LOGGING_INTERCEPTOR

false

OMAPM_TRACE_LOGGING_LEVELS

WARN,ERROR,FATAL

OMAPM_PUSH_TRANSACTION_NO_DELAY

true

OMAPM_ACTIVEUSER_COUNTFIRSTREQUEST

false

OMAPM_USER_CHARSET_ENCODING

Specify the encoding value for APM

UTF-8

OMAPM_USER_INTERCEPTOR_FILE

File name where the user’s interceptor environment variable is set

user-interceptor.conf

OMAPM_LOG_DIR

Set APM log path

/svc/test/khan-agent/log

OMAPM_LOG_FILE

Name the log file

khan-agent-${INSTANCEID}.log

OMAPM_LOG_LEVEL

Specify log level

INFO

OMAPM_LOG_BACKUP_INDEX

Set the number of backup files of logs to keep

3

OMAPM_LOG_ROTATE_SIZE

Specify the size of the log file to be rotated

10240000

OMAPM_SESSION_MANAGER_ENABLED

Whether to enable the session manager

true

OMAPM_ACTIVE_SESSION_COUNT_ENABLED

Whether to count sessions

true

OMAPM_AUDIT_LOG_ENABLED

Whether to enable audit log files

true

OMAPM_AUDIT_LOG_USERIDKEY

USER_ID

OMAPM_AUDIT_LOG_DIR

Set audit log path

OMAPM_AUDIT_LOG_FILENAME

Name the audit log file

audit-{date: yyyy-MM-dd}.log

OMAPM_AUDIT_LOG_POLICIES

daily: 00:00

OMAPM_AUDIT_LOG_BACKUPS

Set the number of backup files of the audit log to keep

3