This guide describes how to install the yuuvis® RAD metrics-manager.
...
- core-service
- Navigate to the logging configuration of the REST-WS gui page at http://<gateway>/rest-ws/#PAGE:monitor/logging
Set the logger "com.os.ecm.ws.metrics" to the log level "TRACE".
Make sure that "use parent handler" is not checked.- The change takes immediate effect.
- service-manager
- Edit the file <service-manager>\config\application-prod.yml
- Set the parameter "monitoring.trace.enabled" to true
- Save the file and restart the service-manager
...
Elastalert2 (optional)
If you chose to use elastalert2 Elastalert2 to receive e-mail/Teams notifications about critical and error situations, these are the predefined rules that trigger an alert :
...
- For Kibana a SSL/TLS certifcate in .cer / .crt and .key format is required. Place these two files in the
<mertrics-manager>\config
folder - Open the
<metrics-manager>\config\kibana.yml
file for editing- Uncomment the following three lines and replace
certificate.cer
andcertificate.key
with the file names of your certificate filesserver.ssl.enabled: true
server.ssl.certificate: ../../../config/certificate.cer
server.ssl.key: ../../../config/certificate.key
- Find the below lines and replace the hostname with the exact hostname defined in the certificate
server.host: "metrics.optimal-systems.de"
server.name: "metrics.optimal-systems.de"
- Find the below line and change the protocol from http to https:
server.publicBaseUrl: "https://metrics.optimal-systems.de:5601"
Note: Do the following only if you're also enabling HTTPS for elasticsearch: - Find the below line and change the protocol from http to https:
elasticsearch.hosts: ["https://metrics.optimal-systems.de:5200"]
- Find the below line and uncomment it. If the used certificate is self-signed, set the value to
none
, otherwise leave it atfull
elasticsearch.ssl.verificationMode: none
- Uncomment the following three lines and replace
- Save the file and restart Kibana. It is now accessible via
https://metrics.optimal-systems.de:5601
. - For ElastAlert2 to generate links to the new HTTPS address, edit the file
<metrics-manager>\config\elastalert\elastalert.yaml
file and set the URL of theparameter 'kibana_discover_app_url:'
parameter to a) use HTTPS and b) use the hostname defined in the certificate instead of an IP address. - If you already have a certificate in .p12 format (for example for the gateway microservice) then you can generate the .cer and .key certificate files using the Keystore Explorer tool by the following steps:
- Open the .p12 certificate in the Keystore Explorer.
- Right click on the certificate and choose Export → Export certificate chain. This will create the .cer file
- Right click on the certificate and choose Export → Export private key. Choose PKCS #8 as the format. In the following dialog uncheck encryption. This will generate the .key file.
- These files can also be use for Logstash (see below).
Elasticsearch
To enable HTTPS in elasticsearch, a certificate in .p12 format (the same as for the gateway microservice) can be used. If Elasticsearch is set to HTTPS communication, the configuration of Kibana, Logstash and ElastAlert2 needs to be changed so that https is used for communication with Elasticsearch. This can be done by following the below steps:
...