遥测
动机
这个软件包的目标是使配置和与OpenTeleometry合作的经验更加容易.
实例
以下是追踪和衡量尺度的简短例子。 现有更多实例 示例文件夹,以及各种开口遥测重置.
追踪
下面的代码显示了一个简单的例子,说明如何进行追踪. 请注意您需要手动安装您需要的自动仪器库 .
import { Tracing } from '@bondsports/telemetry';
import { trace } from '@opentelemetry/api';
const tracing = new Tracing();
tracing.start();
const tracer = trace.getTracer('tracing-name')
const span = tracer.startSpan('some-action');
span.setAttribute('some-attribute');
// DO STUFF
span.end();
tracing.stop().then(() => console.log('done'));
用自定义资源初始化追踪的另一种方式:
import { Tracing } from '@bondsports/telemetry';
import { Resource } from '@opentelemetry/resources';
const resource = new Resource({ 'service.version': number, 'service.name': 'my-service-name' });
const tracing = new Tracing([], resource);
...
计量
以下的代码显示了一个如何使用度量衡的简单实例.
import { Metrics } from '@bondsports/telemetry';
const metrics = new Metrics('sample-meter');
const meter = metrics.start();
const counter = meter.createCounter('sample_counter');
counter.add(1);
metrics.stop().then(() => console.log('done'));
Trace-ID 响应信头( Express Misterware)
getTraceIdHeaderMiddleware 设置来自
活动 OpenTelection 跨度使客户端和日志聚合工具可以关联到一个
跨系统单项请求:
| 页眉 | 格式 | 匹配 |
|---|---|---|
X-Trace-Id | 32-Char 十六进制(W3C) | trace_id 应用程序日志中的字段 |
Trace_Id | 32-Char 十六进制(W3C) | trace_id 应用程序日志中的字段 |
X-Amzn-Trace-Id | Root=1-<8hex>-<24hex> (AWS X-Ray) (美国英语) | 原始内容 X-Amzn-Trace-Id 存储在 AWS ALB 访问日志/ OpenSearch 中的页眉 |
当入境请求已经载有 X-Amzn-Trace-Id 页眉( 典型的)
在AWS ALB后面,其价值被逐字反射,所以 Self= 编号 : Sampled= 编号 :
中等跳跃设置的自定义字段被保留。 否则头是
由活动段的跟踪ID重建而来.
import express from 'express';
import { getTraceIdHeaderMiddleware } from '@bondsports/telemetry';
const app = express();
app.use(getTraceIdHeaderMiddleware());
配置
通用配置
| 名称 | 允许的值 | 默认值 | 说明 |
|---|---|---|---|
| 电话 服务 NAME | 字符串 | 从软件包.json | 服务名称 |
| TEMETRY 服务 VERSION | 字符串 | 从软件包.json | 服务版本 |
| (原始内容存档于2018-10-21). TELEMATRY HOST NAME | 字符串 | os.hostname() | 主机名称 |
追踪配置
| 名称 | 允许的值 | 默认值 | 说明 |
|---|---|---|---|
| 电话: 收听: | '真','虚假' | "虚假" | 是否启用追踪 |
| 电话 电话* 联合国 | 字符串 | http://localhost:55681/v1/trace (英语) | 打开远程收藏器的 URL |
| 电话: 收听: | 浮动 | 1个 | 样本的痕迹量 |
* 联合国 需要(仅在允许追查时).
计量配置
| 名称 | 允许的值 | 默认值 | 说明 |
|---|---|---|---|
| 铁矿 金属矿 | '真','虚假' | "虚假" | 是否启用计量 |
| 铁丝网 铁丝网 URL* 联合国 | 字符串 | http://localhost:55681/v1/metrics (英语) | 打开远程收藏器的 URL |
| (电话: | 编号 | 15000个 | 向采集器发送数据之间的相差微秒 |
* 联合国 需要(仅在允许追查时).