Simple Log Service:Use Simple Log Service SDK for Java to use the Dedicated SQL feature

Usage notes

In this example, the public Simple Log Service endpoint for the China (Hangzhou) region is used, which is https://cn-hangzhou.log.aliyuncs.com. If you want to access Simple Log Service by using other Alibaba Cloud services that reside in the same region as your project, you can use the internal Simple Log Service endpoint, which is https://cn-hangzhou-intranet.log.aliyuncs.com. For more information about the supported regions and endpoints of Simple Log Service, see Endpoints.

Sample code

The following sample code provides an example on how to use the Dedicated SQL feature. For more information, see Alibaba Cloud Simple Log Service SDK for Java.

import com.aliyun.openservices.log.Client;
import com.aliyun.openservices.log.common.LogContent;
import com.aliyun.openservices.log.common.LogItem;
import com.aliyun.openservices.log.common.QueriedLog;
import com.aliyun.openservices.log.exception.LogException;
import com.aliyun.openservices.log.response.GetLogsResponse;

import java.util.Date;

public class SlsSample {

    public static void main(String args[]) throws LogException,
            InterruptedException {
        // In this example, the AccessKey ID and AccessKey secret are obtained from environment variables. 
        String accessId = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
        String accessKey = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
        // The name of the project. 
        String project = "aliyun-test-project";
        // The Simple Log Service endpoint. In this example, the Simple Log Service endpoint for the China (Hangzhou) region is used. Replace the parameter value with the actual endpoint. 
        String host = "cn-hangzhou.log.aliyuncs.com"; 
        // The name of the Logstore. 
        String logStore = "aliyun-test-logstore";
        // The shard ID. 
        int shardId = 0;
        
        // Create a Simple Log Service client. 
        Client client = new Client(host, accessId, accessKey);

        // Execute an SQL statement in the specified Logstore. 
        try {
            String sql = "* | select count(1)";
            int from = (int) (new Date().getTime() / 1000 - 600);
            int to = (int) (new Date().getTime() / 1000);
            GetLogsResponse logsResponse = client.executeLogstoreSql(project, logStore, 1627268185, 1627269085, "* | SELECT count(*)", true);
            System.out.println("Returned sql result count:" + logsResponse.GetCount());
            for (QueriedLog log : logsResponse.getLogs()) {
                LogItem item = log.GetLogItem();
                System.out.println("time : " + item.mLogTime);
                for (LogContent content : item.mContents) {
                    System.out.println(content.mKey + ":" + content.mValue);
                }
            }
            // Display the statistics about the analysis results. 
            // The number of lines of log data that is processed. 
            System.out.println("proccesedRows:" + logsResponse.getProcessedRow());
            // The time that is consumed to execute the SQL statement. 
            System.out.println("elapsedMilli:" + logsResponse.getElapsedMilliSecond());
            // The CPU time that is consumed to execute the SQL statement after the Dedicated SQL feature is enabled. Unit: seconds. You are charged for the Dedicated SQL feature based on the CPU time. For more information, see the topics that are related to billable items. 
            System.out.println("cpuSec:" + logsResponse.getCpuSec());
            // The number of CPU cores that are used to execute the SQL statement after the Dedicated SQL feature is enabled. 
            System.out.println("cpuCores:" + logsResponse.getCpuCores());
            System.out.println("requestId:" + logsResponse.GetRequestId());

        } catch (LogException e) {
            System.out.println("error code :" + e.GetErrorCode());
            System.out.println("error message :" + e.GetErrorMessage());
            throw e;
        }

        // Execute an SQL statement in the specified project. 
        try {
            int now = (int) (new Date().getTime() / 1000);
            String sql = "select count(1) as cnt from xxx where __time__ > " + now;
            GetLogsResponse logsResponse = client.executeProjectSql(project, "select avg(latency),max(latency) ,count(1) as c from sample-logstore where status>200 and __time__>=1500975424 and __time__ < 1501035044 GROUP BY method ORDER BY c", true);
            System.out.println("Returned sql result count:" + logsResponse.GetCount());
            for (QueriedLog log : logsResponse.getLogs()) {
                LogItem item = log.GetLogItem();
                for (LogContent content : item.mContents) {
                    System.out.println(content.mKey + ":" + content.mValue);
                }
            }
            // Display the statistics about the analysis results. 
            // The number of lines of log data that is processed. 
            System.out.println("proccesedRows:" + logsResponse.getProcessedRow());
            // The time that is consumed to execute the SQL statement. 
            System.out.println("elapsedMilli:" + logsResponse.getElapsedMilliSecond());
            // The CPU time that is consumed to execute the SQL statement after the Dedicated SQL feature is enabled. Unit: seconds. You are charged for the Dedicated SQL feature based on the CPU time. For more information, see the topics that are related to billable items. 
            System.out.println("cpuSec:" + logsResponse.getCpuSec());
            // The number of CPU cores that are used to execute the SQL statement after the Dedicated SQL feature is enabled. 
            System.out.println("cpuCores:" + logsResponse.getCpuCores());
            System.out.println("requestId:" + logsResponse.GetRequestId());
        } catch (LogException e) {
            System.out.println("error code :" + e.GetErrorCode());
            System.out.println("error message :" + e.GetErrorMessage());
            throw e;
        }
    }
}

