Measured 项目技术文档

1. 安装指南

1.1 安装 Node.js

在开始安装 Measured 项目之前，请确保您的系统上已经安装了 Node.js。您可以通过以下命令检查是否已安装 Node.js：

node -v

如果未安装，请访问 Node.js 官方网站 下载并安装适合您操作系统的版本。

1.2 安装 Measured 核心库

Measured 项目由多个 npm 包组成，您可以根据需要安装不同的包。以下是安装核心库的命令：

npm install measured-core

1.3 安装其他组件

根据您的需求，您还可以安装其他组件，例如：

• Measured Reporting:

  npm install measured-reporting
  

• Measured Node Metrics:

  npm install measured-node-metrics
  

• Measured SignalFx Reporter:

  npm install measured-signalfx-reporter
  

2. 项目的使用说明

2.1 初始化核心库

首先，您需要初始化 measured-core 库，创建一个 MetricRegistry 实例：

const { MetricRegistry } = require('measured-core');

const registry = new MetricRegistry();

2.2 创建和使用 Metrics

您可以使用 MetricRegistry 创建各种类型的 Metrics，例如计数器、计时器等：

const counter = registry.counter('myCounter');
counter.inc(); // 增加计数器

const timer = registry.timer('myTimer');
const stopwatch = timer.start();
// 执行一些操作
stopwatch.end(); // 停止计时器

2.3 使用 Reporting 组件

如果您需要将 Metrics 报告到外部系统，可以使用 measured-reporting 组件：

const { SelfReportingMetricsRegistry } = require('measured-reporting');
const { SignalFxReporter } = require('measured-signalfx-reporter');

const reporter = new SignalFxReporter({
  token: 'your-signalfx-token',
  interval: 10000 // 报告间隔时间
});

const reportingRegistry = new SelfReportingMetricsRegistry(reporter);

2.4 使用 Node Metrics 组件

如果您在 Node.js 应用中使用 Measured，可以使用 measured-node-metrics 提供的中间件来轻松地为 HTTP 请求添加 Metrics：

const express = require('express');
const { httpRequests } = require('measured-node-metrics');

const app = express();

app.use(httpRequests(reportingRegistry));

app.get('/', (req, res) => {
  res.send('Hello World!');
});

app.listen(3000, () => {
  console.log('Server is running on port 3000');
});

3. 项目API使用文档

3.1 MetricRegistry API

• counter(name: string): Counter: 创建或获取一个计数器。
• timer(name: string): Timer: 创建或获取一个计时器。
• gauge(name: string, gauge: Gauge): void: 注册一个 Gauge。

3.2 Counter API

• inc(n?: number): void: 增加计数器的值，默认增加 1。
• dec(n?: number): void: 减少计数器的值，默认减少 1。
• reset(): void: 重置计数器的值为 0。

3.3 Timer API

• start(): Stopwatch: 开始计时。
• update(duration: number): void: 手动更新计时器的值。

3.4 SelfReportingMetricsRegistry API

• register(name: string, metric: Metric): void: 注册一个 Metric。
• getMetrics(): Map<string, Metric>: 获取所有注册的 Metrics。

4. 项目安装方式

4.1 使用 npm 安装

您可以使用 npm 安装 Measured 项目的各个组件：

npm install measured-core measured-reporting measured-node-metrics measured-signalfx-reporter

4.2 使用 yarn 安装

如果您使用 yarn 作为包管理器，可以使用以下命令安装：

yarn add measured-core measured-reporting measured-node-metrics measured-signalfx-reporter

通过以上步骤，您可以成功安装并使用 Measured 项目来测量和报告应用程序级别的 Metrics。