Log Template

This is an older version of the document. To view the most recent version of the document, click here.

Log template is a type of template which is used for doing log analysis. You can create a Log Template while adding a service to the application. To create a log template follow the steps below:

  1. On the application dashboard, click the Add Application button as shown below:

2. The application details form appears as shown below:

3. In the above form after adding the application details you need to add the services. To know more on how to add an application click here.

4. After you add the application details, you need to add the services to the application. Enter the Service Name in the text box and click Save as shown below:

5. Next, you get the option to select the type of service you want to add. The options are:

  • Deployment Verification

  • Visibility

  • Release Management

Refer to the image below:

6. To add a log template select Deployment Verification. The following options appear:

7. The New Log Template form 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 form you can do the following:

Log Provider

  • Enter the Log Template Name in the text box.

  • Select the provider from the Logs Monitoring drop-down. Based on the selection there will be new options added. In this example, we will select Elastic Search. Once selected, the new options are shown in the image below:

  • Select the Log Account from the drop-down. This list will appear based on the accounts created in the data source under elastic search. To know more on how to create data sources click here.

  • Enter the Filter Key in the text box.

  • Enter the Baseline in the text box.

  • Enter the Index Pattern in the text box. This field is specific for elastic search.

  • Select the Custom regular expression filter Required. This feature helps you to user regular expression to create custom filters. Once selected tow new fields appear.

    • Enter the Regular Expression in the text box.

    • Select the Response Key from the drop-down. Refer to the image below:

5. Click the Auto Baseline check box to enable the feature in log analysis. It is an ML based learning of the baseline from the historic analysis.

6. Select the Level of Sensitivity from the drop-down. Sensitivity means the importance of warning or error. 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.

7. Click Next.

Log Topic

After clicking Next, the Log Topic screen appears as shown below:

In 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 show stopper. We have also provided the option for you to change the category based on your requirements.

In the above screen you can do the following:

  1. Click the Characterization Topic drop-down to change the category of the error. So for example, you can set the OnOutOfMemoryError to WARN from CRITICAL. Refer to the image below:

2. Click the Delete icon to delete a string pattern as shown below:

3. Click the + icon to add a new log topic as shown below:

4. 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:

5. Click Next.

Log Tags

After you click Next, the Log Tags screen 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. you can 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:

  1. Enable Cluster Tag radio button as shown below:

2. Click the plus icon to add a tag. Enter the name of the tag and click Save Tag. Refer to the image below:

3. The created tag will now appear on the select list. Select the tag as shown below:

4. 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.

5. Click Submit.

Once the Log Template is created it will appear in the list while adding a service for an application as shown below:

Last updated