Configuring Elastic Search
The process of configuring Elastic Search to work with ProcessRobot is described below
Step 1: Open ProcessRobot.Server.exe.config from the installation folder, using a text editor.
Step 2: Remove the comments in the sections marked below.
<log4net debug="false"> <root> <level value="INFO" /> <appender-ref ref="sqlServer" /> <!-- uncomment to enable uploading logs to ElasticSearch --> <!--<appender-ref ref="LogElasticSearchAppender"/>--> </root> <logger name="Quartz" additivity="false" /> <!-- Uncommnet to enable uploading kpi to ElasticSearch --> <!--<logger name="KPILogger" additivity="false"> <level value="INFO" /> <appender-ref ref="KPIElasticSearchAppender" /> </logger>--> <!-- Wiki of log4net.ElasticSearch https://github.com/jptoto/log4net.ElasticSearch/wiki --> <!-- set bufferSize to 0 to upload to ElasticSearch immediately --> <!-- Appender to Log to ElasticSearch --> <!--<appender name="LogElasticSearchAppender" type="log4net.ElasticSearch.ElasticSearchAppender, log4net.ElasticSearch.Net40"> <connectionString value="Scheme=https;User=username;Pwd=password;Server=localhost;Index=prlog;Port=9200;rolling=false"/> <eventType value="log"/> <lossy value="false" /> <evaluator type="log4net.Core.LevelEvaluator"> <threshold value="ERROR" /> </evaluator> <bufferSize value="100" /> </appender>--> <!-- Appender to send KPI Entries to ElasticSearch --> <!--<appender name="KPIElasticSearchAppender" type="log4net.ElasticSearch.ElasticSearchAppender, log4net.ElasticSearch.Net40"> <connectionString value="Scheme=https;User=username;Pwd=password;Server=localhost;Index=prkpi;Port=9200;rolling=false"/> <eventType value="kpi"/> <lossy value="false" /> <evaluator type="log4net.Core.LevelEvaluator"> <threshold value="ERROR" /> </evaluator> <bufferSize value="100" /> </appender>-->
Step 3: The document should now look like the section above. Now replace the highlighted values with the ones that apply for your ElasticSearch installation.
Scheme: http or https depending on the server the installation is on
User: ElasticSearch Username.
Pwd: ElasticSearch Password.
Server: ElasticSearch Server Address (When on cluster do not use IP).
Index: The indices used to categorize records to Elastic and Kibana.
Port: ElasticSearch Port.
bufferSize: The amount of records that gets buffered before sent to Elastic (Set 0 for instant upload).
Step 4: After changing the above values, save the .config file as Administrator and restart ProcessRobot.Server Service.
Step 5: On Kibana’s Monitoring Page, turn on Monitoring.
Step 6: Use ProcessRobot to create logs or KPIs, which will automatically upload to Elastic, and navigate on the Kibana’s Management Page to create the Index Patterns matching the prkpi and prlog indices respectively.
 |