@cloudcare/rum-uniapp 2.1.7 → 2.1.10

package/README.md

@@ -42,6 +42,7 @@ datafluxRum.init({
 | `applicationId`                                 | String  | 是       |           | 从 dataflux 创建的应用 ID                                                                                                                                                                                                               |
 | `datakitOrigin`                                 | String  | 是       |           | datakit 数据上报 Origin;`注意：需要在小程序管理后台加上request白名单`                                                                                                                                                                   |
 | `env`                                           | String  | 否       |           | 小程序 应用当前环境， 如 prod：线上环境；gray：灰度环境；pre：预发布环境 common：日常环境；local：本地环境；                                                                                                                            |
+| `service`                                       | String  | 否       |           | 小程序应用 服务名称，可 用于 apm 关联 tag                                                                                                                                                                                               |
 | `version`                                       | String  | 否       |           | 小程序 应用的版本号                                                                                                                                                                                                                     |
 | `sampleRate`                                    | Number  | 否       | `100`     | 指标数据收集百分比: `100`表示全收集，`0`表示不收集                                                                                                                                                                                      |
 | `traceType` $\color{#FF0000}{新增}$             | Enum    | 否       | `ddtrace` | 与 APM 采集工具连接的请求header类型，目前兼容的类型包括：`ddtrace`、`zipkin`、`skywalking_v3`、`jaeger`、`zipkin_single_header`、`w3c_traceparent`。*注： opentelemetry 支持 `zipkin_single_header`,`w3c_traceparent`,`zipkin`三种类型* |

package/cjs/boot/buildEnv.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.buildEnv = void 0;
 var buildEnv = {
-  sdkVersion: '2.1.7',
+  sdkVersion: '2.1.10',
   sdkName: 'df_uniapp_rum_sdk'
 };
 exports.buildEnv = buildEnv;

package/cjs/core/configuration.js

@@ -57,6 +57,7 @@ function commonInit(userConfiguration, buildEnv) {
     applicationId: userConfiguration.applicationId,
     env: userConfiguration.env || '',
     version: userConfiguration.version || '',
+    service: userConfiguration.service || '',
     sdkVersion: buildEnv.sdkVersion,
     sdkName: buildEnv.sdkName,
     datakitUrl: getDatakitUrlUrl(userConfiguration.datakitUrl || userConfiguration.datakitOrigin),

package/cjs/core/dataMap.js

@@ -14,6 +14,7 @@ var commonTags = {
   app_id: 'application.id',
   env: '_dd.env',
   version: '_dd.version',
+  service: '_dd.service',
   userid: 'user.id',
   user_email: 'user.email',
   user_name: 'user.name',
@@ -88,6 +89,8 @@ var dataMap = {
   error: {
     type: _enums.RumEventType.ERROR,
     tags: {
+      trace_id: '_dd.trace_id',
+      span_id: '_dd.span_id',
       error_source: 'error.source',
       error_type: 'error.type',
       resource_url: 'error.resource.url',

package/cjs/core/errorCollection.js

@@ -134,7 +134,9 @@ function trackNetworkError(configuration, errorObservable) {
         resource: {
           method: request.method,
           statusCode: request.status,
-          url: request.url
+          url: request.url,
+          traceId: request.traceId,
+          spanId: request.spanId
         },
         type: _errorTools.ErrorSource.NETWORK,
         source: _errorTools.ErrorSource.NETWORK,

package/cjs/core/transport.js

@@ -68,7 +68,7 @@ var processedMessageByDataMap = function processedMessageByDataMap(message) {
       rowData.measurement = key;
       var tagsStr = [];
       var tags = (0, _utils.extend)({}, _dataMap.commonTags, value.tags);
-      var filterFileds = ['date', 'type']; // 已经在datamap中定义过的fields和tags
+      var filterFileds = ['date', 'type', CUSTOM_KEYS]; // 已经在datamap中定义过的fields和tags
 
       (0, _utils.each)(tags, function (value_path, _key) {
         var _value = (0, _utils.findByPath)(message, value_path);
@@ -76,13 +76,13 @@ var processedMessageByDataMap = function processedMessageByDataMap(message) {
         filterFileds.push(_key);
 
         if (_value || (0, _utils.isNumber)(_value)) {
-          rowData.tags[_key] = _value;
+          rowData.tags[_key] = (0, _utils.escapeJsonValue)(_value);
           tagsStr.push((0, _utils.escapeRowData)(_key) + '=' + (0, _utils.escapeRowData)(_value));
         }
       });
 
       if (message.tags && (0, _utils.isObject)(message.tags) && !(0, _utils.isEmptyObject)(message.tags)) {
-        // 自定义tag
+        // 自定义tag， 存储成field
         var _tagKeys = [];
         (0, _utils.each)(message.tags, function (_value, _key) {
           // 如果和之前tag重名，则舍弃
@@ -92,14 +92,15 @@ var processedMessageByDataMap = function processedMessageByDataMap(message) {
           if (_value || (0, _utils.isNumber)(_value)) {
             _tagKeys.push(_key);
 
-            rowData.tags[_key] = _value;
-            tagsStr.push((0, _utils.escapeRowData)(_key) + '=' + (0, _utils.escapeRowData)(_value));
+            rowData.fields[_key] = _value; // 这里不需要转译
+
+            fieldsStr.push((0, _utils.escapeRowData)(_key) + '=' + (0, _utils.escapeRowField)(_value));
           }
         });
 
         if (_tagKeys.length) {
-          rowData.tags[CUSTOM_KEYS] = _tagKeys;
-          tagsStr.push((0, _utils.escapeRowData)(CUSTOM_KEYS) + '=' + (0, _utils.escapeRowData)(_tagKeys));
+          rowData.fields[CUSTOM_KEYS] = (0, _utils.escapeRowField)(_tagKeys);
+          fieldsStr.push((0, _utils.escapeRowData)(CUSTOM_KEYS) + '=' + (0, _utils.escapeRowField)(_tagKeys));
         }
       }
 
@@ -116,8 +117,7 @@ var processedMessageByDataMap = function processedMessageByDataMap(message) {
           if (_valueData || (0, _utils.isNumber)(_valueData)) {
             rowData.fields[_key] = _valueData; // 这里不需要转译
 
-            _valueData = type === 'string' ? '"' + _valueData.replace(/[\\]*"/g, '"').replace(/"/g, '\\"') + '"' : (0, _utils.escapeRowData)(_valueData);
-            fieldsStr.push((0, _utils.escapeRowData)(_key) + '=' + _valueData);
+            fieldsStr.push((0, _utils.escapeRowData)(_key) + '=' + (0, _utils.escapeRowField)(_valueData));
           }
         } else if ((0, _utils.isString)(_value)) {
           var _valueData = (0, _utils.findByPath)(message, _value);
@@ -127,8 +127,7 @@ var processedMessageByDataMap = function processedMessageByDataMap(message) {
           if (_valueData || (0, _utils.isNumber)(_valueData)) {
             rowData.fields[_key] = _valueData; // 这里不需要转译
 
-            _valueData = (0, _utils.escapeRowData)(_valueData);
-            fieldsStr.push((0, _utils.escapeRowData)(_key) + '=' + _valueData);
+            fieldsStr.push((0, _utils.escapeRowData)(_key) + '=' + (0, _utils.escapeRowField)(_valueData));
           }
         }
       });

package/cjs/helper/utils.js

@@ -20,6 +20,9 @@ exports.withSnakeCaseKeys = withSnakeCaseKeys;
 exports.deepSnakeCase = deepSnakeCase;
 exports.toSnakeCase = toSnakeCase;
 exports.escapeRowData = escapeRowData;
+exports.escapeJsonValue = escapeJsonValue;
+exports.escapeFieldValueStr = escapeFieldValueStr;
+exports.escapeRowField = escapeRowField;
 exports.getOrigin = getOrigin;
 exports.createContextManager = createContextManager;
 exports.getActivePage = getActivePage;
@@ -641,6 +644,28 @@ function escapeRowData(str) {
   });
 }
 
+function escapeJsonValue(value) {
+  if (isString(value)) {
+    return value;
+  } else {
+    return jsonStringify(value);
+  }
+}
+
+function escapeFieldValueStr(str) {
+  return '"' + str.replace(/[\\]*"/g, '"').replace(/"/g, '\\"') + '"';
+}
+
+function escapeRowField(value) {
+  if (_typeof(value) === 'object' && value) {
+    return escapeFieldValueStr(jsonStringify(value));
+  } else if (isString(value)) {
+    return escapeFieldValueStr(value);
+  } else {
+    return value;
+  }
+}
+
 var urlParse = function urlParse(para) {
   var URLParser = function URLParser(a) {
     this._fields = {

package/cjs/rumEventsCollection/assembly.js

@@ -43,7 +43,8 @@ function startRumAssembly(applicationId, configuration, session, lifeCycle, pare
           sdkName: configuration.sdkName,
           sdkVersion: configuration.sdkVersion,
           env: configuration.env,
-          version: configuration.version
+          version: configuration.version,
+          service: configuration.service
         },
         tags: configuration.tags,
         application: {

package/cjs/rumEventsCollection/error/errorCollection.js

@@ -58,8 +58,10 @@ function doStartErrorCollection(lifeCycle) {
 
 function processError(error) {
   var resource = error.resource;
+  var tracingInfo;
 
   if (resource) {
+    tracingInfo = computeRequestTracingInfo(resource);
     var urlObj = (0, _utils.urlParse)(error.resource.url).getParse();
     resource = {
       method: error.resource.method,
@@ -72,7 +74,7 @@ function processError(error) {
     };
   }
 
-  var rawRumEvent = {
+  var rawRumEvent = (0, _utils.extend2Lev)({
     date: error.startTime,
     error: {
       message: error.message,
@@ -83,9 +85,24 @@ function processError(error) {
       starttime: error.startTime
     },
     type: _enums.RumEventType.ERROR
-  };
+  }, tracingInfo);
   return {
     rawRumEvent: rawRumEvent,
     startTime: error.startTime
   };
+}
+
+function computeRequestTracingInfo(request) {
+  var hasBeenTraced = request.traceId && request.spanId;
+
+  if (!hasBeenTraced) {
+    return undefined;
+  }
+
+  return {
+    _dd: {
+      spanId: request.spanId,
+      traceId: request.traceId
+    }
+  };
 }

package/cjs/rumEventsCollection/tracing/ddtraceTracer.js

@@ -41,7 +41,7 @@ DDtraceTracer.prototype = {
   makeTracingHeaders: function makeTracingHeaders() {
     return {
       'x-datadog-origin': 'rum',
-      // 'x-datadog-parent-id': spanId.toDecimalString(),
+      'x-datadog-parent-id': this.getSpanId(),
       'x-datadog-sampled': '1',
       'x-datadog-sampling-priority': '1',
       'x-datadog-trace-id': this.getTraceId()

package/esm/boot/buildEnv.js

@@ -1,4 +1,4 @@
 export var buildEnv = {
-  sdkVersion: '2.1.7',
+  sdkVersion: '2.1.10',
   sdkName: 'df_uniapp_rum_sdk'
 };

package/esm/core/configuration.js

@@ -45,6 +45,7 @@ export function commonInit(userConfiguration, buildEnv) {
     applicationId: userConfiguration.applicationId,
     env: userConfiguration.env || '',
     version: userConfiguration.version || '',
+    service: userConfiguration.service || '',
     sdkVersion: buildEnv.sdkVersion,
     sdkName: buildEnv.sdkName,
     datakitUrl: getDatakitUrlUrl(userConfiguration.datakitUrl || userConfiguration.datakitOrigin),

package/esm/core/dataMap.js

@@ -6,6 +6,7 @@ export var commonTags = {
   app_id: 'application.id',
   env: '_dd.env',
   version: '_dd.version',
+  service: '_dd.service',
   userid: 'user.id',
   user_email: 'user.email',
   user_name: 'user.name',
@@ -79,6 +80,8 @@ export var dataMap = {
   error: {
     type: RumEventType.ERROR,
     tags: {
+      trace_id: '_dd.trace_id',
+      span_id: '_dd.span_id',
       error_source: 'error.source',
       error_type: 'error.type',
       resource_url: 'error.resource.url',

package/esm/core/errorCollection.js

@@ -105,7 +105,9 @@ export function trackNetworkError(configuration, errorObservable) {
         resource: {
           method: request.method,
           statusCode: request.status,
-          url: request.url
+          url: request.url,
+          traceId: request.traceId,
+          spanId: request.spanId
         },
         type: ErrorSource.NETWORK,
         source: ErrorSource.NETWORK,

package/esm/core/transport.js

@@ -1,4 +1,4 @@
-import { findByPath, escapeRowData, isNumber, each, isString, values, extend, isObject, isEmptyObject, isArray, isBoolean, toServerDuration } from '../helper/utils';
+import { findByPath, escapeRowData, isNumber, each, isString, values, extend, isObject, isEmptyObject, isArray, escapeRowField, escapeJsonValue, toServerDuration } from '../helper/utils';
 import { sdk } from '../core/sdk';
 import { LifeCycleEventType } from '../core/lifeCycle';
 import { commonTags, dataMap } from './dataMap';
@@ -53,7 +53,7 @@ export var processedMessageByDataMap = function processedMessageByDataMap(messag
       rowData.measurement = key;
       var tagsStr = [];
       var tags = extend({}, commonTags, value.tags);
-      var filterFileds = ['date', 'type']; // 已经在datamap中定义过的fields和tags
+      var filterFileds = ['date', 'type', CUSTOM_KEYS]; // 已经在datamap中定义过的fields和tags
 
       each(tags, function (value_path, _key) {
         var _value = findByPath(message, value_path);
@@ -61,13 +61,13 @@ export var processedMessageByDataMap = function processedMessageByDataMap(messag
         filterFileds.push(_key);
 
         if (_value || isNumber(_value)) {
-          rowData.tags[_key] = _value;
+          rowData.tags[_key] = escapeJsonValue(_value);
           tagsStr.push(escapeRowData(_key) + '=' + escapeRowData(_value));
         }
       });
 
       if (message.tags && isObject(message.tags) && !isEmptyObject(message.tags)) {
-        // 自定义tag
+        // 自定义tag， 存储成field
         var _tagKeys = [];
         each(message.tags, function (_value, _key) {
           // 如果和之前tag重名，则舍弃
@@ -77,14 +77,15 @@ export var processedMessageByDataMap = function processedMessageByDataMap(messag
           if (_value || isNumber(_value)) {
             _tagKeys.push(_key);
 
-            rowData.tags[_key] = _value;
-            tagsStr.push(escapeRowData(_key) + '=' + escapeRowData(_value));
+            rowData.fields[_key] = _value; // 这里不需要转译
+
+            fieldsStr.push(escapeRowData(_key) + '=' + escapeRowField(_value));
           }
         });
 
         if (_tagKeys.length) {
-          rowData.tags[CUSTOM_KEYS] = _tagKeys;
-          tagsStr.push(escapeRowData(CUSTOM_KEYS) + '=' + escapeRowData(_tagKeys));
+          rowData.fields[CUSTOM_KEYS] = escapeRowField(_tagKeys);
+          fieldsStr.push(escapeRowData(CUSTOM_KEYS) + '=' + escapeRowField(_tagKeys));
         }
       }
 
@@ -101,8 +102,7 @@ export var processedMessageByDataMap = function processedMessageByDataMap(messag
           if (_valueData || isNumber(_valueData)) {
             rowData.fields[_key] = _valueData; // 这里不需要转译
 
-            _valueData = type === 'string' ? '"' + _valueData.replace(/[\\]*"/g, '"').replace(/"/g, '\\"') + '"' : escapeRowData(_valueData);
-            fieldsStr.push(escapeRowData(_key) + '=' + _valueData);
+            fieldsStr.push(escapeRowData(_key) + '=' + escapeRowField(_valueData));
           }
         } else if (isString(_value)) {
           var _valueData = findByPath(message, _value);
@@ -112,8 +112,7 @@ export var processedMessageByDataMap = function processedMessageByDataMap(messag
           if (_valueData || isNumber(_valueData)) {
             rowData.fields[_key] = _valueData; // 这里不需要转译
 
-            _valueData = escapeRowData(_valueData);
-            fieldsStr.push(escapeRowData(_key) + '=' + _valueData);
+            fieldsStr.push(escapeRowData(_key) + '=' + escapeRowField(_valueData));
           }
         }
       });

package/esm/helper/utils.js

@@ -511,6 +511,25 @@ export function escapeRowData(str) {
     return '\\' + word;
   });
 }
+export function escapeJsonValue(value) {
+  if (isString(value)) {
+    return value;
+  } else {
+    return jsonStringify(value);
+  }
+}
+export function escapeFieldValueStr(str) {
+  return '"' + str.replace(/[\\]*"/g, '"').replace(/"/g, '\\"') + '"';
+}
+export function escapeRowField(value) {
+  if (typeof value === 'object' && value) {
+    return escapeFieldValueStr(jsonStringify(value));
+  } else if (isString(value)) {
+    return escapeFieldValueStr(value);
+  } else {
+    return value;
+  }
+}
 export var urlParse = function urlParse(para) {
   var URLParser = function URLParser(a) {
     this._fields = {

package/esm/rumEventsCollection/assembly.js

@@ -28,7 +28,8 @@ export function startRumAssembly(applicationId, configuration, session, lifeCycl
           sdkName: configuration.sdkName,
           sdkVersion: configuration.sdkVersion,
           env: configuration.env,
-          version: configuration.version
+          version: configuration.version,
+          service: configuration.service
         },
         tags: configuration.tags,
         application: {

package/esm/rumEventsCollection/error/errorCollection.js

@@ -1,7 +1,7 @@
 import { startAutomaticErrorCollection } from '../../core/errorCollection';
 import { RumEventType } from '../../helper/enums';
 import { LifeCycleEventType } from '../../core/lifeCycle';
-import { urlParse, replaceNumberCharByPath, getStatusGroup } from '../../helper/utils';
+import { urlParse, replaceNumberCharByPath, getStatusGroup, extend2Lev } from '../../helper/utils';
 export function startErrorCollection(lifeCycle, configuration) {
   // return doStartErrorCollection(
   // 	lifeCycle,
@@ -44,8 +44,10 @@ export function doStartErrorCollection(lifeCycle) {
 
 function processError(error) {
   var resource = error.resource;
+  var tracingInfo;
 
   if (resource) {
+    tracingInfo = computeRequestTracingInfo(resource);
     var urlObj = urlParse(error.resource.url).getParse();
     resource = {
       method: error.resource.method,
@@ -58,7 +60,7 @@ function processError(error) {
     };
   }
 
-  var rawRumEvent = {
+  var rawRumEvent = extend2Lev({
     date: error.startTime,
     error: {
       message: error.message,
@@ -69,9 +71,24 @@ function processError(error) {
       starttime: error.startTime
     },
     type: RumEventType.ERROR
-  };
+  }, tracingInfo);
   return {
     rawRumEvent: rawRumEvent,
     startTime: error.startTime
   };
+}
+
+function computeRequestTracingInfo(request) {
+  var hasBeenTraced = request.traceId && request.spanId;
+
+  if (!hasBeenTraced) {
+    return undefined;
+  }
+
+  return {
+    _dd: {
+      spanId: request.spanId,
+      traceId: request.traceId
+    }
+  };
 }

package/esm/rumEventsCollection/tracing/ddtraceTracer.js

@@ -33,7 +33,7 @@ DDtraceTracer.prototype = {
   makeTracingHeaders: function makeTracingHeaders() {
     return {
       'x-datadog-origin': 'rum',
-      // 'x-datadog-parent-id': spanId.toDecimalString(),
+      'x-datadog-parent-id': this.getSpanId(),
       'x-datadog-sampled': '1',
       'x-datadog-sampling-priority': '1',
       'x-datadog-trace-id': this.getTraceId()

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@cloudcare/rum-uniapp",
-	"version": "2.1.7",
+	"version": "2.1.10",
 	"main": "cjs/index.js",
 	"module": "esm/index.js",
 	"miniprogram": "cjs",