System information service

Overview
Set up the System information service
System information Service APIs

Overview

System information service provides detailed information about AEM forms environment, such as properties, logs, and installation details. It uses REST APIs to retrieve information. You can retrieve following information with system information service:

System properties
Content of the config.xml file
Environment variable of host machine
Status of the services
Vital system information, such as JVM arguments, OS version, and heap size
Core settings such as Temporary directory, fonts directory, and GDS root
Database information
License information
Application server configuration files
Count and stack trace of active threads
Log files

Important: The System information service does not extract or transmits passwords or any other confidential information.

Set up the System information service

The system information service provides REST APIs to retrieve information. To use the system information service, enable the REST endpoint from administration console. Perform the following steps to enable the REST endpoint:

Log in to administration console. The default URL of administration console is http://[hostname]:[port]/adminui.
Navigate to Services > Applications and Services > Service Management.
On the Service Management page, click the SystemInfo service.
In the list on the Endpoints tab, select REST, and click Add .
On the Add REST Endpoint screen, click Add .

System information Service APIs

The system information service provides a set of REST APIs to retrieve information. The following table provides detailed information about the APIs:

Name	URL	Descrption
SystemInfo.properties	http://[server]:[port]/rest/services/SystemInfo.properties	This API is a wrapper for system.getProperties Java API. It retrieves configuration of the current working environment.
SystemInfo.envVar	http://[server]:[port]/rest/services/ SystemInfo.envVar	Retrieves all the environment variables of the host operating system.
SystemInfo.logs	http://[server]:[port]/rest/services/ SystemInfo.logs	Downloads a zip file that contains application server logs.
SystemInfo.config	http://[server]:[port]/rest/services/ SystemInfo.config	Retrieves all the content of the config.xml file.
SystemInfo.services	http://[server]:[port]/rest/services/ SystemInfo.services	Retrieves status and configuration parameters of AEM forms services.
SystemInfo.vitalDetails	http://[server]:[port]/rest/services/ SystemInfo.vitalDetails	Retrieves server uptime, JVM arguments, system memory, heap size, operating system name, number of active threads, and thread count.
SystemInfo.coreSettings	http://[server]:[port]/rest/services/ SystemInfo.coreSettings	Retrieves values of following properties: AdobeTempDir AdobeServerFontDir CustomerFontDir GlobalDocumentStorageRootDir DefaultDocumentMaxInlineSize DefaultDocumentDisposalTimeout EnableDocumentDBStorage GlobalDocumentStorageUseNetworkShare EnableFIPS EnableWSDL DataServicesConfigFile EnableRDS
SystemInfo.database	http://[server]:[port]/rest/services/ SystemInfo.database	Retrieves detailed information about the database.
SystemInfo.licenseInfo	http://[server]:[port]/rest/services/ SystemInfo.licenseInfo	Retrieves version and license information of installed AEM forms components.
SystemInfNo.serverConfig	http://[server]:[port]/rest/services/ SystemInfo.serverConfig	Downloads configuration files of the host application server.
SystemInfo.threads?delay=[n]&iterations=[n]	http://[server]:[port]/rest/services/ SystemInfo.threads?delay=[n]&iterations=[n]	Retrieves count and stack trace of active threads. It accepts following parameters: iterations= [n]: Specifies the count of iterations. Replace n with a number. Delay= [n]: Specifies the number of milliseconds to wait before starting the next iteration.
SystemInfo.info	http://[server]:[port]/rest/services/ SystemInfo.info	This API is a wrapper for all of the system information service APIs. Internally, it runs all system information APIs and downloads information in zip format. Note: The SystemInfo.info does not provide count and stack trace of active threads.