How To: Use the Analyse Plugin in Notepad++ to Review Logs

[SophiaF]

How-To

Use the Analyse Plugin to read logs in Notepad++

This plugin is used to highlight important/relevant information in log files. This plugin is available in Notepad++.

Procedure

Installation

In the Notepad++ menu go to Plugins > Plugin Admin and search for AnalysePlugin. Check the box on the left and click the Install button in the top right.

Note: The spelling uses the British English version of 'Analyse'
 

Using the plugin

1. First, open the log file you want to read in Notepad++.
2. Download the analyse template files (.xml files). These .xml files are the “error searching template” and there is currently one for Alteryx Server Service logs and Gallery logs.  See attached files at the end of this article.
3. Open the Analyse plugin window by clicking Plugins > AnalysePlugin > Show Analyse Dialog.
4. You now will see an additional window. Click the Load button > Load File and navigate to the .xml files provided.

idea Skyscrapers

5. Click the Search button which will process the template against the log file you have open. Please note this only searches the currently open file. If you want to search multiple files, open the file and then click Search again, and so on for all the files you want to read.

idea Skyscrapers
 

Viewing the results

 

You will see the results in the window at the bottom. Double-click any line to be taken there in the logs. You can also see the line numbers listed on the left.

idea Skyscrapers
 

Additional Information

You are welcome to make your own tweaks/additions to what you want these plugins to find, or how the results are presented. Here’s a rundown of how this works:

idea Skyscrapers
 

1. This is the string that is matching in the log lines. You can see there are multiple types of search, including regex, and you can also set things like case sensitivity and if a whole word should be matched.
2. This is the Comment field. Add information here so you know what this log line is showing you.
3. These are the main action buttons. Refer to the Help for the full documentation. Main buttons for customization are:
   1. Search - enter the string to search.
   2. Update – you MUST click update to apply your changes to the selected line.
   3. Save – allows you to save this as a .xml document that you can then Load or share.
4. The lines can be grouped so that you can distinguish between things like errors and general configuration settings.

Additional Resources

SourceForge - AnalysePlugin Project page

[RuGood]

Couldn't access the xml files directly, so went to the link below and downloaded the "analyse_v3_service.xml" and  "analyse_v3_gallery.xml"

https://alteryx0.sharepoint.com/sites/CustomerSuccessHub/Support%20Library/Forms/AllItems.aspx?id=%2...