The ABS configuration file (abs.properties)
is located in the ABS
config
directory. The following table explains the parameters and
provides recommended values.
Parameter | Description |
ABS IP, port, log level, and JKS password | |
timezone
|
Set the timezone to utc or local. The default timezone is local. |
host_ip
|
The externally visible IP address of the host ABS machine. |
management_port
|
Port for ABS to ASE and REST API to ABS communication. The default value is 8080. |
log_port
|
Port for ASE to send log files to ABS. The default value is 9090. |
jks_password
|
The password of the JKS Keystore. ABS ships with a default obfuscated password. You can reset the password and obfuscate it. This password should be the same that you would use in importing your CA-signed certificate . |
log_level
|
Log detail captured. The default is INFO. Additional options - DEBUG, ERROR, WARN, FATAL. |
ABS performance configurations | |
system_memory
|
Memory size in MB allocated to run machine learning jobs. Recommended to be at least 50% of system memory. |
system_json_size
|
Memory size in KB allocated for API JSON files. The default is 500 KB. |
runaway_time
|
Maximum time in minutes to wait for a job to finish. The default value is 120 minutes. |
queue_size
|
Do not change the value of this parameter. The default is 10. |
ABS email configurations for alerts and reporting | |
enable_emails
|
Enable (true ) or disable (false ) ABS email
notifications. |
sender_email
|
Email address used for sending email alerts and reports. |
receiver_email
|
Email address notified about alerts and reports. If you want more than one person to be notified, use an email alias. |
email_password |
Password of sender's email account. Note: You can leave this field blank if
your SMTP server does not require authentication. |
smtp_port
|
Port number of SMTP server. |
smtp_host
|
Hostname of SMTP server. |
smtp_ssl |
Set to Set it to false if email communication is over a non-SSL channel. The email
communication will fail if you set the parameter to |
smtp_cert_verification |
Set to If you set it to Note: If you have configured an IP address as
Here smtp_host and
set smtp_cert_verification to true ,
then make sure that the certificate configured on the SMTP server has the
following:
x.x.x.x is the IP address is the address configured in
smtp_host . |
MongoDB configuration | |
mongo_rs
|
Comma separated MongoDB replica set nodes IP addresses and port numbers. A maximum of three nodes can be configured. |
metadata_dbname
|
The MongoDB metadata database name. The default value is |
data_dbname
|
The MongoDB data database name. The default value is |
mldata_dbname
|
The MongoDB machine learning database name. The default value is |
mongo_auth_mechanism |
Defines the method in which MongoDB authenticates. The possible values can
be:
|
mongo_username
|
Username of MongoDB. Note: Required for MongoDB authentication
|
mongo_password
|
MongoDB password |
mongo_ssl |
Set it to true if MongoDB is configured to use SSL
connections. The default value is false . |
mongo_certificate |
Set it to true if you want to verify MongoDB SSL server
certificate when ABS connects to MongoDB. The default value is
false .Note: Make sure
mongo_ssl is set to true before setting
mongo_certificate to true .
|
ABS reporting node | |
dashboard_node
|
When The default value is Note: Multiple nodes can be Reporting or Dashboard nodes.
|
abs.properties
file is displayed
below.# Ping Identity Corporation, ABS config file
# All the keys should be present, leave blank value if not applicable
# Set the timezone to utc or local. The default timezone is local.
timezone=local
# ABS node host IP
# If you have multiple network interfaces or if you are running inside a Docker, specify the externally visible IP address for ABS to bind
host_ip=127.0.0.1
# REST API port
management_port=8080
# Streaming port
log_port=9090
# Log levels (ALL > DEBUG > INFO > WARN > ERROR > FATAL > OFF)
log_level=INFO
# Java KeyStore password
jks_password=OBF:AES:Q3vcrnj7VZILTPdJnxkOsyimHRvGDQ==:daYWJ5QgzxZJAnTkuRlFpreM1rsz3FFCulhAUKj7ww4=
# MongoDB replica set nodes comma separated IP addresses and port numbers. For example, <IP1>:<Port>, <IP2>:<Port>, <IP3>:<Port>. Maximum three nodes can be configured.
mongo_rs=localhost:27017
# MongoDB Database
metadata_dbname=abs_metadata
data_dbname=abs_data
mldata_dbname=abs_mldata
# MongoDB authentication
# If authentication is not enabled in MongoDB, set the mongo_auth_mechanism to NONE
# The supported MongoDB authentication mechanisms are DEFAULT and PLAIN.
# If authentication mechanism is DEFAULT, provide MongoDB username and password for mongo_username
# and mongo_password. If authentication mechanism is PLAIN, provide external
# LDAP username and password in mongo_username and mongo_password.
mongo_auth_mechanism=DEFAULT
mongo_username=absuser
mongo_password=OBF:AES:Q3vcrnj7VZILTPdJnxkOsyimHRvGDQ==:daYWJ5QgzxZJAnTkuRlFpreM1rsz3FFCulhAUKj7ww4=
# Mongo DB SSL
# Set to true if Mongo DB instance is configured in SSL mode.
# By default, ABS will try to connect to Mongo using non-SSL connection
mongo_ssl=false
# Mongo DB Server Certificate Verification
# Set to true if Mongo DB instance is configured in SSL mode and you want to do the server certificate verification
# By default ABS will not verify the MongoDB server certificate
mongo_certificate=false
# Time to mark a job runaway in minutes
runaway_time=120
# Job queue size per node
queue_size=10
# Setting as true makes an ABS node for dashboard query only and does not participate in ABS cluster for log processing
dashboard_node=false
# Memory for webserver and streaming server (unit is in MB)
system_memory=4096
# Memory for ASE JSON (unit is KB)
system_json_size=8192
# E-mail alerts
enable_emails=false
# SMTP host
smtp_host=smtp.example.com
# SMTP port
smtp_port=587
# Set this value to true if smtp host support SSL
smtp_ssl=true
# Set this value to true if SSL certificate verification is required
smtp_cert_verification=false
# Sender email id
sender_email=sender@example.com
# Sender's email password
email_password=OBF:AES:UXzB+y+69Bn3xiX6N822ad4hf5IfNfJY9w==:T+QzM6qtc0+6MVsx4gU5p0LMHAI/y+w8DDsWv6VxVAk=
# Receiver's email id
receiver_email=receiver@example.com