Configuration¶

Note

All the logs are present in this folder $LIKPI_HOME/log

ObsAgent¶

Using a text editor, edit the configuration file and customize it for ObsAgent service.

Path: $LIKPI_HOME/conf/likpi-obsagent.properties

# Request Handler target url i.e: vps-rh-myserver:6666
RequestHandler.url=tcp://<hostname>:<port>

# ObasAgent identifier i.e: vps-obs-server#obsagent
RequestHandler.id=<obsagent_id>

# Hostname of ObsAgent i.e: vps-obs-server
Host.name = <hostname>

# Read the log file from the end or from the beginig
reading.mode = <end|start>

# Line log separator default 10
lineSeparatorChar=<value>

# AIOpsCell target url i.e: vps-aiops-myserver:4001
aiopscell.1.url  = tcp://<hostname>:<port>

# Buffer size default 16000
byteReadSize = <value>

LogFile.count = 1

# Log file path i.e: D:\\myapp\\applog1 (Windows)
LogFileName.0 = /opt/myapp/applog1
LogFileName.1 = /opt/myapp/other-applog

# For furure usage
sensors.enable = False

# No pass rules
nopass.pattern.1 = this message should be ignored
nopass.pattern.2 = other message should be ignored

Note

To enable debug tracing, udpate file $LIKPI_HOME/conf/likpi-obsagent_logback.xml configuration file

level=”WARN” to level=”TRACE”

AIOpsCell and HSQL databse¶

Using a text editor, edit the configuration file and customize it for AIOpsCell service.

Path: $LIKPI_HOME/conf/likpi-aiopscell.properties

# Request Handler target url i.e: vps-rh-myserver:6666
RequestHandler.url=tcp://<hostname>:<port>

# Request Handler identifier i.e: vps-rh-server#rh
RequestHandler.id=<rh_id>

# Hostname of AIOpsCell i.e: vps-aiops-server
Host.name = <hostname>

# Central server database credentials (default port:5432)
main.dbdriver=org.postgresql.Driver
main.dburl=jdbc:postgresql://<vps-central-hostname>:<port>/<mydb>
main.dbuser=<postgresql-admin-user>
main.dbpwd=<password>

# AIOpsCell database credentials (default port:9001 for HSQL)
im.dburl=jdbc:hsqldb:hsql://<hostname>:<port>/<mydb>
im.dbuser=<user>
im.dbpwd=<password>

# Default port:4001
ReceiverUrl = tcp://*:<port>

# this attribute is for test and debug purposes only. Default value is "true"
patternmatching.enable = true
dbwrites.enable = true

# Performance tuning
aiopscell.threads.count = 7
batch.size = 100
sql.exec.threads.count = 2
aiopscell.zmq.rcv.hwm = 10000000

# Policy for unmatched log messages
keepUnmatched.enabled = false
keepUnmatched.rule = size
keepUnmatched.limit = 10000
keepUnmatched.age = 30d
keepUnmatched.cleanupinterval = 1h

# Policy for log events
keepEvents.enabled = false
keepEvents.rule = size
keepEvents.limit = 1000000
keepEvents.age = 30d
keepEvents.cleanupinterval = 1h

# Delimiter for log messages
delimiterChar=\n

# Severity inference rules
severitysetter.critical.patterns.1 = error
severitysetter.critical.patterns.2 = critical
severitysetter.warning.patterns.1 = warning
severitysetter.warning.patterns.2 = fails
severitysetter.warning.patterns.3 = failure
severitysetter.warning.patterns.4 = failed
severitysetter.warning.patterns.5 = exception
severitysetter.warning.patterns.6 = incorrect
severitysetter.warning.patterns.7 = invalid
severitysetter.warning.patterns.8 = unable
severitysetter.warning.patterns.9 = too many
severitysetter.warning.patterns.10 = attack
severitysetter.critical.patterns.11 = fatal
severitysetter.warning.patterns.12 = wrong
severitysetter.warning.patterns.13 = did not match
severitysetter.warning.patterns.14 = unknown
severitysetter.major.patterns.1 = major
severitysetter.ok.patterns.1 = succeed
severitysetter.default = INFO

Note

