Log Template
Last updated
Last updated
Log template is a type of template which is used for doing log analysis. User can create a Log Template while adding a Verification Gate to the application. To create a log template follow the steps below:
User can add the Verification Gate after creating a pipeline for the selected application.
To create an application, refer here.
To create a pipeline, refer here.
After creating a pipeline, go to Pipelines page, click Configure and select the required pipeline. Click Add Stage.
Click Type dropdown and select Verification Gate from the drop down menu.
After selecting Verification gate, the following options appear. In the Template Configuration section, click Create next to the Log Template field.
The Log Template page appears as shown below:
This Log template is independent of the data sources created. There can be multiple data sources. But for individual projects there can be individual log templates.
In the above page enter the details as shown below:
The log template consists of three sections as follow:
Log Provider
Enter the Log Template Name in the text box.
In the Logs Monitoring section, select a monitoring tool from the Provider drop-down. Based on the selection there will be new options added.
The following monitoring tools are available to be selected.
In this example, Elastic Search is selected. Once selected, the related options are displayed as shown in the image below:
The various options that appear as per the selected monitoring tool are:
Log Account - Account of the log provider. Select the Log Account from the drop-down. This list will appear based on the accounts created in the data source under the selected monitoring tool.
Index Pattern - The index pattern that contains logs for processing.
Query Filter Key - The unique key that identifies the logs to be processed in the Index.
Baseline - The unique value that identifies the baseline logs in the Index.
New Release - The unique value that identifies the new release logs in the Index.
Response Keywords - The field name in the index that contains the logs to be processed.
Timestamp Key (Optional) - The unique key that identifies the timestamps for the logs.
Sensitivity - The impact of unexpected issue on the log scoring.
Scoring Algorithm - The type of scoring algorithm you prefer for the log analysis.
Log group - The log group name stream that shares the same settings.
Log stream - The log events sequence name that shares the same source.
Region - The geographical area to be selected, where the AWS data centre is located.
Stream ID - The stream ID to which you want your messages to be routed.
Sensitivity - The level of warning or error. Level of sensitivity can be selected from the drop-down. For example - If the sensitivity is high any error or warning will be considered as highly sensitive and the penalty in the final risk score will be more. If medium or low, the penalty in the risk score will be moderate or low respectively.
Once you enter details for the required fields, Click Next.
Log Topic
The Log Topic screen appears as shown below:
The Log Topic screen is where the intelligence is provided to the application. Here we have listed some of most common errors in the industry and categorized them as Critical, Error, Warn and Ignore. The categorization has been done based on industry standards. For example - OutofMemoryError is a common error and is Critical. Also option is provided to change the category based on your requirements.
In the above screen you can do the following:
Click the Characterization Topic drop-down to change the category of the error. For example, you can set the OnOutOfMemoryError to WARN from CRITICAL. Refer to the image below:
Click the Delete icon to delete a string pattern as shown below:
Click the + icon to add a new log topic as shown below:
Once you click the icon, a new row will be added with the type as custom. Enter the string and set the category as shown below:
Click Next.
Log Tags
The next screen, Log Tags appears. As a user, you might want to give some business logic related input to the analysis. The Log tags helps you to do the same. In this screen you can set the Scoring Algorithms and the cluster tags. Issues like Infrastructure, build error, etc. can be pre-define them in this screen. Refer to the image below:
To add a scoring algorithm, click the Scoring Algorithm drop-down and select the type of algorithm as shown below:
There are 4 types of algorithms. They are:
To add a cluster tag, follow the steps below:
Enable Cluster Tag radio button as shown below:
Click the plus icon to add a tag. Enter the name of the tag and click Save Tag. Refer to the image below:
The created tag will now appear on the select list. Select the tag as shown below:
Click the + icon to add a new cluster tag string as shown below:
Once you click the icon, a new row will be added. In the above screen, select the tag as Build Error and enter the Cluster Tag String in the text box.
Click Submit.
Once the Log Template is created it will appear in the list while configuring a verification gate as shown below:
