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

  • Hi All,

    After our on premise environment upgrade to 20.4 version, readcsvlogpagingwithheaders() is not working as expected.

    Whenever we are giving header attribute along with filter options, we get output as null. Below is the code snippet:

    readcsvlogpagingwithheaders(
    csvPath: cons!SC_AUDIT_FILEPATHS[1] & if(
    local!date = today(),
    null,
    "." & datetext(
    local!date,
    "yyyy-MM-dd"
    )
    ),
    startIndex: 1,
    batchSize: - 1,
    headers: {
    "loggedInTime",
    "loggedInUser",
    "attempt",
    "ipAddress",
    "source",
    "agent"
    },
    filterColumName: "source",
    filterOperator: "=",
    filterValue: "Portal",
    timestampColumnName: null,
    timestampStart: null,
    timestampEnd: null
    )

    Any suggestions to resolve this issue?

    Thanks.

Comment

  • Hi All,

    After our on premise environment upgrade to 20.4 version, readcsvlogpagingwithheaders() is not working as expected.

    Whenever we are giving header attribute along with filter options, we get output as null. Below is the code snippet:

    readcsvlogpagingwithheaders(
    csvPath: cons!SC_AUDIT_FILEPATHS[1] & if(
    local!date = today(),
    null,
    "." & datetext(
    local!date,
    "yyyy-MM-dd"
    )
    ),
    startIndex: 1,
    batchSize: - 1,
    headers: {
    "loggedInTime",
    "loggedInUser",
    "attempt",
    "ipAddress",
    "source",
    "agent"
    },
    filterColumName: "source",
    filterOperator: "=",
    filterValue: "Portal",
    timestampColumnName: null,
    timestampStart: null,
    timestampEnd: null
    )

    Any suggestions to resolve this issue?

    Thanks.

Children
  • in reply to Mike Schmitt

    Thanks Mike. Additional column was the issue. There was an extra attribute after upgrade.

  • in reply to hiteshd

    Download the log file in question and look back through the historical data (assuming it might be one that spans multiple days) and check whether the amount of columns has increased since the 20.4 update.  As I mentioned in some older posts here, when the number of columns is inconsistent, the function fails.  As mentioned, you can try the new "tail" functions which should read the most recent row(s) from the log file and that would bypass this issue.

    If the log file you're trying to read is the type that's rolled over on a daily basis, on the other hand, I'd still start out by downloading one of the current files, but this time maybe just check that its columns are still the ones you're trying to reference in your query.  I'm not clear which log file you're looking at since I don't know what's in your cons!SC_AUDIT_FILEPATHS constant.

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