To enable debug tracing, udpate file $LIKPI_HOME/conf/likpi-aiopscell_logback.xml configuration file

i.e: level=”WARN” to level=”TRACE”

Using a text editor, edit the configuration file and customize it for IMDB service.

Path: $LIKPI_HOME/conf/likpi-imdb.properties

# Database target url i.e: jdbc:hsqldb:hsql://localhost:9001/likpi
im.dburl=jdbc:hsqldb:hsql://<database_hostname>:<port>/<mydb>

# Database hostname i.e: localhost
im.dbhost=<hostname>

# Database administrator user i.e: likpiadm
im.dbuser=<user>

# Database administrator user password
im.dbpwd=<password>

# ??
repair.enable_merge_severities=false

# Persistence mode i.e: file
im.dbmode=<file|memory>

# Path database file i.e: F:\\test\\mydb\\likpi.db
im.dbfile=<database_file_path>

# ??
im.dbsilent=true

# Additional databse settings
im.db.additional_settings:hsqldb.log_size=1;hsqldb.tx=mvcc;hsqldb.large_data=true;hsqldb.cache_file_scale=512

Note

To enable debug tracing, udpate file $LIKPI_HOME/conf/likpi-imdb_logback.xml configuration file

i.e: level=”WARN” to level=”TRACE”

MetricsManager¶

Using a text editor, edit the configuration file and customize it for MetricsManager service.

Path: $LIKPI_HOME/conf/likpi-metricsmanager.json

{
  "sql.client.type" :"POSTGRES_ASYNC", // Enum value for driver

  "host" : "<FQDN>",
  "port" : <port>, // default 5432
  "maxPoolSize" : 50,

  "username" : "<likpidba>",
  "password" : "<password>",
  "database" : "<likpidb>",
  "queryTimeout" : 30000,

  "nats.host":"<FQDN>", // host nats server
  "nats.port":4222, // port nats server
  "nats.subject": "METRIC", // NATs subject
  "threadPool":1, // pool thread size for scheduler

  "request.handler.url" : "tcp://<hostname>:<port>", // RequestHandler target url
  "request.handler.identity" : "<hostname#metrics>" // identity for request handler
}

Note

To enable debug tracing, udpate file $LIKPI_HOME/conf/likpi-metricsmanager.xml configuration file

i.e: level=”WARN” to level=”TRACE”

TrendAnalysis¶

Using a text editor, edit the configuration file and customize it for TrendsAnalysis service.

Path: $LIKPI_HOME/conf/likpi-trendsanalysis.properties

[postgresql]

# Database hostname i.e: localhost
host=<hostname>

# Database name
database=<database>

# port
port=<port>

# Database administrator user
user=<user>

# Database administrator user password
password=<password>

CoreManager¶

Using a text editor, edit the configuration file and customize it for TrendsAnalysis service.

Path: $LIKPI_HOME/conf/likpi-coremanager.json

