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

lorenzot0001 over 2 years ago in reply to chandimas0001

Hi chandimas0001 , ti seems to be working for us. We tried to retrieve design_errors.csv and we was able to do it. We used the following.

readcsvlogpagingwithheaders(
"serverName/design_errors.csv",
1,
100,
{},
"",
"",
"",
"Timestamp",
adddays(now(), -3),
now()
)

You will need to substitute serverName with your server name. In this way you will retrieve only the logs from serverName server, to retrieve the log for the others you need to substitute this with the other servers name, e.g. serverName-2 and serverName-3.

Just check what the rule getlogpath() responds. In our HA environment it responds "LOG_DIR : /usr/local/appian/ae/shared-logs".
- Cancel
- Up 0 Down
- Reply
- More
- Cancel
chandimas0001 over 2 years ago

Hi All

the plugin is failing to read logs for HA environments as the log path is different. for example the path for the login-audit.csv is at /usr/local/appian/ae/shared-logs/login-audit.csv oppose to /usr/local/appian/ae/logs/login-audit.csv.

any way we can use the plugin or any alternate way to read the logs?
- Cancel
- Up 0 Down
- Reply
- More
- Cancel
chandimas0001 over 2 years ago in reply to Gregor Gisler-Merz

thanks Gregor for the response, below is the expression

readcsvlogpagingwithheaders(
csvPath:"design_errors.csv",
startIndex: 1,
batchSize: - 1,

),
- Cancel
- Up 0 Down
- Reply
- More
- Cancel
ranjitjain over 2 years ago in reply to bihitakd0002

Are there any plans to update this plugin? so that it can support the tracking of site usage logs in 23.3 environment
- Cancel
- Up -1 Down
- Reply
- More
- Cancel
Gregor Gisler-Merz over 2 years ago in reply to chandimas0001

How do you try to read it? Can you be more precise?
- Cancel
- Up 0 Down
- Reply
- More
- Cancel
Gregor Gisler-Merz over 2 years ago in reply to bihitakd0002

The plugin has a problem with mixed log files. With Appian 23.3, there was a new field introduced, PageGroup, which was not there in the previous release for sites_usage.csv.

Rolling over the log file will most probably cure the issue.

If you are on-prem you can do it yourself. If on cloud open a support request and ask them to roll over the sites_usage.csv so that only the latest version is active with the additional group (no column mix).
- Cancel
- Up 0 Down
- Reply
- More
- Cancel
chandimas0001 over 2 years ago

Hi Team,

we are trying to read the csv file design_errors.csv using this plugin, however no data is returning. any reason why?
- Cancel
- Up 0 Down
- Reply
- More
- Cancel
narasimhaadityac6416 over 2 years ago in reply to trongq1674

Hi Trong Quan, we are also facing similar issue after upgrading to 23.3, Would you please let us know if you were able to get the issue resolved?
- Cancel
- Up 0 Down
- Reply
- More
- Cancel
narasimhaadityac6416 over 2 years ago in reply to bihitakd0002

Hi Team, we are also facing similar issue, Would you please let us know if you were able to get the issue resolved?
- Cancel
- Up 0 Down
- Reply
- More
- Cancel
bihitakd0002 over 2 years ago

Hi Team

Unable to read sites_usage.csv from path "audit/sites_usage.csv" using readcsvlog plugin, after Appian upgrade to 23.3 , however we were able to read audit/user_management.csv

This function is working on older version of Appian (23.2)

User management CSV

Site Usage CSV
- Cancel
- Up 0 Down
- Reply
- More
- Cancel