Merge branch 'main' into michael2893-update-collector-documentation

open-telemetry · May 13, 2024 · 7841ffc · 7841ffc
2 parents 0fc87a6 + 359a96c
commit 7841ffc
Show file tree

Hide file tree

Showing 37 changed files with 623 additions and 56 deletions.
diff --git a/.gitmodules b/.gitmodules
@@ -1,13 +1,13 @@
 [submodule "themes/docsy"]
 	path = themes/docsy
 	url = https://github.com/google/docsy.git
-	docsy-pin = v0.10.0
+	docsy-pin = v0.10.0-2-g6f7e81d
 	docsy-note = "2024-04-01 Switching to google/docsy.git from cncf/docsy.git since we don't have any CNCF customizations."
 	docsy-reminder = "Ensure that any tag referenced by `docsy-pin` is present in the remote repo (url), otherwise add (push) the tags to the repo."
 [submodule "content-modules/opentelemetry-specification"]
 	path = content-modules/opentelemetry-specification
 	url = https://github.com/open-telemetry/opentelemetry-specification.git
-	spec-pin = v1.32.0
+	spec-pin = v1.33.0
 [submodule "content-modules/community"]
 	path = content-modules/community
 	url = https://github.com/open-telemetry/community

diff --git a/.htmltest.yml b/.htmltest.yml
@@ -3,6 +3,7 @@ DirectoryPath: public
 IgnoreDirectoryMissingTrailingSlash: true
 IgnoreAltMissing: true
 IgnoreCanonicalBrokenLinks: false
+IgnoreInternalEmptyHash: true # TODO: remove after resolution of https://github.com/google/docsy/issues/1995
 CheckMailto: false
 TestFilesConcurrently: true
 IgnoreDirs:

diff --git a/content-modules/opentelemetry-specification b/content-modules/opentelemetry-specification
diff --git a/content/en/_index.md b/content/en/_index.md
@@ -4,6 +4,9 @@ description: >-
   High-quality, ubiquitous, and portable telemetry to enable effective
   observability
 show_banner: true
+outputs:
+  - HTML
+  - REDIRECTS # Include this `content/en` ONLY
 developer_note:
   The blocks/cover shortcode (used below) will use as a background image any
   image file containing "background" in its name.

diff --git a/content/en/blog/2024/otel-operator-q-and-a/index.md b/content/en/blog/2024/otel-operator-q-and-a/index.md
diff --git a/content/en/blog/2024/otel-operator-q-and-a/mount-rainier.jpg b/content/en/blog/2024/otel-operator-q-and-a/mount-rainier.jpg
diff --git a/content/en/docs/collector/configuration.md b/content/en/docs/collector/configuration.md
@@ -609,10 +609,9 @@ Collector issues. It consists of two subsections: `logs` and `metrics`.
 The `logs` subsection lets you configure how the logs can be generated by the
 Collector. By default, the Collector writes its logs to `stderr` with a log
 level of `INFO`. You can also add static key-value pairs to all log entries with
-the `initial_fields` to enrich the logging context. As per the `LogsConfig`
-defined in v{{%
-param vers %}} [here](https://github.com/open-telemetry/opentelemetry-collector/blob/v{{%
-param vers %}}/service/telemetry/config.go), the `logs` configuration options are:
+the `initial_fields` to enrich the logging context. The [`logs` configuration
+options](https://github.com/open-telemetry/opentelemetry-collector/blob/v{{%
+param vers %}}/service/telemetry/config.go) are:
 
 - `level`: sets the minimum enabled logging level, default `INFO`.
 - `development`: puts the logger in development mode, default `false`.
@@ -635,17 +634,16 @@ The `metrics` subsection lets you configure how the metrics can be generated and
 exposed by the Collector. By default, the Collector generates basic metrics
 about itself and expose them for scraping at <http://127.0.0.1:8888/metrics>.
 You can expose the endpoint to a specific or even all network interfaces when