{
  "prog.name" : "Likpi Bigdata & Analytics", // Name of the appliction
  "prog.version" : "v1.0", // Version
  "license.file"     :"/opt/likpi/security/licenseFor-free.license", // License file

  "sql.client.type" :"POSTGRES_ASYNC", // Client type

  "host" : "<FQDN>",
  "port" : <port>, // default 5432
  "maxPoolSize" : 50,
  "username" : "<likpidba>",
  "password" : "<password>",
  "database" : "<likpidb>",
  "queryTimeout" : 30000,

  "authenticate" : true, // Authenticate true|false

  "agent.subscription.refresh.delay": 30000, // Subscription refresh Delay

  "live.obsolete.min.duration" : 10,  // Live obsolete duration in min
  "live.obsolete.min.check" : 5,              // Live obsolete check in min
  "histo.obsolete.min.duration" : 10,         // Historic obsolete duration in min
  "histo.obsolete.min.check" : 5,             // Historic obsolete check in min
  "histo.batch.min" : 0,                              // Historic batch in min (Historic is done from NATs in real time if the value is 0)

  "private.key.file" :"/opt/likpi/security/rsa_2048_priv.pem", // Private key file
  "public.key.file"  :"/opt/likpi/security/rsa_2048_pub.pem",  // Public key file
  "session.timeout"  : 900,
  "jwt.algo"         : "RS256", // jwt algo type

  "api.metric.broker.secure" : false, // Metric broker secure false|true
  "api.metric.broker.address" :"0.0.0.0", // Metric broker ip|hostname
  "api.metric.broker.port": 4222, // Metric broker port ( NATs port)

  "api.http.secure.external" : false, // http secure external false|true
  "api.http.secure.internal" : false, // http secure internal false|true
  "api.http.secure.tls.cert" : "/opt/likpi/security/httpcertificate.pem", // Certificate file
  "api.http.secure.tls.key"  : "/opt/likpi/security/httpkey.pem",         // Self signed key file

  "nats.host" : "localhost", // FQDN hostname or localhost
  "nats.port" : 4222, // NATs port
  "nats.subject" : "METRIC", // NATs subject

  "api.auth.http.address": "0.0.0.0",
  "api.auth.http.port": 8001,

  "api.admin.http.address": "0.0.0.0",
  "api.admin.http.port": 8002,

  "api.connector.http.address": "0.0.0.0",
  "api.connector.http.port": 8003,

  "api.attribute.http.address": "0.0.0.0",
  "api.attribute.http.port": 8004,

  "api.metric.http.address": "0.0.0.0",
  "api.metric.http.port": 8005,

  "api.view.http.address": "0.0.0.0",
  "api.view.http.port": 8006,

  "api.queryBuilder.http.address": "0.0.0.0",
  "api.queryBuilder.http.port": 8007,

  "api.collector.subscriber.http.address": "0.0.0.0",
  "api.collector.subscriber.http.port": 8008,

  "api.sql.builder.http.address": "0.0.0.0",
  "api.sql.builder.http.port": 8009,

  "api.organization.http.address": "0.0.0.0",
  "api.organization.http.port": 8011,

  "api.event.http.address": "0.0.0.0",
  "api.event.http.port": 8012,

  "api.regex.http.address": "0.0.0.0",
  "api.regex.http.port": 8013,

  "api.automator.http.address": "0.0.0.0",
  "api.automator.http.port": 8014,

  "api.cefattribute.http.address": "0.0.0.0",
  "api.cefattribute.http.port": 8015,

  "api.scenario.http.address": "0.0.0.0",
  "api.scenario.http.port": 8016,

  "api.activity.http.address": "0.0.0.0",
  "api.activity.http.port": 8017,

  "api.automation.guide.http.address": "0.0.0.0",
  "api.automation.guide.http.port": 8018,

  "api.history.http.address": "0.0.0.0",
  "api.history.http.port": 8019,

  "api.sqlquerybuilder.http.address": "0.0.0.0",
  "api.sqlquerybuilder.http.port": 8020,

  "api.probe.http.address": "0.0.0.0",
  "api.probe.http.port": 8021,

  "api.gateway.http.address": "0.0.0.0",
  "api.gateway.http.port": 8087,

  "api.gateway.builder.get" : "/api/query-builder",
  "api.gateway.builder.post" : "/api/query-builder",

  "request.handler.url" : "tcp://<hostname>:<port>", // RequestHandler target url

  "request.handler.identity.sql.builder": "SqlBuilder",
  "request.handler.target.sql.builder" : "Scheduler",
  "request.handler.action.sql.builder" : "reload",

  "request.handler.identity.sqb" : "sqb-api",
  "request.handler.target.sqb" : "Scheduler",
  "request.handler.action.sqb" : "reload_scheduled_tasks",

  "request.handler.identity.regex" : "regex",
  "request.handler.target.regex" : "Collector",
  "request.handler.action.regex.add" : "reload_regex_configuration",
  "request.handler.action.regex.remove" : "remove_regex",

  "smtp.host" : "<server>", // SMTP server
  "smtp.port" : "<port>", // SMTP port
  "smtp.user" : "<user_mail>", // User mail
  "smtp.password" : "<mail_password>" // User mail password

}

Requesthandler¶

Using a text editor, edit the configuration file and customize it for RequestHandler service.

Path: $LIKPI_HOME/conf/likpi-requesthandler.properties

