文档中心

Node

最近更新时间：2024.01.04 16:41:03

首次发布时间：2024.01.04 16:41:03

一、简介

火山引擎DataSail提供埋点数据上报Node SDK，用户在开通DataSail服务之后，可以通过SDK将数据上报到火山云。

二、前置准备

服务开通

请确保您已开通了您需要访问的服务。您可前往火山引擎控制台开通全域数据集成服务，详见服务开通。

获取安全凭证

Access Key（访问密钥）是访问火山引擎服务的安全凭证，包含Access Key ID（简称为AK）和Secret Access Key（简称为SK）两部分。您可登录火山引擎控制台，前往访问控制的访问密钥中创建及管理您的Access Key。更多信息可参考访问密钥帮助文档。

产品接入

申请应用

路径：应用管理-新建应用

申请Topic

路径：数据采集-topic管理-新建Topic

申请数据采集

路径：数据采集-采集管理-新建采集任务

三、上报示例

环境

Node > 10
运行环境 (Nodejs)

参数

	参数名	类型	配置项含义	示例	备注
Node 主包
config	app_id	number	应用APP ID	111111
	logLevel	string	输入日志级别	verbose	非必填，默认只打印error日志，verbose则打印成功和失败日志
	caller	string	代表业务名称	datasail.dataset.test
Http 包
config	accessKeyId	string	火山云 Access Key	AKLTZWU*****
	secretKey	string	火山云 Secret Key	TW1KaVl******
	channel_domain	string	数据上报域名	datasail01-cn-beijing.volceapplog.com
	taskKey	string	采集任务ID	hkktppvwtuv0xy000	获取路径：数据采集->采集管理->采集任务 ID 🔗
	debug	boolean	是否开启埋点验证	false	开启埋点验证开关，数据会双发到验证链路
	region	string	数据上报区域	cn-beijing
	retry	number	失败重试次数	3	非必填，默认2

代码示例

安装代码

npm i @dp/tea-sdk-node
npm i @logsdk/node-plugin-http-cloud

数据上报

import  {  TeaSDK  }  from '@dp/tea-sdk-node';

import  { httpPlugin }  from '@logsdk/node-plugin-http-cloud';

// 初始化
const teaSDK = new TeaSDK(
  app_id: 5000044,
  logLevel: 'verbose', // 输入日志级别，默认只打印error日志，verbose则打印成功和失败日志
  caller: '',
});
const httpPluginController = httpPlugin({
  retry: 5, // 失败重试次数，非必填
  channel_domain: 'https://datasail01-cn-beijing.volceapplog.com', // 上报域名
  accessKeyId: 'AKLTOWI0YjVlNDc1NjVjNGI5Mjg2Zxxx',
  secretKey: 'TnpRMVl6QXlaVGxqTldNNE5EUmpObUlxxx==',
  region: 'cn-bejing',
  taskKey: 'dkmhhrsmnuvwtuv03',
  debug: true, // debug为true时，双发，埋点验证+线上环境
});
teaSDK.usePlugin(httpPluginController)

// 发送埋点
teaSDK.collect('test_events', {
  payload: 'xxxx'
});