@aws- blocks/ bb- dashboard (英语)

自动生成 Cloud Watch Dashboard 用于应用可观察性.

设计与模拟等价细节 : 设计

何时使用

• 您已经应用了您的应用程序, 想要一个 URL 来查看应用程序的健康
• 您想要预配置部件而无需手动创建 Cloud Watch 仪表板
• 你需要一个团队仪表板 用于部署验证和操作意识

不使用时

• 您需要自定义的可视化或交互式数据探索 使用 Cloud Watch 控制台

安装

npm install @aws-blocks/bb-dashboard

快速启动

最小值

import { Dashboard } from '@aws-blocks/bb-dashboard';

const dashboard = new Dashboard(scope, 'dashboard');
// After deploy: a CloudWatch Dashboard with a health + logs section for every
// compute in the app.

带有度量衡+追踪器(建议)

仪表板是安排好的 通过计算 ——应用程序中的每个计算都是一组. 每组显示 卫生 节和a 日志 节( 日志总是 被俘虏). A 类 跟踪 当应用程序包含一个 Tracer (追踪) 显示显示:任何追踪器每次计算都会打开X-Ray。 没错 没有 将 Logger / Tracer 实例传递到仪表板 . 计量 应用范围(a) 名字空间不是与计算相连的 所以它们被明确通过 一节 每个命名空间.

import { Metrics } from '@aws-blocks/bb-metrics';
import { Tracer } from '@aws-blocks/bb-tracer';

new Tracer(scope, 'tracing');    // → traces section on every compute
const metrics = new Metrics(scope, 'metrics', { namespace: 'MyApp' });

const dashboard = new Dashboard(scope, 'dashboard', {
  title: 'MyApp — Production',
  // Display toggles (default true) applied to every compute section.
  logs: true,
  traces: true,
  // app-wide; pair each Metrics BB with its own metric names (per-namespace).
  // Also accepts an array of sources, one section per namespace.
  metrics: {
    metrics,
    metricConfigs: [
      { name: 'OrdersPlaced' },
      { name: 'Latency', stat: 'p99', period: 300, title: 'P99 Latency' },
      { name: 'CustomMetric', dimensions: { Service: 'API', Stage: 'prod' } },
    ],
  },
});

仪表板如何解决每个部分:

• 卫生 ——计算部健康科,始终显示.
• 日志 ——每个计算都显示(日志总是被捕获);日志组是计算员自己的处理器日志组. 使用 logs: false。 。 。 .
• 追踪 ——在启用跟踪时显示计算(应用程序包含一个 Tracer) (中文(简体) ). 使用 traces: false。 。 。 .
• 计量 - 应用范围,从 metrics 选项:使用每个 BB 解析 namespace (违约范围) fullId和 defaultDimensions (包含在部件查询中,以便针对正确的维度流).
• 计算覆盖率 总是 每个 在应用程序中计算(今天一个). 还没有显示计算选择器 .

API 参考

new Dashboard(scope, id, options?)

创建带有自动生成部件的 Cloud Watch Dashboard .

参数:

属性 :

DashboardOptions

显示切换

日志和痕迹是一节 显示切换,而不是组成投入—— 仪表板直接读取每个计算器的状态. 日志总是被捕获(因此) logs 仅隐藏该部分); 只在应用程序有一个 Tracer (这样) traces 仅隐藏另列部分.

仪表盘总是覆盖 每个 在应用程序中计算。 没有计算 选择者——一个与多计算客户表面一起到达(它将 否则在客户构建计算之前会泄露内部类型.

计量组成

配置

MetricConfig

一个预先注册的 Cloud Watch 度量衡的配置 .

错误常数

import { DashboardErrors } from '@aws-blocks/bb-dashboard';

DashboardErrors.InvalidMetricConfig // 'InvalidMetricConfigException'

• InvalidMetricConfig: 当一个参数配置无效时被丢入(例如空名或无效期).

说明: InvalidMetricConfig 是在 CDK 合成时在构建部件时被抛出,而不是由模拟/运行时间 Dashboard 建筑师.

自动生成部件

总是包括下列部件:

分组每计算,然后是全应用的度量标准:

(健康部件为Lambda-形状,用于默认计算;其他计算类型报告自己的健康指标。 )

Dashboard 重定向路线

Dashboard BB 登记 a GET 路径( 默认 ): /aws-blocks/dashboard302个方向 转到云表 Dashboard 控制台 URL。 这提供了一种方便的,可以发现的 开发者进入点 。 设定 routePath: false 以禁用.

• 在 AWS 中 : 重定向到全 Cloud Watch 控制台 URL(需要 AWS 登录) .
• 在本地 dev 中: 返回503,并首先部署一个消息.

// Custom route path
const dashboard = new Dashboard(scope, 'dashboard', {
  routePath: '/ops/dashboard',
});
// GET /ops/dashboard → 302 → https://<region>.console.aws.amazon.com/cloudwatch/...

日志组

每个计算器的日志段查询会计算自己的处理器日志组(即 计算条款)。 日志总是被捕获,所以 每个计算都会出现日志部件,除非设置 logs: false。 。 。 .

地方发展

在本地 dev 模式下, 模拟记录了方向路由, 但返回 503 (因为当地没有云表板):

[Dashboard] Dashboard BB: no-op in local mode (CloudWatch Dashboard is a cloud-only resource).
Will create CloudWatch Dashboard 'My App' on deploy. Run 'npx cdk deploy' to view.

📍 Local observability data:
   • Logs: Check your terminal output - Logger BB writes structured JSON to stdout
   • Metrics: Metrics BB writes EMF-formatted JSON to stdout (visible in terminal)
   • Traces: Tracer stores mock traces to .bb-data/ and logs them to stdout

缩放成本( C)

• 自由等级 : 最多3个仪表板,每台50公分
• 超过自由级 : 3美元/贴板/月
• 无运行时间成本 : 盘片为静态只读视图
• 请求时没有 API 呼叫

命名空间分辨率

度量衡命名空间来自度量衡 BB namespace 属性. Metrics BB从它的选项(说明 namespace 或退入范围 fullId) (中文(简体) ).

const metrics = new Metrics(scope, 'metrics', { namespace: 'MyApp/Orders' });
const dashboard = new Dashboard(scope, 'dashboard', { metrics });
// Dashboard uses 'MyApp/Orders' as the CloudWatch namespace

默认尺寸

当一个度量衡BB有 defaultDimensions 配置, Dashboard 自动包含 部件查询中的这些维度。 这将确保部件瞄准相同的维度度度度 运行时发出的流。 维度 MetricConfig 在顶端合并 (在冲突上胜负).

const metrics = new Metrics(scope, 'metrics', {
  namespace: 'MyApp/Orders',
  defaultDimensions: { service: 'orders', env: 'prod' },
});

const dashboard = new Dashboard(scope, 'dashboard', {
  metrics: {
    metrics,
    metricConfigs: [
      { name: 'OrdersPlaced' },  // queries with { service: 'orders', env: 'prod' }
      { name: 'Latency', dimensions: { endpoint: '/api' } },  // { service: 'orders', env: 'prod', endpoint: '/api' }
    ],
  },
});