# Request Handler target url i.e: vps-rh-myserver:6666
RequestHandler.url=tcp://<hostname>:<port>

# RequestHandler identifier i.e: localhost
RequestHandler.id=<requesthandler_id>

# Central server database credentials (default port:5432)
main.dbdriver=org.postgresql.Driver
main.dburl=jdbc:postgresql://<vps-central-hostname>:<port>/<mydb>
main.dbuser=<postgresql-admin-user>
main.dbpwd=<password>

Note

To enable debug tracing, udpate file $LIKPI_HOME/conf/likpi-requesthandler_logback.xml configuration file

level=”WARN” to level=”TRACE”

NATs¶

Using a text editor, edit the server.conf configuration file and customize it for NATs service.

Path: $LIKPI_HOME/nats-server-{version}-{platform}/server.conf

websocket: {
  port: 8800, // Web socket port
  no_tls: true // TLS true/false
}

Note

Not needed on this release.

Automator¶

Using a text editor, edit the configuration file and customize it for RequestHandler service.

Path: $LIKPI_HOME/conf/likpi-requesthandler.properties

# Request Handler target url i.e: vps-rh-myserver:6666
RequestHandler.url=tcp://<hostname>:<port>

# RequestHandler identifier i.e: localhost
RequestHandler.id=<automator_id>

# Hostname of Automator i.e: vps-auto-server
Host.name = <hostname>

# Central server database credentials (default port:5432)
main.dbdriver=org.postgresql.Driver
main.dburl=jdbc:postgresql://<vps-central-hostname>:<port>/<mydb>
main.dbuser=<postgresql-admin-user>
main.dbpwd=<password>

Note

To enable debug tracing, udpate file $LIKPI_HOME/conf/likpi-automator_logback.xml configuration file

level=”WARN” to level=”TRACE”

TrueCorrelation¶

Using a text editor, edit the configuration file and customize it for TrueCorrelation service.

Path: $LIKPI_HOME/conf/likpi-truecorrelation.properties

# Request Handler target url i.e: vps-rh-myserver:6666
RequestHandler.url=tcp://<hostname>:<port>

# RequestHandler identifier i.e: localhost
RequestHandler.id=<request_id>

# Hostname of TrueCorrelation i.e: vps-tc-server
Host.name = <hostname>

# Central server database credentials (default port:5432)
main.dbdriver=org.postgresql.Driver
main.dburl=jdbc:postgresql://<vps-central-hostname>:<port>/<mydb>
main.dbuser=<postgresql-admin-user>
main.dbpwd=<password>

truecorrelation.scheduleractivities.id=<scheduler_id>

Note

To enable debug tracing, udpate file $LIKPI_HOME/conf/likpi-truecorrelation_logback.xml configuration file

level=”WARN” to level=”TRACE”

SchedulerActivities¶

Using a text editor, edit the configuration file and customize it for SchedulerActivities service.

Path: $LIKPI_HOME/conf/likpi-scheduleractivities.properties

# Request Handler target url i.e: vps-rh-myserver:6666
RequestHandler.url=tcp://<hostname>:<port>

# RequestHandler identifier i.e: localhost
RequestHandler.id=<request_id>

# Hostname of SchedulerActivities i.e: vps-sa-server
Host.name = <hostname>

# Central server database credentials (default port:5432)
main.dbdriver=org.postgresql.Driver
main.dburl=jdbc:postgresql://<vps-central-hostname>:<port>/<mydb>
main.dbuser=<postgresql-admin-user>
main.dbpwd=<password>

# Number od threads
scheduleractivities.thread.count=1

# Timeout for activity
scheduleractivities.timeout.action=60

Note

To enable debug tracing, udpate file $LIKPI_HOME/conf/likpi-scheduleractivities_logback.xml configuration file

level=”WARN” to level=”TRACE”

Web Portal¶

In $LIKPI_PATH/webroot/js/config, there are 2 javascript files and 2 json files:

app.config.js > initializes the paths for the APIs and html pages in the application
i18next.config.js > initializes translations
restAPI.config.json > structures paths, APIs and serves as a resource to app.config.js
server.config.json > Web Portal configuration
Plublic key file location $LIKPI_PATH/webroot/security

