全部产品
Search
文档中心

日志服务:通过Node.js SDK使用SQL独享版

更新时间:Jun 21, 2024

本文介绍通过Node.js SDK使用SQL独享版的代码示例。

前提条件

  • 已创建RAM用户并完成授权。具体操作,请参见创建RAM用户并完成授权

  • 已配置环境变量ALIBABA_CLOUD_ACCESS_KEY_IDALIBABA_CLOUD_ACCESS_KEY_SECRET。具体操作,请参见在Linux、macOS和Windows系统配置环境变量

    重要
    • 阿里云账号的AccessKey拥有所有API的访问权限,建议您使用RAM用户的AccessKey进行API访问或日常运维。

    • 强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里,否则可能导致AccessKey泄露,威胁您账号下所有资源的安全。

  • 已完成Node.js SDK安装。更多信息,请参见安装Node.js SDK

背景信息

日志服务提供SQL独享版,用于增强SQL分析能力,支持千亿行数据的计算。更多信息,请参见开启SQL独享版

日志服务提供executeLogStoreSql接口和executeProjectSql接口,帮助您更简单的使用SQL独享版。
  • executeLogStoreSql接口:在指定Logstore中使用SQL独享版。该接口支持的查询和分析语法兼容标准的SQL92语法,格式为查询语句|分析语句,其中分析语句采用标准的SQL92语法。
  • executeProjectSql接口:在指定Project中使用SQL独享版。该接口支持的查询和分析语法为标准的SQL92语法,即您的过滤条件和查询时间要写在SQL分析语句的WHERE语句中。
说明 如果您执行分析操作时,需要先过滤一部分数据再分析,建议您使用查询语句|分析语句语法,效率更高,即推荐使用executeLogStoreSql接口。

代码示例

代码示例如下,更多信息,请参见Aliyun Log Node.js SDK

const ALY = require('./node_modules/aliyun-sdk/index')

var sls = new ALY.SLS({
    // 本示例从环境变量中获取AccessKey ID和AccessKey Secret。
    "accessKeyId": process.env.ALIBABA_CLOUD_ACCESS_KEY_ID,                  
    "secretAccessKey": process.env.ALIBABA_CLOUD_ACCESS_KEY_SECRET, 
    //本示例从环境变量中获取SecurityToken。
    "securityToken" : process.env.ALIYUN_SECURITY_TOKEN,

    //日志服务的服务入口。此处以杭州为例,其它地域请根据实际情况填写。
    endpoint: 'http://cn-hangzhou.log.aliyuncs.com',

    //日志服务API版本号,无需修改。
    apiVersion: '2015-06-01'

    //可选配置。
    //,httpOptions: {
    //    timeout: 1000  //1秒, 默认没有timeout。
    //} 
});
module.exports = sls;

//Project名称。
var projectName = 'aliyun-test-project';
//Logstore名称。
var logStoreName = 'aliyun-test-logstore';
//查询的结束时间。
var to = Math.floor(new Date().getTime() / 1000);
//查询的开始时间。
var from = to - 900; //15分钟。

sls.executeLogStoreSql({
        projectName: projectName,
        logStoreName: logStoreName,
        from: from,
        to: to, 
        query: '*|select count(method)',
        powerSql:true 
    }, function(err, data) {
        if (err) {
            console.log('error:', err);
            return;
        }   
        console.log(data);
        console.log('processed rows',data.headers['x-log-processed-rows']); //处理的日志行数。
        console.log('elapsed milli',data.headers['x-log-elapsed-millisecond']);  //SQL分析执行的时长。
        console.log('cores',data.headers['x-log-cpu-cores']);     //开启SQL独享版后,执行SQL分析所使用的CPU核数。
        console.log('cpuSec',data.headers['x-log-cpu-sec']);      //开启SQL独享版后,执行SQL分析所花费的CPU时间,单位为秒。SQL独享版按照CPU时间计费,更多信息,请参见计费项。
        console.log('success:', data);
    }); 
 sls.executeProjectSql({
    projectName: projectName,
    logStoreName: logStoreName,
    from: from,
    to: to,
    query: 'select count(0) from ' + logStoreName + ' where __time__ > '+ from +' and __time__ < '+to+'',
    powerSql:true
}, function(err, data) {
        if (err) {
            console.log('error:', err);
            return;
        }   
        console.log(data);
        console.log('processed rows',data.headers['x-log-processed-rows']); //处理的日志行数。
        console.log('elapsed milli',data.headers['x-log-elapsed-millisecond']);  //SQL分析执行的时长。
        console.log('cores',data.headers['x-log-cpu-cores']);     //开启SQL独享版后,执行SQL分析所使用的CPU核数。
        console.log('cpuSec',data.headers['x-log-cpu-sec']);      //开启SQL独享版后,执行SQL分析所花费的CPU时间,单位为秒。SQL独享版按照CPU时间计费,更多信息,请参见计费项。
        console.log('success:', data);
    
    });            

调用executeLogStoreSql接口使用SQL独享版,接口格式如下:

sls.executeLogStoreSql({
        projectName: projectName,
        logStoreName: logStoreName,
        from: from,
        to: to, 
        query:  '*|select count(method)',
        powerSql:true 
    })

各个参数说明如下表所示。

参数名称

类型

是否必选

示例

说明

projectName

String

aliyun-project-test

Project名称。

在配置基本信息时,已定义projectName,此处无需配置。

logStoreName

String

aliyun-logstore-test

Logstore名称。

在配置基本信息时,已定义logStoreName,此处无需配置。

from

Long

1718760075

查询的起始时间。Unix时间戳格式,表示从1970-1-1 00:00:00 UTC计算起的秒数。

在配置基本信息时,已定义from,此处无需配置。

to

Long

1718788875

查询的结束时间。Unix时间戳格式,表示从1970-1-1 00:00:00 UTC计算起的秒数。

在配置基本信息时,已定义to,此处无需配置。

query

String

'*|select count(method)'

日志服务查询和分析语句,格式为查询语句|分析语句。更多信息,请参见基础语法

日志服务默认返回100行结果,您也可以使用LIMIT子句指定返回结果的行数。更多信息,请参见LIMIT子句

powerSql

Boolean

true

是否使用SQL独享版。更多信息,请参见开启SQL独享版

  • true:使用SQL独享版。

  • false(默认值):使用SQL普通版。

调用executeProjectSql接口使用SQL独享版,接口格式如下:

sls.executeProjectSql({
    projectName: projectName,
    query: 'select count(method) from sls_operation_log where __time__ > to_unixtime(now()) - 300 and __time__ < to_unixtime(now())',
    powerSql:true
})

各个参数说明如下表所示。

参数名称

类型

是否必选

示例

说明

projectName

String

aliyun-project-test

Project名称。

在配置基本信息时,已定义projectName,此处无需配置。

query

String

select count(method) from sls_operation_log where __time__ > to_unixtime(now()) - 300 and __time__ < to_unixtime(now())

标准的SQL语句,即您的查询语句要写在SQL分析语句的WHERE语句中。

日志服务默认返回100行结果,您也可以使用LIMIT子句指定返回结果的行数。更多信息,请参见LIMIT子句

powerSql

Boolean

true

是否使用SQL独享版。更多信息,请参见开启SQL独享版

  • true:使用SQL独享版。

  • false(默认值):使用SQL普通版。