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 Comment Children
  • I am having the same issue and have not found a resolution as of yet.  Has anyone had any success implementing this on HA?

  • This is not working for me. When I try to give the server it always appends the path to "/usr/local/appian/ae/logs" and try to read the file from "/usr/local/appian/ae/logs/mysite-3/authz-audit.csv". As there is no such path we are not getting expected output. Can any one please let us know if any one is successful in reading a log file using this plugin in distributed environment.

  • On HA environments you need to specify the node name before the file name. Below is an example using Cloud node naming conventions:

    first sever:

    readcsvlogpaging(
      csvPath: "mysite/authz-audit.csv",
      startIndex: 1,
      batchSize: 10
    )

    second sever:

    readcsvlogpaging(
      csvPath: "mysite-2/authz-audit.csv",
      startIndex: 1,
      batchSize: 10
    )

    third sever:

    readcsvlogpaging(
      csvPath: "mysite-3/authz-audit.csv",
      startIndex: 1,
      batchSize: 10
    )