-needed. As per the `MetricsConfig` defined in v{{%
-param vers %}} [here](https://github.com/open-telemetry/opentelemetry-collector/blob/v{{%
-param vers %}}/service/telemetry/config.go), the `metrics` configuration options
-are:
+needed. The [`metrics` configuration
+options](https://github.com/open-telemetry/opentelemetry-collector/blob/v{{%
+param vers %}}/service/telemetry/config.go) are:
 
 - `level`: the level of telemetry metrics, default `basic`. The possible values
   are:
-  - "none" indicates that no telemetry data should be collected.
-  - "basic" is the recommended and covers the basics of the service telemetry.
-  - "normal" adds some other indicators on top of basic.
-  - "detailed" adds dimensions and views to the previous levels.
+  - `none`: no telemetry is collected.
+  - `basic`: essential service telemetry.
+  - `normal`: the default level, adds standard indicators on top of basic.
+  - `detailed`: the most verbose level, includes dimensions and views.
 - `address`: the `[address]:port` formatted URL that metrics exposition should
   be bound to. Default `127.0.0.1:8888`.
 
@@ -858,7 +856,7 @@ Install [`cfssl`](https://github.com/cloudflare/cfssl) and create the following
 
 Then run the following commands:
 
-```bash
+```sh
 cfssl genkey -initca csr.json | cfssljson -bare ca
 cfssl gencert -ca ca.pem -ca-key ca-key.pem csr.json | cfssljson -bare cert
 ```
@@ -880,14 +878,14 @@ define with this method are merged into the final configuration after all
 
 The following examples show how to override settings inside nested sections:
 
-```shell
-# The following example sets the verbosity
-# level of the debug exporter to 'detailed'
+```sh
 otelcol --set "exporters::debug::verbosity=detailed"
-# The following example overrides gRPC
-# settings for the OTLP receiver
 otelcol --set "receivers::otlp::protocols::grpc={endpoint:localhost:4317, compression: gzip}"
 ```
 
-Note tha the `--set` option doesn't support setting a key that contains a dot or
-an equal sign.
+{{% alert title="Important" color="warning" %}}
+
+The `--set` option doesn't support setting a key that contains a dot or an equal
+sign.
+
+{{% /alert %}}
diff --git a/content/en/docs/kubernetes/helm/operator.md b/content/en/docs/kubernetes/helm/operator.md
@@ -24,7 +24,7 @@ helm repo add open-telemetry https://open-telemetry.github.io/opentelemetry-helm
 helm install my-opentelemetry-operator open-telemetry/opentelemetry-operator \
   --set "manager.collectorImage.repository=otel/opentelemetry-collector-k8s" \
   --set admissionWebhooks.certManager.enabled=false \
-  --set admissionWebhooks.certManager.autoGenerateCert.enabled=true
+  --set admissionWebhooks.autoGenerateCert.enabled=true
 ```
 
 This will install an OpenTelemetry Operator with a self-signed certificate and

diff --git a/content/en/docs/languages/java/_index.md b/content/en/docs/languages/java/_index.md
@@ -7,7 +7,7 @@ aliases: [/java, /java/metrics, /java/tracing]
 cascade:
   vers:
     instrumentation: 2.3.0
-    otel: 1.37.0
+    otel: 1.38.0
     semconv: 1.25.0
 weight: 18
 ---

diff --git a/content/en/docs/languages/java/instrumentation.md b/content/en/docs/languages/java/instrumentation.md
@@ -650,7 +650,7 @@ public class Dice {
   }
 
   public Dice(int min, int max) {
-    this(min, max, OpenTelemetry.noop())
+    this(min, max, OpenTelemetry.noop());
   }
 
   // ...

diff --git a/content/zh/_index.md b/content/zh/_index.md
@@ -0,0 +1,90 @@
+---
+title: OpenTelemetry
+description: >-
+  高质量、普遍适用和可移植的遥测助你实现有效的可观测
+show_banner: true
+developer_note:
+  下文所用的 blocks/cover 短代码将使用文件名中包含 "background"
+  的图像文件作为背景图。
+cascade:
+  draft: true
+---
+
+<div class="d-none"><a rel="me" href="https://fosstodon.org/@opentelemetry"></a></div>
+
+{{< blocks/cover image_anchor="top" height="max" color="primary" >}}
+
+<!-- prettier-ignore -->
+![OpenTelemetry](/img/logos/opentelemetry-horizontal-color.svg)
+{.otel-logo}
+
+<!-- prettier-ignore -->
+{{% param description %}}
+{.display-6}
+
+<div class="l-primary-buttons mt-5">
+
+- [了解更多](/docs/what-is-opentelemetry/)
+- [尝试演示](/docs/demo/)
+- [探索集成组件](/ecosystem/integrations)
+
+</div>
+
+<div class="h3 mt-4">
+<a class="text-secondary" href="/docs/getting-started/">为各种角色定制的入门指南</a>
+</div>
+<div class="l-get-started-buttons">
+
+- [开发人员](/docs/getting-started/dev/)
+- [运维人员](/docs/getting-started/ops/)
+
+</div>
+{{< /blocks/cover >}}
+
+{{% blocks/lead color="white" %}}
+
+OpenTelemetry 是各类 API、SDK 和工具形成的集合。可用于仪表化、生成、采集和导出遥
+测数据（链路、指标和日志），帮助你分析软件的性能和行为。
+
+> OpenTelemetry 在[多种编程语言](/docs/languages/)均达到 **GA** 级别，普适性很高。
+
+{{% /blocks/lead %}}
+
+{{% blocks/section color="dark" type="row" %}}
+
+{{% blocks/feature icon="fas fa-chart-line" title="链路、指标、日志" %}}
+
+从你的服务和软件中创建并采集遥测数据，然后将其转发给各种分析工具。
+
+{{% /blocks/feature %}}
+
+{{% blocks/feature icon="fas fa-magic" title="即插即用仪表" %}}
+
+OpenTelemetry 与流行的库和框架集成，例如 [Spring](https://spring.io)、
+[ASP.NET Core](https://docs.microsoft.com/aspnet/core)、
+[Express](https://expressjs.com)、 [Quarkus](https://quarkus.io) 等等！
+安装和集成可能只需要几行代码。
+
+{{% /blocks/feature %}}
+
+{{% blocks/feature icon="fab fa-github" title="开源、厂商中立" %}}
+
+OpenTelemetry 是 100% 免费和开源的，
+得到了可观测性领域[众多行业领导者](/ecosystem/vendors/)的采用和支持。
+
+{{% /blocks/feature %}}
+
+{{% /blocks/section %}}
+
+{{% blocks/section color="secondary" type="cncf" %}}
+
+**OpenTelemetry 是一个 [CNCF][] [Incubating][] 项目**。<br> 这个项目是在合并
+OpenTracing 和 OpenCensus 项目之后成型的。
+
+[![CNCF logo][]][cncf]
+
+[cncf]: https://cncf.io
+[cncf logo]: /img/logos/cncf-white.svg
+[incubating]: https://www.cncf.io/projects/
+
+{{% /blocks/section %}}
diff --git a/data/ecosystem/vendors.yaml b/data/ecosystem/vendors.yaml
@@ -170,8 +170,8 @@
   commercial: true
 - name: ServiceNow Cloud Observability (Lightstep)
   nativeOTLP: true
-  url: https://github.com/lightstep?q=launcher
-  contact:
+  url: https://docs.lightstep.com/docs/about-sending-data
+  contact: https://github.com/cartersocha
   oss: false
   commercial: true
 - name: LogicMonitor

diff --git a/data/registry/collector-receiver-openllmetry.yml b/data/registry/collector-receiver-openllmetry.yml
@@ -0,0 +1,18 @@
+# cSpell:ignore openllmetry Instana
+title: OTel based Data Collector for LLM
+registryType: receiver
+language: java
+tags:
+  - java
+  - receiver
+  - collector
+license: MIT
+description:
+  OTel based Data Collector for LLM is the tool or template to generate
+  OpenTelemetry metrics for various LLM and LLM Applications. All implementation
+  are based on predefined OpenTelemetry Semantic Conventions.
+authors:
+  - name: IBM Instana
+urls:
+  repo: https://github.com/instana/otel-dc/tree/main/llm
+createdAt: 2024-05-07
diff --git a/data/registry/exporter-js-azure.yml b/data/registry/exporter-js-azure.yml
@@ -13,7 +13,7 @@ authors:
 package:
   name: '@azure/monitor-opentelemetry-exporter'
   registry: npm
-  version: 1.0.0-beta.22
+  version: 1.0.0-beta.23
 urls:
   repo: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/monitor/monitor-opentelemetry-exporter
 createdAt: 2021-11-01
diff --git a/data/registry/exporter-js-google-cloud-monitoring.yml b/data/registry/exporter-js-google-cloud-monitoring.yml
@@ -14,4 +14,4 @@ createdAt: 2020-04-01
 package:
   registry: npm
   name: '@google-cloud/opentelemetry-cloud-monitoring-exporter'
-  version: 0.17.0
+  version: 0.18.0
diff --git a/data/registry/exporter-js-google-cloud-trace.yml b/data/registry/exporter-js-google-cloud-trace.yml
@@ -14,4 +14,4 @@ createdAt: 2020-04-01
 package:
   registry: npm
   name: '@google-cloud/opentelemetry-cloud-trace-exporter'
-  version: 2.1.0
+  version: 2.2.0
diff --git a/data/registry/instrumentation-dotnet-kafkaflow.yml b/data/registry/instrumentation-dotnet-kafkaflow.yml
@@ -20,4 +20,4 @@ isFirstParty: true
 package:
   name: KafkaFlow.OpenTelemetry
   registry: nuget
-  version: 3.0.7
+  version: 3.8.0
diff --git a/data/registry/instrumentation-php-pdo.yml b/data/registry/instrumentation-php-pdo.yml
@@ -15,4 +15,4 @@ createdAt: 2023-05-22
 package:
   registry: packagist
   name: open-telemetry/opentelemetry-auto-pdo
-  version: 0.0.12
+  version: 0.0.13
diff --git a/data/registry/instrumentation-ruby-dalli.yml b/data/registry/instrumentation-ruby-dalli.yml
@@ -15,4 +15,4 @@ createdAt: 2020-11-09
 package:
   registry: gems
   name: opentelemetry-instrumentation-dalli
-  version: 0.25.1
+  version: 0.25.2
diff --git a/data/registry/instrumentation-ruby-ethon.yml b/data/registry/instrumentation-ruby-ethon.yml
@@ -15,4 +15,4 @@ createdAt: 2020-11-09
 package:
   registry: gems
   name: opentelemetry-instrumentation-ethon
-  version: 0.21.4
+  version: 0.21.5
diff --git a/data/registry/instrumentation-ruby-excon.yml b/data/registry/instrumentation-ruby-excon.yml
@@ -16,4 +16,4 @@ createdAt: 2020-11-09
 package:
   registry: gems
   name: opentelemetry-instrumentation-excon
-  version: 0.22.1
+  version: 0.22.2
diff --git a/data/registry/instrumentation-ruby-faraday.yml b/data/registry/instrumentation-ruby-faraday.yml
@@ -15,4 +15,4 @@ createdAt: 2020-11-09
 package:
   registry: gems
   name: opentelemetry-instrumentation-faraday
-  version: 0.24.2
+  version: 0.24.3
diff --git a/data/registry/instrumentation-ruby-http-client.yml b/data/registry/instrumentation-ruby-http-client.yml
@@ -14,4 +14,4 @@ createdAt: 2020-11-09
 package:
   registry: gems
   name: opentelemetry-instrumentation-http_client
-  version: 0.22.4
+  version: 0.22.5
diff --git a/data/registry/instrumentation-ruby-koala.yml b/data/registry/instrumentation-ruby-koala.yml
@@ -15,4 +15,4 @@ createdAt: 2020-11-09
 package:
   registry: gems
   name: opentelemetry-instrumentation-koala
-  version: 0.20.3
+  version: 0.20.4
diff --git a/data/registry/instrumentation-ruby-net-http.yml b/data/registry/instrumentation-ruby-net-http.yml
@@ -14,4 +14,4 @@ createdAt: 2020-11-09
 package:
   registry: gems
   name: opentelemetry-instrumentation-net_http
-  version: 0.22.4
+  version: 0.22.5
diff --git a/data/registry/instrumentation-ruby-pg.yml b/data/registry/instrumentation-ruby-pg.yml
@@ -16,4 +16,4 @@ createdAt: 2020-11-09
 package:
   registry: gems
   name: opentelemetry-instrumentation-pg
-  version: 0.27.2
+  version: 0.27.3
diff --git a/data/registry/instrumentation-ruby-rack.yml b/data/registry/instrumentation-ruby-rack.yml
@@ -14,4 +14,4 @@ createdAt: 2020-11-09
 package:
   registry: gems
   name: opentelemetry-instrumentation-rack
-  version: 0.24.2
+  version: 0.24.4
diff --git a/data/registry/instrumentation-ruby-rdkafka.yml b/data/registry/instrumentation-ruby-rdkafka.yml
@@ -18,4 +18,4 @@ createdAt: 2022-10-27
 package:
   registry: gems
   name: opentelemetry-instrumentation-rdkafka
-  version: 0.4.4
+  version: 0.4.5
diff --git a/data/registry/instrumentation-ruby-redis.yml b/data/registry/instrumentation-ruby-redis.yml
@@ -11,7 +11,7 @@ authors:
 package:
   registry: gems
   name: opentelemetry-instrumentation-redis
-  version: 0.25.4
+  version: 0.25.5
 urls:
   repo: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/redis
 createdAt: 2020-11-09
diff --git a/data/registry/instrumentation-ruby-restclient.yml b/data/registry/instrumentation-ruby-restclient.yml
@@ -15,4 +15,4 @@ createdAt: 2020-11-09
 package:
   registry: gems
   name: opentelemetry-instrumentation-restclient
-  version: 0.22.4
+  version: 0.22.5
diff --git a/data/registry/instrumentation-ruby-sidekiq.yml b/data/registry/instrumentation-ruby-sidekiq.yml
@@ -15,4 +15,4 @@ createdAt: 2020-11-09
 package:
   registry: gems
   name: opentelemetry-instrumentation-sidekiq
-  version: 0.25.3
+  version: 0.25.4
diff --git a/data/registry/instrumentation-ruby-sinatra.yml b/data/registry/instrumentation-ruby-sinatra.yml
@@ -15,4 +15,4 @@ createdAt: 2020-11-09
 package:
   registry: gems
   name: opentelemetry-instrumentation-sinatra
-  version: 0.23.3
+  version: 0.23.4
+0 −14		.github/workflows/checks.yaml
+51 −0		CHANGELOG.md
+0 −7		docfx.json
+3 −3		spec-compliance-matrix.md
+2 −3		specification/README.md
+1 −1		specification/common/README.md
+122 −20		specification/configuration/file-configuration.md
+6 −0		specification/logs/README.md
+5 −0		specification/logs/bridge-api.md
+5 −0		specification/logs/data-model-appendix.md
+11 −2		specification/logs/data-model.md
+5 −0		specification/logs/event-api.md
+2 −0		specification/logs/sdk.md
+2 −0		specification/logs/supplementary-guidelines.md
+17 −2		specification/metrics/api.md
+7 −0		specification/metrics/data-model.md
+5 −0		specification/metrics/noop.md
+12 −5		specification/metrics/sdk.md
+4 −0		specification/metrics/sdk_exporters/otlp.md
+1 −1		specification/metrics/sdk_exporters/prometheus.md
+3 −2		specification/trace/api.md
-Original file line number
+Diff line change
@@ Expand Up / @@ -650,7 +650,7 @@ public class Dice { @@
       }
       public Dice(int min, int max) {
-        this(min, max, OpenTelemetry.noop())
+        this(min, max, OpenTelemetry.noop());
       }
       // ...
@@ Expand Down @@