monitor-analytics Web App setup

Deploying the webapp

To install the webapp of service.monitor Analytics deploy the given war-file from [CD-CONTENTS]/software/analytics/web/monitor-analytics.war to the Servlet Container that shall be used.

To change the default configuration values, copy the application.properties file found at \monitor-analytics\WEB-INF\classes\custom-application.properties to [data.directory.location]/application.properties, change the necessary values and restart the Servlet Container or reload the context.

This may be required if Elasticsearch runs on another host than http://localhost:9200. In this case, the service URL has to be configured to connect the webapp with Elasticsearch. Also, if Elastic requires username and password for access, credentials can be configured here.

application.properties
analytics.elasticsearch.service.url=http://myserver:9200/analytics-*/_search
analytics.elasticsearch.service.user=<user>
analytics.elasticsearch.service.pwd=<password>

It is also possible to change the license directory by setting the property analytics.license.dir

See \monitor-analytics\WEB-INF\classes\default-application.properties for an overview of the default values of the used properties.

The service.monitor Analytics webapp provides a security layer to secure queries against the Elasticsearch indices. To protect the loggend data against unwanted access, it is HIGHLY RECOMMENDED to change the properties

  • security.user.admin.name

  • security.user.admin.pw

and use a hash algorithm to encrypt it by setting the property security.user.pwenc to one of MD5 | SHA-1 | SHA-256 | SHA-384 | SHA-512

Note, that security.user.admin.pw then stores the encrypted password, e.g

security.user.pwenc=SHA-256
security.user.admin.pw=b18474123c790f30c300b6bb9ee146a4959b6bcd5eef20244b925d69ea996690

If the Logstash service is installed on a different host than localhost, it is necessary to configure it in the application.properties and connect it to the Logstash service.

application.properties
analytics.gelf.server=myserver.domain.de
analytics.gelf.port=12201

It is also possible to change the port, on which outgoing log messages are send. If the port is changed in the application.properties file, it is also necessary to change the listening port in the Logstash configuration at [CD-CONTENTS]/software/analytics/elasticsearch/logstash/pipelines/ct-analytics/logstash-analytics-100-input.conf and open the port to receive messages.

After any configuration changes, the related component should be restarted.