• executeLogStoreSql operation

  You can call the executeLogStoreSql operation to use the Dedicated SQL feature. You must create a request in the GetLogsResponse logsResponse = client.executeLogstoreSql(project, logStore, from, to, query, powerSql) format. The following table describes the parameters.

  Parameter	Type	Required	Example	Description
  project	String	Yes	N/A	The name of the project. When you create a Simple Log Service client, you must specify a value for the project parameter. Therefore, you do not need to configure the parameter again.
  logStore	String	Yes	N/A	The name of the Logstore. When you create a Simple Log Service client, you must specify a value for the logStore parameter. Therefore, you do not need to configure the parameter again.
  from	Long	Yes	1627268185	The beginning of the time range to query. The value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.
  to	Long	Yes	1627269085	The end of the time range to query. The value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.
  query	String	Yes	"* | SELECT count(*)"	Simple Log Service For more information, see Syntax. By default, Simple Log Service returns 100 rows of data. You can use a LIMIT clause to specify the number of data rows to return. For more information, see LIMIT clause.
  powerSql	Boolean	No	true	Specifies whether to use the Dedicated SQL feature. For more information, see Enable Dedicated SQL. Valid values: true: uses the Dedicated SQL feature. false (default): uses the Standard SQL feature.

• executeProjectSql operation

  You can call the executeProjectSql operation to use the Dedicated SQL feature. You must create a request in the GetLogsResponse logsResponse = client.executeProjectSql(project, query, powerSql) format. The following table describes the parameters.

  Parameter	Type	Required	Example	Description
  project	String	Yes	N/A	The name of the project. When you create a Simple Log Service client, you must specify a value for the project parameter. Therefore, you do not need to configure the parameter again.
  query	String	Yes	"select avg(latency),max(latency) ,count(1) as c from sample-logstore where status>200 and __time__>=1500975424 and __time__ < 1501035044 GROUP BY method ORDER BY c"	The SQL statement. You must specify the search condition and time range in the WHERE clause of the SQL statement. By default, Simple Log Service returns 100 rows of data. You can use a LIMIT clause to specify the number of data rows to return. For more information, see LIMIT clause.
  powerSql	Boolean	No	true	Specifies whether to use the Dedicated SQL feature. For more information, see Enable Dedicated SQL. Valid values: true: uses the Dedicated SQL feature. false (default): uses the Standard SQL feature.

References

• If the response that is returned by Log Service contains error information after you call an API operation, the call fails. You can handle errors based on the error codes that are returned when API calls fail. For more information, see Error codes.
• Alibaba Cloud OpenAPI Explorer provides debugging capabilities, SDKs, examples, and related documents. You can use OpenAPI Explorer to debug Log Service API operations without the need to manually encapsulate or sign requests. For more information, visit OpenAPI Portal.
• Log Service provides the command-line interface (CLI) to meet the requirements for automated configurations in Log Service. For more information, see Log Service CLI.
• For more information about sample code, see Alibaba Cloud Log Service SDK for Java on GitHub.
• For more information about sample code, see Alibaba Cloud Log Service SDK for Python on GitHub.