org.wso2.carbon.logging.service.provider.api

Interface LogProvider

All Known Implementing Classes:

InMemoryLogProvider

public interface LogProvider

This interface should be inherited by all the log providers, This will allow you to plug any log provider to carbon server. Carbon log viewer will use this interface to get the LogEvents and show it on Log View UI.

use logging-config.xml file to provide all the configuration which is required to initialized the log provider implementation for an example, cassandra base log provider need to know about keyspace, column family , etc ... You can configure these details in logging-config.xml file and access using LoggingConfig class which contain all configuration parameter at runtime.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	clearLogs() Do clear operation, eg: if it is a in memory log provider then this can be used to clear the memory.
List<LogEvent>	getAllLogs(String tenantDomain, String serverKey) Return a list of all the logs available under given domain and server key
List<String>	getApplicationNames(String tenantDomain, String serverKey) Return a list of all application names deployed under provided tenant domain and server key
List<LogEvent>	getLogs(String type, String keyword, String appName, String tenantDomain, String serverKey) Returns a list of all LogEvents related to the given application, which match to given type and LogEvent message has given key word with it.
List<LogEvent>	getLogsByAppName(String appName, String tenantDomain, String serverKey) Return a list of all the LogEvents belongs to the application, which is deployed under given tenant domain and server key.
List<LogEvent>	getSystemLogs() Return a list of system LogEvents
void	init(LoggingConfig loggingConfig) Initialize the log provider by reading the property comes with logging configuration file This will be called immediately after creating new instance of LogProvider
int	logsCount(String tenantDomain, String serverKey) Return LogEvent count.

Method Detail

init

void init(LoggingConfig loggingConfig)

Initialize the log provider by reading the property comes with logging configuration file This will be called immediately after creating new instance of LogProvider

Parameters:

loggingConfig -

getApplicationNames

List<String> getApplicationNames(String tenantDomain,
                               String serverKey)
                                 throws LogViewerException

Return a list of all application names deployed under provided tenant domain and server key

Parameters:

tenantDomain - - Tenant domain eg: t1.com

serverKey - - Server key

Returns:

- string List which has all application names, empty String List if there is no application registered under given tenant domain and server key

Throws:

LogViewerException

getSystemLogs

List<LogEvent> getSystemLogs()
                             throws LogViewerException

Return a list of system LogEvents

Returns:

- List of LogEvent , null if no system LogEvents available.

Throws:

LogViewerException

getAllLogs

List<LogEvent> getAllLogs(String tenantDomain,
                        String serverKey)
                          throws LogViewerException

Return a list of all the logs available under given domain and server key

Parameters:

tenantDomain - - Tenant domain eg: t1.com

serverKey - - server key

Returns:

- List of all LogEvents available under the tenant domain and server key. empty LogEvent array if there is no LogEvents available.

Throws:

LogViewerException

getLogsByAppName

List<LogEvent> getLogsByAppName(String appName,
                              String tenantDomain,
                              String serverKey)
                                throws LogViewerException

Return a list of all the LogEvents belongs to the application, which is deployed under given tenant domain and server key.

Parameters:

appName - - application name

tenantDomain - - Tenant domain eg: t1.com

serverKey - - Server key

Returns:

all the LogEvents belongs to the application, which is deployed under given tenant domain and server key, return empty LogEvent array if there is no such LogEvents available.

Throws:

LogViewerException

getLogs

List<LogEvent> getLogs(String type,
                     String keyword,
                     String appName,
                     String tenantDomain,
                     String serverKey)
                       throws LogViewerException

Returns a list of all LogEvents related to the given application, which match to given type and LogEvent message has given key word with it. User can use this api for search operations.

Parameters:

type - - Log type , eg: ALL , INFO , DEBUG etc ....

keyword - - Key word

appName - - Application name

tenantDomain - - Tenant domain eg: t1.com

serverKey - - Server key

Returns:

- all LogEvents related to the given application, which match to given type and LogEvent message has given key word with it. empty LogEvent array if there is no LogEvents available.

Throws:

LogViewerException

logsCount

int logsCount(String tenantDomain,
            String serverKey)
              throws LogViewerException

Return LogEvent count.

Parameters:

tenantDomain - - Tenant domain eg: t1.com

serverKey - - Server key

Returns:

- LogEvent count, 0 if there is no LogEvent.

Throws:

LogViewerException

clearLogs

boolean clearLogs()

Do clear operation, eg: if it is a in memory log provider then this can be used to clear the memory.

Returns:

- true if clear operation success, false if not.