Information
  • Author: Appian Corporation
  • Type: Plug-in (Function & Smart Service)
  • Support: This plug-in or utility is not supported by the author. The content is free to use with a licensed product, but it is made available as-is and Community supported.
  • Industry: All Industries
  • Compatible Version(s): 22.2+, 24.1
  • First Released:
  • Last Updated:
  • Cost: Free
Share
Home » AppMarket » Log Reader

Log Reader

Overview

Plug-in Notes:

  • Allows only System Administrators or members of the Designers group to access log data.  
  • Does not load files outside the logs directory or files that do not end in .log.* or .csv.*.
  • On multi-application-server environments, logs will only be shown from a single application server.
  • Custom headers can be specified as an optional parameter. This is meant to be used for .csv files that don't contain a header.

Key Features & Functionality

The Appian Log Reader Plug-in contains functionality to:

  • Read files in the Appian /log folder (.csv or .log) and return them as structured data
  • Aggregate data from a .csv file
  • Serve as the source for a service-backed record for viewing logs
  • The Log Reader application provided with the download demonstrates a service-backed record for viewing logs, as well as reports on specific log files. Administrators can view reports on system health over time, including design best practices, system load, and database performance. The application also contains a process that checks details from system.csv and alerts administrators if memory or CPU utilization exceeds a threshold.
  • Tail a log file with tailcsv and taillog. Note that tail is an expensive operation which is optimized for reading the last few lines of a large log file. It's not advisable to tail the entire log file from the end to the beginning. However, tail will perform much better than the other log functions when reading the last few lines from a very large log file. Use the batch size and timestamp filters to limit the number of lines read by the tailcsv and taillog functions.
  • Takes a line of text in CSV format and returns a text array
Anonymous
Parents

  • Hello! We use this plugin on a very regular basis to scrape and maintain the history of certain logs so we can determine the health of our environment based upon internally-developed tools. We'd like to extend this to the process execution engines logs. However, those logs have dynamic names which include a date and a timestamp (for better or worse, we can argue that elsewhere...).

    Would it be possible to enhance this plugin to support a wildcard character in the filename itself? Alternatively, would it be possible to add a function that can get a directory listing of *.csv/*.log file names matching a search?  For example, I'd like all file names with "execution_by_category" in the name.

    It's possible to automate the scraping of process execution logs with no modifications to the plugin, but it takes a bit of brute force to determine the file names, which makes it quite a cumbersome to do at scale across dozens of engines / files.

Comment

  • Hello! We use this plugin on a very regular basis to scrape and maintain the history of certain logs so we can determine the health of our environment based upon internally-developed tools. We'd like to extend this to the process execution engines logs. However, those logs have dynamic names which include a date and a timestamp (for better or worse, we can argue that elsewhere...).

    Would it be possible to enhance this plugin to support a wildcard character in the filename itself? Alternatively, would it be possible to add a function that can get a directory listing of *.csv/*.log file names matching a search?  For example, I'd like all file names with "execution_by_category" in the name.

    It's possible to automate the scraping of process execution logs with no modifications to the plugin, but it takes a bit of brute force to determine the file names, which makes it quite a cumbersome to do at scale across dozens of engines / files.

Children
No Data
© 2025 Appian. All rights reserved.
We want to hear from you! Submit a review on Gartner or G2.