Skip to content

View and download logs files from remote on-prem AEM instances

Notifications You must be signed in to change notification settings

YegorKozlov/aem-log-viewer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

AEM Log Viewer

Motivation

In the absense of Splunk users have two options to view/download logs of a running AEM instance:

  1. Copy logs from a remote AEM instance via scp.
  2. Use the WebTail plugin in OSGi System Console.

Both options are typically restricted, e.g. in AMS and developers have to ask admins to download logs files.

This tool provides centralized access to log files of your AEM environment. All you need is access to AEM Author instance where you can configure the hosts from which you want to grab log files.

Building

This project uses Maven for building. Common commands:

From the root directory, run mvn -PautoInstallPackage clean install to build the bundle and content package and install to a CQ instance.

Usage

In AEM Author go to Tools / E2E Tools / Log Viewer or navigate to http://localhost:4502/apps/e2e-tools/content/log-viewer/dashboard.html . Open the dashboard and click the Add button .

author

The URL is the address of an AEM instance from the host eye view, i.e. to access the logs files of self enter http://localhost:4502

To access the logs files of a publish instance enter its address:port. This is similar to how you configure replication agents. author

Click on a host to see the files in remote crx-quickstart/logs directory: author

How it works

The project uses the Apache Sling File System Resource Provider to mount crx-quickstart/logs in the operating system's file system to the /logs virtual tree in AEM. See org.apache.sling.fsprovider.internal.FsResourceProvider-logs.xml

With this configuration each instance can return its logs files as http://localhost:4502/logs/error.log, http://localhost:4502/logs/access.log etc. To get the catalog use http://localhost:4502/logs.-1.json

About

View and download logs files from remote on-prem AEM instances

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published