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

girishg0001 over 4 years ago

THe new version of this plugin works for multi-server installation on cloud. Please update the plugin notes accordingly
- Cancel
- Up 0 Down
- Reply
- More
- Cancel
arjunv489 over 4 years ago in reply to arjunv489

I missed to mention that we are in 20.2 version now.
- Cancel
- Up 0 Down
- Reply
- More
- Cancel
arjunv489 over 4 years ago

I recently observed an issue that some of the logs doesn't read any data. I was trying to read user logs and it returns the following.

[logName=/usr/local/appian/ae/logs/data-metrics/users.csv, totalCount=-1, rows=, headers=Timestamp; Total Users; Active Users; Active System Administrators]

Any idea of how to retreive the data?

Thanks,

Arjun.
- Cancel
- Up 0 Down
- Reply
- More
- Cancel
arjunv489 over 4 years ago in reply to erickp

Hi erickp I also face this issue, did you find a solution for this?
- Cancel
- Up 0 Down
- Reply
- More
- Cancel
Somnath Dey over 4 years ago in reply to Himanshu M

Please send me the env details at somnath.dey@appian.com.

If open the same log through suite you can see the actual node name , please use that
- Cancel
- Up 0 Down
- Reply
- More
- Cancel
Himanshu M over 4 years ago in reply to Somnath Dey

Thanks for reply. That means it should work in distributed environment now. If i have node for example "abc", then for reading the file say appian_functions_details.csv in perflogs folder i tried giving readcsvlog("abc/perflogs/appian_functions_details.csv"), but it doesn't work. Can you please give exact input i need to give for my use case here, so that i have a better understanding of it.
- Cancel
- Up 0 Down
- Reply
- More
- Cancel
Somnath Dey over 4 years ago in reply to Himanshu M

Hi,

It works same as old version. The only new feature is for HA environment where you can access logs from all nodes.just use node name in the relative path.
- Cancel
- Up 0 Down
- Reply
- More
- Cancel
Himanshu M over 4 years ago

I see this plugin was recently updated. Does this new version supports distributed environment? Is the old version still available? Are there any release notes for this new version, what exactly was added or updated?
- Cancel
- Up 0 Down
- Reply
- More
- Cancel
Andre Dessens over 4 years ago in reply to Mike Schmitt

For Appian Cloud installations, users with the proper authorization (e.g. anyone with Designer access) can access the logs for the whole environment from all the distributed app servers through the System Logs interface (i.e. <base_url>/suite/logs). You can navigate up in the logs directory to the /shared-logs folder. You can then drill down to the different app server log folders from there.

For On-Prem installations, users should reach out to the team responsible for their Appian instance (usually the IT department) to find out how they provide access to the logs.
- Cancel
- Up 0 Down
- Reply
- More
- Cancel
Mike Schmitt over 4 years ago

The readcsvlog() function doesn't seem to do anything with the headers parameter - can we expect this to ever be fixed?
- Cancel
- Up 0 Down
- Reply
- More
- Cancel