@awarns/tracing

在使用AwarNS 框架时，后台执行流程可能会变得非常复杂，但这并不一定是坏事。该模块通过一组装饰器和任务帮助调试此类工作流程，这些装饰器和任务允许跟踪任务执行和某些事件的触发。记录的跟踪信息可以稍后查询并导出为本地文件。可选地，可以将记录的跟踪信息自动存储在外部数据存储中（例如，后端）。

使用以下命令行指令安装插件

ns plugin add @awarns/tracing

用法

安装和配置此插件后，您将获得两种交互机制来使用它

1. 插件API。通过它，您可以“装饰”现有任务，跟踪它们的执行。然后，您可以查询记录的执行跟踪并使用最常见的信息交换格式导出它们。
2. 跟踪特定事件的任务。有时，任务本身的执行并不重要，但只是它产生的一个（或多个）事件。或者，事件生成器可能不是任务，而是某些UI代码在非常特定的情况下发出事件。如果这些事件的触发对您的应用程序很重要，您可以使用这些任务跟踪它们。

设置

此插件要求您在框架初始化期间注册其加载器，如下所示

// ... platform imports
import { awarns } from '@awarns/core';
import { demoTasks } from '../tasks';
import { demoTaskGraph } from '../graph';
import { registerTracingPlugin } from '@awarns/tracing';

import { externalTracesStore } from './external-store';

awarns
  .init(
    demoTasks,
    demoTaskGraph,
    [
      registerTracingPlugin({
        externalTracesStore: externalTracesStore,
        oldTracesMaxAgeHours: 7 * 24 // 1 week
      }),
    ]
  )
  // ... handle initialization promise

插件加载器配置参数选项

TracesStore (外部)

因此，目前，此插件仅支持单向同步，其余方法旨在供将来使用，目前无需实现。您可以在其中抛出未实现错误，以便更容易识别它们在未来版本中的使用。

API

此插件的API可以分为三组：任务装饰器、跟踪存储和数据导出器。

任务装饰器

makeTraceable

在任务装饰器组中，有一个makeTraceable函数，允许装饰一个或多个任务以跟踪它们的执行，以下参数（请参阅完整示例用法这里）

makeTraceable 函数返回一个装饰过的任务数组。

TracerConfig

追踪存储

tracesStore

在追踪存储组中，有一个 tracesStore 单例对象，具有以下方法

注意：建议安装 RxJS，以操作返回 Observable 的方法。

追踪

追踪内容（任务）

导出数据

createRecordsExporter

在最后一个组中，数据导出器组中，有一个 createRecordsExporter() 函数，具有以下参数

createRecordsExporter() 返回一个具有以下API的 Exporter 对象

导出器

ExportResult

任务

追踪常规事件

要为此任务注册使用，您只需将其导入，并在您应用程序的任务列表中调用其生成函数

import { Task } from '@awarns/core/tasks';
import { trackEventTask } from '@awarns/tracing';

export const demoTasks: Array<Task> = [
  trackEventTask(),
];

任务生成器参数

任务生成器不接收任何参数。

任务输出事件

• trackEventFinished (默认，无内容)

在应用程序任务图中的示例用法

on('startEvent', run('trackEvent')); // Include some payload data in your start event, 
                                     // to see how it becomes recorded too

追踪包含敏感信息的事件

要为此任务注册使用，您只需将其导入，并在您应用程序的任务列表中调用其生成函数

import { Task } from '@awarns/core/tasks';
import { trackSensitiveEventTask } from '@awarns/tracing';

export const demoTasks: Array<Task> = [
  trackSensitiveEventTask(),
];

任务生成器参数

任务生成器不接收任何参数。

任务输出事件

• trackSensitiveEventFinished (默认，无内容)

在应用程序任务图中的示例用法

on('startEvent', run('trackSensitiveEvent')); // Include some payload data in your start event, 
                                              // to see how it does not appear in the event trace

许可证

Apache License 版本 2.0