diff --git a/.htmltest.yml b/.htmltest.yml index 10ed33141869..09c40257b946 100644 --- a/.htmltest.yml +++ b/.htmltest.yml @@ -10,11 +10,11 @@ IgnoreDirs: - ^blog/(\d+/)?page/\d+ IgnoreInternalURLs: # list of paths IgnoreURLs: # list of regexs of paths or URLs to be ignored - - ^/docs/languages/\w+/(api|examples|registry)/$ - - ^/docs/collector/registry/$ - - ^/docs/languages/net/(metrics-api|traces-api)/ + - ^(/zh)?/docs/languages/\w+/(api|examples|registry)/$ + - ^(/zh)?/docs/collector/registry/$ + - ^(/zh)?/docs/languages/net/(metrics-api|traces-api)/ + - ^((/zh)?/docs/migration/)?opencensus/$ - ^/community/end-user/feedback-survey/$ - - ^(/docs/migration/)?opencensus/$ - ^https://deploy-preview-\d+--opentelemetry.netlify.app/ - ^https://www\.googletagmanager\.com diff --git a/content/zh/_index.md b/content/zh/_index.md index fb489457b530..e1232663cb67 100644 --- a/content/zh/_index.md +++ b/content/zh/_index.md @@ -22,8 +22,8 @@ developer_note:
-- [了解更多](/docs/what-is-opentelemetry/) -- [尝试 Demo](/docs/demo/) +- [了解更多](/zh/docs/what-is-opentelemetry/) +- [尝试 Demo](/zh/docs/demo/) - [探索集成组件](/ecosystem/integrations)
@@ -33,8 +33,8 @@ developer_note:
-- [开发人员](/docs/getting-started/dev/) -- [运维人员](/docs/getting-started/ops/) +- [开发人员](/zh/docs/getting-started/dev/) +- [运维人员](/zh/docs/getting-started/ops/)
{{< /blocks/cover >}} @@ -43,7 +43,7 @@ developer_note: OpenTelemetry 是各类 API、SDK 和工具形成的集合。可用于插桩、生成、采集和导出遥测数据（链路、指标和日志），帮助你分析软件的性能和行为。 -> OpenTelemetry 在[多种编程语言](/docs/languages/)均达到 **GA** 级别，普适性很高。 +> OpenTelemetry 在[多种编程语言](/zh/docs/languages/)均达到 **GA** 级别，普适性很高。 {{% /blocks/lead %}} diff --git a/content/zh/docs/_index.md b/content/zh/docs/_index.md new file mode 100644 index 000000000000..d256b22cd44e --- /dev/null +++ b/content/zh/docs/_index.md @@ -0,0 +1,13 @@ +--- +title: 文档 +menu: { main: { weight: 10 } } +--- + +OpenTelemetry 也被称为 OTel，是一个供应商中立的、开源的[可观测性](concepts/observability-primer/#what-is-observability)框架， +可用于插桩、生成、采集和导出[链路](/zh/docs/concepts/signals/traces/)、 +[指标](/zh/docs/concepts/signals/metrics/)和[日志](/zh/docs/concepts/signals/logs/)等遥测数据。 + +OpenTelemetry 作为一个行业标准，得到了 40 多个可观测供应商的支持， +被许多[代码库、服务和应用](/ecosystem/integrations)集成，被众多[最终用户](/ecosystem/adopters)采用。 + +![OpenTelemetry 基准架构](/img/otel-diagram.svg) diff --git a/content/zh/docs/what-is-opentelemetry.md b/content/zh/docs/what-is-opentelemetry.md new file mode 100644 index 000000000000..c0bfdc9be52c --- /dev/null +++ b/content/zh/docs/what-is-opentelemetry.md @@ -0,0 +1,91 @@ +--- +title: 什么是 OpenTelemetry？ +description: 简短说明 OpenTelemetry 是什么，不是什么。 +weight: -1 +--- + +OpenTelemetry +是一个[可观测性](/zh/docs/concepts/observability-primer/#what-is-observability)框架和工具包， +旨在创建和管理遥测数据，如[链路](/zh/docs/concepts/signals/traces/)、 +[指标](/zh/docs/concepts/signals/metrics/)和[日志](/zh/docs/concepts/signals/logs/)。 +重要的是，OpenTelemetry 是供应商和工具无关的，这意味着它可以与各种可观测性后端一起使用， +包括 [Jaeger](https://www.jaegertracing.io/) 和 +[Prometheus](https://prometheus.io/) 这类开源工具以及商业化产品。 + +OpenTelemetry 不是像 Jaeger、Prometheus 或其他商业供应商那样的可观测性后端。 +OpenTelemetry 专注于遥测数据的生成、采集、管理和导出。 OpenTelemetry 的一个主要目标是， +无论应用程序或系统采用何种编程语言、基础设施或运行时环境，你都可以轻松地将其仪表化。 +重要的是，遥测数据的存储和可视化是有意留给其他工具处理的。 + +## 什么是可观测性？ {#what-is-observability} + +[可观测性](/zh/docs/concepts/observability-primer/#what-is-observability)具备检查系统输出来理解系统内部状态的能力。 +在软件的上下文中，这意味着通过检查遥测数据（包括链路、指标和日志）来理解系统的内部状态。 + +要使系统可观测，必须对其进行仪表化。也就是说，代码必须发出链路、指标或日志。 +然后，仪表化的数据必须发送到可观测性后端。 + +## 为什么选择 OpenTelemetry？ {#why-opentelemetry} + +随着云计算、微服务架构和日益复杂的业务需求的兴起，软件和基础设施的可观测性需求比以往任何时候都要强烈。 + +OpenTelemetry 满足可观测性的需求，并遵循两个关键原则： + +1. 你所生成的数据归属于你自己，不会被供应商锁定。 +2. 你只需要学习一套 API 和约定。 + +这两个原则的结合赋予团队和组织在当今现代计算世界中所需的灵活性。 + +如果你想了解更多信息，请查阅 OpenTelemetry +的[使命、愿景和价值观](/community/mission/)。 + +## 主要的 OpenTelemetry 组件 {#main-opentelemetry-components} + +OpenTelemetry 包括以下主要组件： + +- 适用于所有组件的[规范](/docs/specs/otel) +- 定义遥测数据形状的标准[协议](/docs/specs/otlp/) +- 为常见遥测数据类型定义标准命名方案的[语义约定](/docs/specs/semconv/) +- 定义如何生成遥测数据的 API +- 实现规范、API 和遥测数据导出的[语言 SDK](/zh/docs/languages) +- 实现常见库和框架的仪表化的[库生态系统](/ecosystem/registry) +- 可自动生成遥测数据的自动仪表化组件，无需更改代码 +- [OpenTelemetry Collector](/zh/docs/collector)：接收、处理和导出遥测数据的代理 +- 各种其他工具， + 如[用于 Kubernetes 的 OpenTelemetry Operator](/zh/docs/kubernetes/operator/)、 + [OpenTelemetry Helm Charts](/zh/docs/kubernetes/helm/) 和 + [FaaS 的社区资产](/zh/docs/faas/) + +OpenTelemetry 广泛应用于许多已集成 OpenTelemetry +提供默认可观测性的[库、服务和应用](/ecosystem/integrations/)。 + +OpenTelemetry 得到众多[供应商](/ecosystem/vendors/)的支持，其中许多为 +OpenTelemetry 提供商业支持并直接为此项目做贡献。 + +## 可扩展性 {#extensibility} + +OpenTelemetry 被设计为可扩展的。一些扩展 OpenTelemetry 的例子包括： + +- 向 OpenTelemetry Collector 添加接收器以支持来自自定义源的遥测数据 +- 将自定义仪表化库加载到 SDK 中 +- 创建适用于特定用例的 SDK 或 Collector 的[分发](/zh/docs/concepts/distributions/) +- 为尚不支持 OpenTelemetry 协议（OTLP）的自定义后端创建新的导出器 +- 为非标准上下文传播格式创建自定义传播器 + +尽管大多数用户可能不需要扩展 OpenTelemetry，但此项目几乎每个层面都可以实现扩展。 + +## 历史 {#history} + +OpenTelemetry 是[云原生计算基金会 (CNCF)](https://www.cncf.io)的一个项目，是由 +OpenTracing 和 OpenCensus 项目合并而诞生的。OpenTracing 和 OpenCensus 这两个项目合并而成的。原来这两个项目都是为解决同样的问题而创建的： +缺乏一种标准的方法来为代码进行仪表化并将遥测数据发送到可观测性后端。 +由于这两个项目都无法独立解决这个问题，所以将其合并成立了 OpenTelemetry， +吸收了双方的优势，提供了统一的解决方案。 + +如果你目前正在使用 OpenTracing 或 OpenCensus， +你可以在[迁移指南](/zh/docs/migration/)中了解如何迁移到 OpenTelemetry。 + +## 接下来做什么？ {#what-next} + +- 参阅[入门指南](/zh/docs/getting-started/) — 立即开始！ +- 了解 [OpenTelemetry 的概念](/zh/docs/concepts/)。 diff --git a/hugo.yaml b/hugo.yaml index 12298c0e07aa..b09c98601110 100644 --- a/hugo.yaml +++ b/hugo.yaml @@ -216,6 +216,10 @@ module: - source: content/zh target: content lang: zh + - excludeFiles: specs/* + source: content/en/docs # zh missing-page fallback + target: content/docs + lang: zh - source: tmp/otel/specification target: content/docs/specs/otel - source: tmp/opamp