# @bluedynamics/cdk8s-monitoring 中文文档

规范地址：https://npmcn.com/package/%40bluedynamics/cdk8s-monitoring/

版本：1\.13\.0
npm 元数据更新时间：2026-11-05T00:35:59.516Z
中文译文更新时间：2026-11-08T08:27:34.426Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40bluedynamics/cdk8s-monitoring
原文对照：https://npmcn.com/package/%40bluedynamics/cdk8s-monitoring/?lang=original
项目主页：https://bluedynamics.github.io/cdk8s-monitoring/
源码仓库：https://github.com/bluedynamics/cdk8s-monitoring

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：14.5 MB，67 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：4 个
- peer 依赖：cdk8s ^2\.70\.0，constructs ^10\.4\.2，cdk8s-plus-33 ^2\.4\.0
- 首次发布：2026-06-23T16:39:30.947Z
- 最新版本发布：2026-11-05T00:35:59.131Z
- 近 30 天下载量：3061（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：32（近 12 个月 32 个）

## 中文简介

Cdk8s 普通监测堆栈(Prometheus、Thanos、Loki、Grafana、合金),用于库伯涅管

## 安装

```sh
npm install @bluedynamics/cdk8s-monitoring
```

也可以使用：`pnpm add @bluedynamics/cdk8s-monitoring`、`yarn add @bluedynamics/cdk8s-monitoring`、`bun add @bluedynamics/cdk8s-monitoring`

## README

# @ 蓝色动力学/ cdk8s- 监测

