Skip to content

Latest commit

 

History

History
93 lines (70 loc) · 3.83 KB

README.md

File metadata and controls

93 lines (70 loc) · 3.83 KB
Raw

Filter Trace

Overview

This project was designed as a troubleshooting tool to analyze system trace log files consisting of captured communication between Extron device drivers and various third-party devices. Because these files include communication of all devices within a system, they can be time-consuming and challenging to follow. This application isolates relevant data for focused troubleshooting by outputting a filtered trace file based on user-specified keywords, which allows users to more easily zero in on specific data to pinpoint driver or device-related issues.

Description

An intuitive GUI-based Python application allowing a user to easily extract data from a file based on specific keywords to generate a focused output file.

Features

  • Ability to specify single or multiple keywords to search
  • Option to select case sensitivity of keywords
  • Line number references to the original file
  • User-friendly message boxes and tooltips to guide users step-by-step

Download latest released version here

Usage

GUI Initialize

Path field:

GUI Path field

  • Specifies the path of the file to search.

Keywords field:

GUI Keywords field

  • Specifies the keyword(s) to search for within the file.

Separator field:

GUI Keywords and Separator fields

  • Used to differentiate multiple keywords from one another.

Case Sensitive checkbox:

GUI Case Sensitive checkbox

  • Specifies the case sensitivity of keywords.

Generate button:

GUI Generate button

  • Outputs a text file consisting of only the lines that contain keywords.
  • The Enter key can also be used to generate the file.

Version label:

GUI Version label

  • Shows the current version of the application.

File Generated successfully:

MsgBox File Generated

  • Indicates the file was generated successfully (e.g., trace (filtered).txt)

Examples

Single keyword:

GUI Example with single keyword

  • Separator field not required.

Multiple keywords:

GUI Example with multiple keywords

  • In this example, a comma is used to differentiate the 'COM02' keyword from the 'Com2' keyword.

Error Messages

Missing path field:

MsgBox Missing path

  • Indicates the Path field is empty.

Invalid path field:

MsgBox Invalid path

  • Indicates the Path field contains an invalid file path.

Missing Keywords field:

MsgBox Missing keywords

  • Indicates the Keywords field is empty.

Missing separator in Keywords field:

MsgBox Missing separator in keywords

  • Indicates a separator was not found in the Keywords field.

No keywords found:

MsgBox No keywords found

  • Indicates no keywords were found within the file.

No file data found:

MsgBox No file data found

  • Indicates the file is empty.

Unable to read file content:

MsgBox Unable to read file content

  • Indicates the Path field points to a file that cannot be read, either because the file type is unsupported, or the file data is corrupted.

Dependencies

  • Python 3.6 or above
  • PySimpleGUI 4.60.5
  • Windows

License

Licensed under the MIT License