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

Jason Ruvinsky over 3 years ago

The description mentions that this plugin can "Serve as the source for a service-backed record for viewing logs"; however when I attempted to configure a service-backed record type for viewing a log, I received the following error: "The Record Data Source cannot use plugins, query rules, or any of the following functions: query, queryEntity, queryProcessAnalytics, queryRecord, queryRecordType, executeStoredProcedureForQuery, executeStoredProcedureOnSave."

Also, is there documentation on how to use the various functions included in this plugin? I couldn't find any documentation included in the download. Thanks!
- Cancel
- Up +1 Down
- Reply
- More
- Cancel
vishnud126275 over 3 years ago

Hi Mark, we have used this plugin in our application. In light of the recent discovery of vulnerabilities with log4j2, we would like to know if this plugin uses the affected version Log4j2, and if yes, would you release an updated version of this plugin to counter the exploit of vulnerability?
- Cancel
- Up +1 Down
- Reply
- More
- Cancel
pauls0010 over 3 years ago

Implemented the plugin to create a dashboard based on the reports and all ok, until we deployed on Production.
After deployment, we are getting intermittent error for all the users that have access of The function 'readcsvlogpagingwithheaders' is unavailable.

Interestingly, it works for the user one day then fails the next and I can't see a pattern to it.
- Cancel
- Up 0 Down
- Reply
- More
- Cancel
KrishnaElsevier over 3 years ago

Hello,

Cloud 3 server production distributed environment, 'readlog' plugin is not reading any log file(s), At least it reads from default server that makes my job easier. Any suggestions?
- Cancel
- Up 0 Down
- Reply
- More
- Cancel
Michael Tremblay over 3 years ago

Hi Mark Talbot, Hi Somnath Dey,

Do you think it will soon be possible to read the logs from distributed systems ?

We got 3 nodes here, and we cannot read on "2" and "3".

Thanks in advance
- Cancel
- Up 0 Down
- Reply
- More
- Cancel
Venkatesh Suram over 4 years ago

Hi Everyone,

Is this Plugin able to read logs from High Availability server?.

Thanks!
- Cancel
- Up +1 Down
- Reply
- More
- Cancel
charialk0001 over 4 years ago in reply to charialk0001

Mark Talbot
- Cancel
- Up 0 Down
- Reply
- More
- Cancel
charialk0001 over 4 years ago

Does this plugin works in On-premise environment ?
- Cancel
- Up 0 Down
- Reply
- More
- Cancel
Angel Rangel(Vanguard) over 4 years ago in reply to johng0005

Maybe if you pass the parameter as: "/usr/local/appian/ae/shared-logs/../logs/login-audit.csv" to land in the actual file.
- Cancel
- Up 0 Down
- Reply
- More
- Cancel
jeffh0004 over 4 years ago in reply to johng0005

Hi johng0005, no we never saw anything so assumed it was not possible. Please advise.
- Cancel
- Up 0 Down
- Reply
- More
- Cancel