com.aliyun.openservices.sls

接口 SimpleLogService

所有已知实现类:

SLSClient

public interface SimpleLogService

方法概要

限定符和类型	方法和说明
GetHistogramsResponse	GetHistograms(GetHistogramsRequest request) Get The log status(histogram info) from sls server which match input parameters.
GetHistogramsResponse	GetHistograms(String project, String logstore, int from, int to, String topic, String query) Get The log status(histogram info) from sls server which match input parameters.
GetLogsResponse	GetLogs(GetLogsRequest request) Get The sub set of logs data from sls server which match input parameters.
GetLogsResponse	GetLogs(String project, String logStore, int from, int to, String topic, String query) Get The sub set of logs data from sls server which match input parameters.
GetLogsResponse	GetLogs(String project, String logStore, int from, int to, String topic, String query, int line, int offset, boolean reverse) Get The sub set of logs data from sls server which match input parameters.
ListLogStoresResponse	ListLogStores(ListLogStoresRequest request) Get all the logstore of a project
ListLogStoresResponse	ListLogStores(String project) Get all the logstore for the user
ListTopicsResponse	ListTopics(ListTopicsRequest request) Get the topics in the logtstore
ListTopicsResponse	ListTopics(String project, String logStore, String token, int line) Get the topics in the logtstore
PutLogsResponse	PutLogs(PutLogsRequest request) Send Data to sls server
PutLogsResponse	PutLogs(String project, String logStore, String topic, List<LogItem> logItems, String source) Send Data to sls server

方法详细资料

GetHistograms

GetHistogramsResponse GetHistograms(String project,
                                    String logstore,
                                    int from,
                                    int to,
                                    String topic,
                                    String query)
                             throws SlsException

Get The log status(histogram info) from sls server which match input parameters. All the logs with logstore and topic in [from, to) which contain the keys in query are the matched data.

参数:

project - the project name

logstore - the result data logstore

from - the begin time of the result data to get

to - the end time of the result data to get

topic - the result data topic

query - If the query is not empty, it will return the logs contain the keys in query, if "all_hit" is contained in the query, only the logs contains all the keys in query are matched logs, other wise logs contain any key in query are matched logs.

返回:

the histogram response of the matched logs

抛出:

SlsException - if any error happen when get the data from sls sever

NullPointerException - if any parameter is null

IllegalArgumentException - if project or logstore is empty

GetHistograms

GetHistogramsResponse GetHistograms(GetHistogramsRequest request)
                             throws SlsException

Get The log status(histogram info) from sls server which match input parameters. All the logs with logstore and topic in [from, to) which contain the keys in query are the matched data.

参数:

request - the get histogram request

返回:

the histogram response of the matched logs

抛出:

SlsException - if any error happen when get the data from sls sever

NullPointerException - if request parameter is null

GetLogs

GetLogsResponse GetLogs(String project,
                        String logStore,
                        int from,
                        int to,
                        String topic,
                        String query)
                 throws SlsException

Get The sub set of logs data from sls server which match input parameters. By default, it will return at most 20 lines

参数:

project - the project name

logStore - the result data logstore

from - the begin time of the result data to get

to - the end time of the result data to get

topic - the result data topic

query - If the query is not empty, it will return the logs contain the keys in query, if "all_hit" is contained in the query, only the logs contains all the keys in query are matched logs, other wise logs contain any key in query are matched logs

返回:

a response contains a sub set of the logs matched the input parameters

抛出:

SlsException - if any error happen when get the data from sls sever

NullPointerException - if any parameter is null

IllegalArgumentException - if project or logstore is empty

GetLogs

GetLogsResponse GetLogs(String project,
                        String logStore,
                        int from,
                        int to,
                        String topic,
                        String query,
                        int line,
                        int offset,
                        boolean reverse)
                 throws SlsException

Get The sub set of logs data from sls server which match input parameters. All the data with logstore and topic in [from, to) which contain the keys in query are the matched data.

参数:

project - the project name

logStore - the result data logstore

from - the begin time of the result data to get

to - the end time of the result data to get

topic - the result data topic

reverse - a flag to determine the return data order, if reverse is set to false, the return logs is ascending order by time, other wise, it's descending order

line - how many lines to get, the max lines is decided by the sls backend server

offset - the start log index in all the matched logs.

query - If the query is not empty, it will return the logs contain the keys in query, if "all_hit" is contained in the query, only the logs contains all the keys in query are matched logs, other wise logs contain any key in query are matched logs.

返回:

a response contains a sub set of the logs matched the input parameters

抛出:

SlsException - if any error happen when get the data from sls sever

NullPointerException - if any parameter is null

IllegalArgumentException - if project or logstore is empty

GetLogs

GetLogsResponse GetLogs(GetLogsRequest request)
                 throws SlsException

Get The sub set of logs data from sls server which match input parameters.

参数:

request - the get logs request

返回:

a response contains a sub set of the logs matched the input parameters

抛出:

NullPointerException - if request parameter is null

SlsException - if any error happen when get the data from sls sever

ListLogStores

ListLogStoresResponse ListLogStores(String project)
                             throws SlsException

Get all the logstore for the user

参数:

project - the project name

返回:

the user's logstore response

抛出:

SlsException - if any error happen when get the data from sls sever

NullPointerException - if any parameter is null

IllegalArgumentException - if project or logstore is empty

ListLogStores

ListLogStoresResponse ListLogStores(ListLogStoresRequest request)
                             throws SlsException

Get all the logstore of a project

参数:

request - the list log store request

返回:

the user's logstore response

抛出:

SlsException - if any error happen when get the data from sls sever

NullPointerException - if request parameter is null

ListTopics

ListTopicsResponse ListTopics(String project,
                              String logStore,
                              String token,
                              int line)
                       throws SlsException

Get the topics in the logtstore

参数:

project - the project name

logStore - where the topic belongs to

token - all the returned topics are equal or larger than the given token according to topics' lexicographical order

line - the topic number from sls server

返回:

the log store's topics response

抛出:

SlsException - if any error happen when get the data from sls sever

NullPointerException - if any parameter is null

IllegalArgumentException - if project or logstore is empty

ListTopics

ListTopicsResponse ListTopics(ListTopicsRequest request)
                       throws SlsException

Get the topics in the logtstore

参数:

request - the list topics request

返回:

the log store's topics response

抛出:

SlsException - if any error happen when get the data from sls sever

NullPointerException - if request parameter is null

PutLogs

PutLogsResponse PutLogs(String project,
                        String logStore,
                        String topic,
                        List<LogItem> logItems,
                        String source)
                 throws SlsException

Send Data to sls server

参数:

project - the project name

logStore - the log store where the source data should be put

topic - source data topic

logItems - the log data to send

source - the source of the data, if the source is empty, it will be reset to the host ip

返回:

The put logs response

抛出:

SlsException - if any error happen when send data to the server

NullPointerException - if any parameter is null

IllegalArgumentException - if project or logstore is empty, or the logGroup log count exceed 4096, or the total data size exceed 5MB

PutLogs

PutLogsResponse PutLogs(PutLogsRequest request)
                 throws SlsException

Send Data to sls server

参数:

request - the put log request

返回:

The put logs response

抛出:

SlsException - if any error happen when send data to the server

NullPointerException - if any parameter is null

IllegalArgumentException - if project or logstore is empty, or the logGroup log count exceed 4096, or the total data size exceed 5MB