App42 PaaS - Java & Groovy Cloud SDK -Logging API

Java and Groovy Cloud SDK

Log

Centralize logging for your App. This service allows different levels e.g. info, debug, fatal, error etc. to log a message and query the messages based on different parameters. You can fetch logs based on module, level, message, date range etc.

Info
Debug
Fatal
Error
Fetch Logs By Module
Fetch Logs Count By Module
Fetch Logs By Module (Paging)
Fetch Logs By Module And Text
Fetch Logs Count By Module And Text
Fetch Logs By Module And Text(Paging)
Fetch Logs By Info
Fetch Logs Count By Info
Fetch Logs By Info (Paging)
Fetch Logs By Debug
Fetch Logs Count By Debug
Fetch Logs By Debug (Paging)
Fetch Logs By Error
Fetch Logs Count By Error
Fetch Logs By Error (Paging)
Fetch Logs By Fatal
Fetch Logs Count By Fatal
Fetch Logs By Fatal (Paging)
Fetch Log By Date Range
Fetch Log Count By Date Range
Fetch Log By Date Range (Paging)

In order to use the various functions available under a particular API, a developer will have to create an instance of ServiceAPI by passing the apiKey and the secretKey which has been received while creating an app.

	ServiceAPI api = new ServiceAPI("<API_KEY>","<SECRET_KEY>");

After initialization, developer needs to call the buildXXXService method on ServiceAPI instance to get the instance of the particular API that you wish to build. For example, To build an instance of LogService, buildLogService() method needs to be called.

	LogService logService = api.buildLogService();

Once the API instance has been retrieved, You are ready to use the functions available for that particular API.

The methods available under a particular API will return the domain object (like Log in this case) as a response which will have the accessor / mutator to access the available properties for that object. You can get the response in the form of JSON as well. We have provided the JSON response with every function detail which can be retrieved by calling the toString() on the returned object.

String msg = "Info logs";
String module =	"testmod";					

Log log = logService.info(msg,module);   /* returns the Log object. */ 
ArrayList<Log.Message> messageList =  log.getMessageList();
for(Log.Message message : messageList)
{    
    System.out.println("msg is " + message.getMessage());
	System.out.println("module is " + message.getModule());
	System.out.println("type is " + message.getType());
	System.out.println("logTime is " + message.getLogTime());
}   
String jsonResponse = log.toString(); /* returns the response in JSON format. */

The functions available under Logging API can throw some exceptions in abnormal conditions. Example of the same has been given below.

E.g. If App developer is requesting the logs for the module which is not in the database, the function will throw the App42Exception (as shown below) with message as "Not Found" and the appErrorCode as "2700" and the details as "Logs for the module '<module>' does not exist".

String moduleName =	"testmod";	 

try
{
	Log log = logService.fetchLogsByModule(moduleName);
}
catch(App42Exception ex) 
{
	int appErrorCode = ex.getAppErrorCode();
	int httpErrorCode = ex.getHttpErrorCode();
	if(appErrorCode == 2700)
	{
		// Handle here for Not Found (Logs for the module '<module>' does not exist.)
	}
	else if(appErrorCode == 1401)
	{
		// handle here for Client is not authorized
	}
	else if(appErrorCode == 1500)
	{
		// handle here for Internal Server Error
	}	
	String jsonText = ex.getMessage(); /* returns the Exception text in JSON format. (as shown below)*/	
}

	{
		"app42Fault": {
			"httpErrorCode": 404,
			"appErrorCode": 2700,
			"message": "Not Found",
			"details": "Logs for the module 'testmod' does not exist"
		}
	}

Below are the HTTP Error Codes and their description, the function under the Logging API can throw.

/*
1400 - BAD REQUEST - The Request parameters are invalid
1401 - UNAUTHORIZED - Client is not authorized
1500 - INTERNAL SERVER ERROR - Internal Server Error. Please try again	
*/

Below are the Application Error Codes and their description, the function under the Logging API can throw.

/*
2700 - NOT FOUND - Logs for the module '<module>' does not exist.
2701 - NOT FOUND - Logs for the type '<type>' does not exist.
2702 - Not Found - Logs betweem startDate '<startDate>' and endDate '<endDate>' does not exist.
2703 - NOT FOUND - Logs for the module '<module>' with text '<text>' does not exist.
2704 - NOT FOUND - The number of logs for the module '<module>' are less than the specified offset : <offset>.
2705 - NOT FOUND - The number of logs for the module '<module>' are less thanThe number of logs for the type '<type>' are less than the specified offset : <offset>.he specified offset : <offset>.
2706 - NOT FOUND - The number of logs betweem startDate '<startDate>' and endDate '<endDate>' are less than the specified offset : <offset>.
2707 - NOT FOUND - The number of logs for the module '<module>' with text '<text>' are less than the specified offset : <offset>.
*/

Various functions available under Logging API has been explained below.

Info