[![npm](https://img.shields.io/npm/v/@bluedynamics/cdk8s-monitoring)](https://www.npmjs.com/package/@bluedynamics/cdk8s-monitoring) [![Documentation](https://img.shields.io/badge/docs-bluedynamics.github.io-blue)](https://bluedynamics.github.io/cdk8s-monitoring/)

通用软件 [cdk8s (中文(简体) )](https://cdk8s.io/) 为完整的Kubernetes监测堆栈构建库:Prometheus、Thanos、Loki、Grafana、合金和可选的Tempo,长期存储在S3兼容对象存储上.

**完整文档: [https://blue动力学.github.io/cdk8s-监测/\*](https://bluedynamics.github.io/cdk8s-monitoring/*)\* 联合国**

图书馆是 **应用程序不可识别**它合成了堆栈本身;您自己的仪表板和警报规则存在于您的集成图中,并附在堆栈旁边(格拉法纳侧车发现 `ConfigMap`s 有标签 `grafana_dashboard: "1"`) (中文(简体) ).

## 特征

-   Prometheus + Alertmanager + Grafana 通过 kube-prometheus-stack Helm 图表.
-   Thanos Query, Store, 和 Contractor 用于长期测量并进行下取样.
-   Loki + 合金用于日志汇总和收集.
-   可选的Tempo追踪到尾部取样的合金网关后面.
-   电子邮件提醒, 默认为: 无噪声路由, CronJob 和 Pod Disruption 预算健康规则, 可选的中程降级 .
-   可选的Traefik和Longhorn显示器,可选的Grafana iframe嵌入.
-   S3桶和证书通过Crossplane和External Secrets操作器接通.
-   ArgoCD同步波定购入.
-   智能生产默认只在需要时(深度)才会被覆盖.

## 安装

```shell
npm install @bluedynamics/cdk8s-monitoring
```

同伴依赖性 : `cdk8s`, (中文(简体) ), `cdk8s-plus-33`, (中文(简体) ), `constructs`。 。 。 .

## 使用量

提供您的集群特定值并让 `mergeConfig` 填写默认值 :

```typescript
import { App } from 'cdk8s';
import { MonitoringChart, mergeConfig } from '@bluedynamics/cdk8s-monitoring';

const app = new App();

const config = mergeConfig({
  namespace: 'monitoring',
  clusterName: 'example',
  domains: { grafana: 'grafana.example.com' },
  s3: {
    endpoint: 'https://s3.example.com',
    endpointNoProtocol: 's3.example.com',
    region: 'eu',
    buckets: { thanos: 'metrics-thanos', loki: 'logs-loki' },
  },
  smtp: { host: 'mail.example.com', port: 587, from: 'monitoring@example.com', requireTls: true },
  integrations: {
    s3ProviderConfig: 'my-s3-provider',          // Crossplane ProviderConfig (buckets)
    s3SecretStore: 'my-s3-secret-store',         // ESO ClusterSecretStore (S3 credentials)
    s3CredentialsKey: 'my-s3-credentials',       // remote key holding AWS_ACCESS_KEY_ID / AWS_SECRET_ACCESS_KEY
    grafanaSecretStore: 'my-app-secret-store',   // ESO ClusterSecretStore (Grafana admin)
    grafanaCredentialsKey: 'my-grafana-admin',   // remote key holding admin-user / admin-password
  },
  // Override any default, e.g. storage: { prometheus: '30Gi' }
});

new MonitoringChart(app, 'monitoring', config);
app.synth();
```

`mergeConfig` 需求 `namespace`, (中文(简体) ), `clusterName`, (中文(简体) ), `domains`, (中文(简体) ), `s3`, (中文(简体) ), `smtp`,以及 `integrations`,而深处 其它的 `DEFAULT_CONFIG`。 。 。 . 附上自己的仪表板(`ConfigMap`s 有标签 `grafana_dashboard: "1"`和 `PrometheusRule`s 在图表旁; 图书馆没有特定应用程序的内容.

## 文档

完整的文献资料生活在 **[https://blue动力学.github.io/cdk8s-监测/\*\*](https://bluedynamics.github.io/cdk8s-monitoring/**)。 。 。 .**

-   [快速启动教程](https://bluedynamics.github.io/cdk8s-monitoring/tutorials/01-quick-start.html)
-   [设定先决条件](https://bluedynamics.github.io/cdk8s-monitoring/how-to/setup-prerequisites.html) ——掌舵控制器,外部机密操作器,相机,CRD,存储器
-   [如何向导](https://bluedynamics.github.io/cdk8s-monitoring/how-to/index.html) ——SMTP提醒,追踪,Grafana嵌入,基础设施显示器,优先类,应用仪表板
-   [配置参考](https://bluedynamics.github.io/cdk8s-monitoring/reference/configuration-options.html)
-   [警报和路线](https://bluedynamics.github.io/cdk8s-monitoring/reference/alerts-and-routing.html)
-   [建筑](https://bluedynamics.github.io/cdk8s-monitoring/explanation/architecture.html) 财务报告和审定财务报表 [平台假设](https://bluedynamics.github.io/cdk8s-monitoring/explanation/platform-assumptions.html)

## 先决条件

堆栈目标为有ArgoCD的k3s或RKE2集群并期望:

-   k3s/ RKE2 舵手控制器(`HelmChart` 资源 `helm.cattle.io`, (中文(简体) ),
-   外部机密操作员(S3证书,Grafana 管理员机密),
-   与 S3 供应商配置(桶提供)相交的飞机,
-   螺旋管操作器 CRDs 应用服务器侧面,
-   (单位:千美元) `StorageClass` 名称 `longhorn`,或设置在 `storage.className`。 。 。 .

见 [设定先决条件](https://bluedynamics.github.io/cdk8s-monitoring/how-to/setup-prerequisites.html) 关于细节.

## 发展

这个项目由 [projen 语录](https://projen.io/)不直接编辑生成的文件.

```shell
npx projen          # regenerate project files after editing .projenrc.ts
npx projen build    # compile + test + lint + package
npx projen test     # run tests
```

## 许可证

阿帕奇 - 2.0

## 常见问题

### @bluedynamics/cdk8s-monitoring 是什么？

Cdk8s 普通监测堆栈\(Prometheus、Thanos、Loki、Grafana、合金\),用于库伯涅管

### 如何安装 @bluedynamics/cdk8s-monitoring？

在项目目录运行 npm install @bluedynamics/cdk8s-monitoring，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：cdk8s（^2\.70\.0）、constructs（^10\.4\.2）、cdk8s-plus-33（^2\.4\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @bluedynamics/cdk8s-monitoring 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @bluedynamics/cdk8s-monitoring 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @bluedynamics/cdk8s-monitoring 可以商用吗？

@bluedynamics/cdk8s-monitoring 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @bluedynamics/cdk8s-monitoring 的下载量有多少？

根据 npm 官方下载统计，@bluedynamics/cdk8s-monitoring 在 2026/10/09 – 2026/11/07 这 30 天内被下载 3,061 次，日均约 102 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @bluedynamics/cdk8s-monitoring 还在维护吗？

最新版本 1\.13\.0 发布于 2026/11/05（3 天前）；至今共发布 32 个版本，其中过去 12 个月发布了 32 个；首次发布于 2026/06/24。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。