Using a text editor, edit the configuration file server.config.json and customize it for Web Portal.

{
    "prog" : {
        "name" : "Likpi",
        "version"    : "v0.1.6"
    },
    "id": {
        "company" : "L.I.K.P.I.",
        "length"    : 9
    },
    "http": {
        "address" : "<hostname>", // Hostname where Web Server is running
        "port"    : "<port>",     // default port 8087
        "secure"  : "",           // "s" for secure
        "prefix"  : ""            // Url prefix string
    },
    "ws": {
        "address" : "<hostname>", // Hostname where Gateway Web Socket is running
        "port"    : "<port>",     // default port 8900
        "secure"  : "",           // "s" for secure
        "prefix"  : "nats"        // Internal settings
    },
    "security": {
        "publicKey" : "security/rsa_2048_pub.pem"  // Plublic key file
    },
    "log": {
        "enabled" : false,    // Enable or Disable the logs
        "pattern" :"%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p - %m%n"  // Timestamp format for the logs
    },
    "locale": {
        "lang" : "fr",
        "loadPath" :"locales/{{lng}}/{{ns}}.json",
        "dataTablesLoadPath" :"locales/{{lng}}/dataTables.json",
        "canvasJSLoadPath" :"locales/{{lng}}/canvasJS.json",
        "dateRangePickerLoadPath" : "locales/{{lng}}/dateRangePicker.json"
    },
    "dataFrameParam": {   // Below internal settings

        "noAggr": {
          "subscribeTo" : "",
          "xValueFmt" : "DD-MM-YY HH:mm:ss",
          "axisXDtFmt": "HH:mm",
          "axisXDtInterval": 0,
          "axisXDtIntervalType": "minute"
        },
        "aggrMinute": {
          "subscribeTo" : "MINUTE",
          "xValueFmt" : "DD-MM-YY HH:mm",
          "axisXDtFmt": "DD-MM-YY HH:mm",
          "axisXDtInterval": 0,
          "axisXDtIntervalType": "minute"
        },
        "aggrHour": {
          "subscribeTo" : "HOUR",
          "xValueFmt" : "DD-MM-YY HH:mm",
          "axisXDtFmt": "DD-MM-YY HH'h'",
          "axisXDtInterval": 0,
          "axisXDtIntervalType": "hour"
        },
        "aggrDay": {
          "subscribeTo" : "DAY",
          "xValueFmt" : "DD-MM-YY",
          "axisXDtFmt": "DD-MM-YY",
          "axisXDtInterval": 0,
          "axisXDtIntervalType": "day"

        },
        "aggrMonth": {
          "subscribeTo" : "MONTH",
          "xValueFmt" : "DD-MM-YY",
          "axisXDtFmt": "MMM YY",
          "axisXDtInterval": 1,
          "axisXDtIntervalType": "month"
        }
    },
    "dataValue": {
        "NumbertoFixed"     : 1
    }

}

Note

The file rest API.config.json is static and it reflects the services subjected by the core-manager service.

Web socket gateway with TLS¶

To enable TLS connection, please update the /opt/likpi/bin/likpi-wsgateway

From:

#!/bin/sh
appname="wsgateway"
IPADDR=`hostname -I | awk '{ print $1 }'`
pidfile=/opt/likpi/tmp/likpi-$appname.pid
nohup /opt/likpi/lib/ws-gateway-tcp -wsAddr=$IPADDR -noOriginCheck=true -trace=true >> /opt/likpi/log/likpi-$appname.out 2>&1 &
echo $! > $pidfile

To:

#!/bin/sh
appname="wsgateway"
IPADDR=`hostname -I | awk '{ print $1 }'`
pidfile=/opt/likpi/tmp/likpi-$appname.pid
nohup /opt/likpi/lib/ws-gateway-tcp -tls=true -tlsCert="/opt/likpi/security/httpcertificate.pem" -tlsKey="/opt/likpi/security/httpkey.pem" -tcpAddr=$IPADDR -noOriginCheck=true -trace=true >> /opt/likpi/log/likpi-$appname.out 2>&1 &
echo $! > $pidfile

Then restart likpi-wsgateway service.