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
  • in reply to adityab0524

    Hi Aditya

    It depends whether you have HA or a normal Install.
    In a single node installation the csvPath: "perflogs/web_api_details.csv" works form me. So the full path would then be "/usr/local/appian/ae/logs/perflogs/web_api_details.csv".
    In case of a HA setup you would need to add the node name as well e.g., acme.appiancloud.com would be the following csvPath: "acme/perflogs/web_api_details.csv". In this case the full path would be     /usr/local/appian/ae/shared-logs/acme/perflogs/web_api_details.csv. Instead of logs we have in this case shared-logs which will be added by the plugin.

  • I am using readcsvlog(csvPath:"myPath") in return it appends "/usr/local/appian/ae/logs/" to my path in the begining which gives me wrong result, what should i do to fix it.

  • Hello,


    We have configured the Appian environment in HA and in order to access the logs, we have seen in some comments that it has to be done by putting the server prefix in the log path.


    Is there any way to extract all the log data from the different servers in HA?


    We need to be able to read directly from the log without putting any server in the path to have all the updated information.


    Thank you very much

  • Hello,

    I'm trying to use this plugin to get values from records_usage.csv in the context of our GDPR solution. I can read the file with readcsvlog but filter on Timestamp seem not working. When I run this:

    readcsvlog(
        csvPath: "/audit/records_usage.csv",
        timestampColumnName:"Timestamp",
        timestampStart: a!subtractDateTime(startDateTime: today(), days:100),
        timestampEnd: today()
    )

    The function return 0 row.

    Other filter works, for example:

    readcsvlog(
       csvPath: "/audit/records_usage.csv",
       filterColumName:"Timestamp",
       filterOperator:"startsWith",
       filterValue:"1 Feb 2023"
    )

    But my goal is retrieve a periode and this kind of filter doesn't support "Between"

    Regards

    Jean-Alain

  • Good day. For one of our client`s requirement, we are trying to extract the data admin logs from the .log files by using this plug-in. We are ale to extract the data logs from the main file "rdbms-audit.log.yyyy-MM-dd" however we are not able to extract from the extension files of the main file like  "rdbms-audit.log.yyyy-MM-dd.1", "rdbms-audit.log.yyyy-MM-dd.2" etc

    Request your support/guidance on the above challenge. Thank you.

  • in reply to Mike Schmitt

    At this point, this plug-in seems pretty much abandoned.  Any additional feedback here would be appreciated.

  • in reply to rameshg0007

    I am having the same issue and have not found a resolution as of yet.  Has anyone had any success implementing this on HA?

  • Hi, is this plugin compatible with version 22.3 ?

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