ghcr.io/open-telemetry/opentelemetry-operator/autoinstrumentation-nodejs:0.62.1

OpenTelemetry Operator for Kubernetes

OpenTelemetry Operator 是 Kubernetes Operator 的一种实现。

该 Operator 管理：

• https://github.com/open-telemetry/opentelemetry-collector
• 使用 OpenTelemetry instrumentation 库对工作负载进行 自动 instrumentation

文档

• 兼容性与支持文档
• API 文档
• OpenTelemetry Operator 官方页面

Helm 图表

您可以通过 opentelemetry-helm-charts 仓库中的 https://github.com/open-telemetry/opentelemetry-helm-charts/tree/main/charts/opentelemetry-operator 安装 OpenTelemetry Operator。更多信息请参见 https://github.com/open-telemetry/opentelemetry-helm-charts/tree/main/charts/opentelemetry-operator%E3%80%82

快速开始

要在现有集群中安装 Operator，请确保已安装 cert-manager，然后运行：

kubectl apply -f https://github.com/open-telemetry/opentelemetry-operator/releases/latest/download/opentelemetry-operator.yaml

当 opentelemetry-operator 部署就绪后，创建 OpenTelemetry Collector（otelcol）实例，例如：

配置验证

[!NOTE] 目前，Operator 不会验证配置文件的全部内容：如果配置无效，实例仍可能被创建，但底层 OpenTelemetry Collector 可能会崩溃。

Operator 会检查配置文件以实现以下几个目的：

• 发现已配置的接收器及其端口。如果发现带有端口的接收器，它会创建一对 Kubernetes 服务（一个为无头服务），在集群内暴露这些端口。如果端口使用环境变量扩展或无法解析，将返回错误。无头服务包含 service.beta.openshift.io/serving-cert-secret-name 注解，该注解会使 OpenShift 创建包含证书和密钥的 Secret。此 Secret 可作为卷挂载，并在这些接收器的 TLS 配置中使用证书和密钥。

• 检查是否启用了 Collector 可观测性（由 spec.observability.metrics.enableMetrics 控制）。在这种情况下，会为 Collector 实例创建 Service 和 ServiceMonitor/PodMonitor。因此，如果指标服务地址包含无效端口或对端口使用环境变量扩展，将返回错误。对于环境变量的情况，解决方法是将 enableMetrics 设置为 false，并在需要时手动创建具有正确端口的上述对象。

升级

如上所述，OpenTelemetry Collector 格式仍在不断发展。不过，会尽最大努力升级所有受管理的 OpenTelemetryCollector 资源。

在某些情况下，可能需要阻止 Operator 升级特定的 OpenTelemetryCollector 资源。例如，当资源配置了自定义 .Spec.Image 时，最终用户可能希望自己管理配置，而不是由 Operator 进行升级。可以通过暴露的 .Spec.UpgradeStrategy 属性为每个资源单独配置。

通过将资源的 .Spec.UpgradeStrategy 配置为 none，Operator 将在升级过程中跳过该实例。

.Spec.UpgradeStrategy 的默认值和唯一其他可接受值是 automatic。

部署模式

以下是每种部署模式的示例：

• Deployment
• DaemonSet
• StatefulSet
• Sidecar

边车注入

通过将 Pod 注解 sidecar.opentelemetry.io/inject 设置为 "true" 或具体 OpenTelemetryCollector 的名称，可以将带有 OpenTelemetry Collector 的边车注入基于 Pod 的工作负载，如下例所示：

kubectl apply -f -

• 创建 imagePullSecret。

kubectl create secret docker-registry --docker-server= \
--docker-username=DUMMY_USERNAME --docker-password=DUMMY_DOCKER_PASSWORD \
--docker-email=DUMMY_DOCKER_EMAIL

• 向服务账户添加镜像拉取密钥

kubectl patch serviceaccount -p '{"imagePullSecrets": [{"name": " "}]}'

OpenTelemetry 自动 instrumentation 注入

Operator 可以注入和配置 OpenTelemetry 自动 instrumentation 库。目前支持 Apache HTTPD、DotNet、Go、Java、Nginx、NodeJS 和 Python。

要使用自动 instrumentation，请配置带有 SDK 和 instrumentation 配置的 Instrumentation 资源。

kubectl apply -f -

[!NOTE] 对于 DotNet 自动 instrumentation，默认情况下，Operator 会设置 OTEL_DOTNET_AUTO_TRACES_ENABLED_INSTRUMENTATIONS 环境变量，该变量指定要启用的跟踪源 instrumentation 列表。Operator 默认设置的值是镜像中使用的 openTelemetry-dotnet-instrumentation 版本所支持的所有可用 instrumentation，即 AspNet,HttpClient,SqlClient。可以通过显式配置该环境变量来覆盖此值。

具有单一 instrumentation 的多容器 Pod

如果未指定其他内容，instrumentation 将对 Pod 规范中第一个可用容器（来自 .spec.containers，而非 init 容器）执行。在某些情况下（例如注入 Istio 边车时），需要指定必须对哪些容器执行此注入。

为此，可以微调将执行注入的 Pod。

为此，我们将使用 instrumentation.opentelemetry.io/container-names 注解，在该注解中指明一个或多个必须执行注入的容器名称（来自 .spec.containers.name 或 .spec.initContainers.name）：

apiVersion: apps/v1
kind: Deployment
metadata:
name: my-deployment-with-multiple-containers
spec:
selector:
matchLabels:
app: my-pod-with-multiple-containers
replicas: 1
template:
metadata:
labels:
app: my-pod-with-multiple-containers
annotations:
instrumentation.opentelemetry.io/inject-java: "true"
instrumentation.opentelemetry.io/container-names: "myapp,myapp2"
spec:
containers:
- name: myapp
image: myImage1
- name: myapp2
image: myImage2
- name: myapp3
image: myImage3

在上述情况下，myapp 和 myapp2 容器将被 instrumentation，myapp3 则不会。

对初始化容器进行 Instrumentation

可以通过在 container-names 注解中包含初始化容器的名称来对其进行 instrumentation。当目标初始化容器需要进行 instrumentation 时，Operator 会在 Pod 的初始化容器序列中，自动将 instrumentation 初始化容器插入到目标初始化容器之前。这确保了目标初始化容器运行时，instrumentation 代理文件已可用。

初始化容器支持的 instrumentation：

• Java
• Python
• Node.js
• .NET
• 仅 SDK 注入

初始化容器不支持的 instrumentation：

• Go（不支持多容器 Pod）
• Apache HTTPD
• Nginx

[!NOTE] Kubernetes 保证在 Pod 规范的 initContainers 和 containers 列表中，容器名称是唯一的。这使得 Operator 能够明确识别容器名称是指初始化容器还是常规容器。

同时对初始化容器和常规容器进行 instrumentation 的示例：

apiVersion: apps/v1
kind: Deployment
metadata:
name: my-deployment-with-init-container
spec:
selector:
matchLabels:
app: my-app
replicas: 1
template:
metadata:
labels:
app: my-app
annotations:
instrumentation.opentelemetry.io/inject-python: "true"
instrumentation.opentelemetry.io/container-names: "my-init-job,myapp"
spec:
initContainers:
- name: my-init-job
image: my-python-init-image
containers:
- name: myapp
image: my-python-app-image

在此示例中，my-init-job（初始化容器）和 myapp（常规容器）都将使用 Python 自动 instrumentation 进行处理。

目标分配器（Target Allocator）

OpenTelemetry Operator 包含一个可选组件——目标分配器（Target Allocator）（TA）。创建 OpenTelemetryCollector 自定义资源（CR）并启用 TA 后，Operator 将创建新的 Deployment 和 Service，为该 CR 中的每个 Collector Pod 提供特定的 http_sd_config 指令。它还会重写 CR 中的 Prometheus 接收器配置，以使其使用已部署的目标分配器。以下示例展示了如何开始使用目标分配器：

kubectl apply -f - <<EOF
apiVersion: opentelemetry.io/v1beta1
kind: OpenTelemetryCollector
metadata:
name: collector-with-ta
spec:
mode: statefulset
targetAllocator:
enabled: true
config:
receivers:
prometheus:
config:
scrape_configs:
- job_name: 'otel-collector'
scrape_interval: 10s
static_configs:
- targets: [ '0.0.0.0:8888' ]
metric_relabel_configs:
- action: labeldrop
regex: (id|name)
- action: labelmap
regex: label_(.+)
replacement: $1

exporters:
debug: {}

service:
pipelines:
metrics:
receivers: [prometheus]
exporters: [debug]
EOF

上述示例中替换键中 `# OpenTelemetry Operator for Kubernetes

OpenTelemetry Operator 是 Kubernetes Operator 的一种实现。

该 Operator 管理：

• https://github.com/open-telemetry/opentelemetry-collector
• 使用 OpenTelemetry instrumentation 库对工作负载进行 自动 instrumentation

文档

• 兼容性与支持文档
• API 文档
• OpenTelemetry Operator 官方页面

Helm 图表

您可以通过 opentelemetry-helm-charts 仓库中的 https://github.com/open-telemetry/opentelemetry-helm-charts/tree/main/charts/opentelemetry-operator 安装 OpenTelemetry Operator。更多信息请参见 https://github.com/open-telemetry/opentelemetry-helm-charts/tree/main/charts/opentelemetry-operator%E3%80%82

快速开始

要在现有集群中安装 Operator，请确保已安装 cert-manager，然后运行：

kubectl apply -f https://github.com/open-telemetry/opentelemetry-operator/releases/latest/download/opentelemetry-operator.yaml

当 opentelemetry-operator 部署就绪后，创建 OpenTelemetry Collector（otelcol）实例，例如：

配置验证

[!NOTE] 目前，Operator 不会验证配置文件的全部内容：如果配置无效，实例仍可能被创建，但底层 OpenTelemetry Collector 可能会崩溃。

Operator 会检查配置文件以实现以下几个目的：

• 发现已配置的接收器及其端口。如果发现带有端口的接收器，它会创建一对 Kubernetes 服务（一个为无头服务），在集群内暴露这些端口。如果端口使用环境变量扩展或无法解析，将返回错误。无头服务包含 service.beta.openshift.io/serving-cert-secret-name 注解，该注解会使 OpenShift 创建包含证书和密钥的 Secret。此 Secret 可作为卷挂载，并在这些接收器的 TLS 配置中使用证书和密钥。

• 检查是否启用了 Collector 可观测性（由 spec.observability.metrics.enableMetrics 控制）。在这种情况下，会为 Collector 实例创建 Service 和 ServiceMonitor/PodMonitor。因此，如果指标服务地址包含无效端口或对端口使用环境变量扩展，将返回错误。对于环境变量的情况，解决方法是将 enableMetrics 设置为 false，并在需要时手动创建具有正确端口的上述对象。

升级

如上所述，OpenTelemetry Collector 格式仍在不断发展。不过，会尽最大努力升级所有受管理的 OpenTelemetryCollector 资源。

在某些情况下，可能需要阻止 Operator 升级特定的 OpenTelemetryCollector 资源。例如，当资源配置了自定义 .Spec.Image 时，最终用户可能希望自己管理配置，而不是由 Operator 进行升级。可以通过暴露的 .Spec.UpgradeStrategy 属性为每个资源单独配置。

通过将资源的 .Spec.UpgradeStrategy 配置为 none，Operator 将在升级过程中跳过该实例。

.Spec.UpgradeStrategy 的默认值和唯一其他可接受值是 automatic。

部署模式

以下是每种部署模式的示例：

• Deployment
• DaemonSet
• StatefulSet
• Sidecar

边车注入

通过将 Pod 注解 sidecar.opentelemetry.io/inject 设置为 "true" 或具体 OpenTelemetryCollector 的名称，可以将带有 OpenTelemetry Collector 的边车注入基于 Pod 的工作负载，如下例所示：

kubectl apply -f -

• 创建 imagePullSecret。

kubectl create secret docker-registry --docker-server= \
--docker-username=DUMMY_USERNAME --docker-password=DUMMY_DOCKER_PASSWORD \
--docker-email=DUMMY_DOCKER_EMAIL

• 向服务账户添加镜像拉取密钥

kubectl patch serviceaccount -p '{"imagePullSecrets": [{"name": " "}]}'

OpenTelemetry 自动 instrumentation 注入

Operator 可以注入和配置 OpenTelemetry 自动 instrumentation 库。目前支持 Apache HTTPD、DotNet、Go、Java、Nginx、NodeJS 和 Python。

要使用自动 instrumentation，请配置带有 SDK 和 instrumentation 配置的 Instrumentation 资源。

kubectl apply -f -

[!NOTE] 对于 DotNet 自动 instrumentation，默认情况下，Operator 会设置 OTEL_DOTNET_AUTO_TRACES_ENABLED_INSTRUMENTATIONS 环境变量，该变量指定要启用的跟踪源 instrumentation 列表。Operator 默认设置的值是镜像中使用的 openTelemetry-dotnet-instrumentation 版本所支持的所有可用 instrumentation，即 AspNet,HttpClient,SqlClient。可以通过显式配置该环境变量来覆盖此值。

具有单一 instrumentation 的多容器 Pod

如果未指定其他内容，instrumentation 将对 Pod 规范中第一个可用容器（来自 .spec.containers，而非 init 容器）执行。在某些情况下（例如注入 Istio 边车时），需要指定必须对哪些容器执行此注入。

为此，可以微调将执行注入的 Pod。

为此，我们将使用 instrumentation.opentelemetry.io/container-names 注解，在该注解中指明一个或多个必须执行注入的容器名称（来自 .spec.containers.name 或 .spec.initContainers.name）：

apiVersion: apps/v1
kind: Deployment
metadata:
name: my-deployment-with-multiple-containers
spec:
selector:
matchLabels:
app: my-pod-with-multiple-containers
replicas: 1
template:
metadata:
labels:
app: my-pod-with-multiple-containers
annotations:
instrumentation.opentelemetry.io/inject-java: "true"
instrumentation.opentelemetry.io/container-names: "myapp,myapp2"
spec:
containers:
- name: myapp
image: myImage1
- name: myapp2
image: myImage2
- name: myapp3
image: myImage3

在上述情况下，myapp 和 myapp2 容器将被 instrumentation，myapp3 则不会。

对初始化容器进行 Instrumentation

可以通过在 container-names 注解中包含初始化容器的名称来对其进行 instrumentation。当目标初始化容器需要进行 instrumentation 时，Operator 会在 Pod 的初始化容器序列中，自动将 instrumentation 初始化容器插入到目标初始化容器之前。这确保了目标初始化容器运行时，instrumentation 代理文件已可用。

初始化容器支持的 instrumentation：

• Java
• Python
• Node.js
• .NET
• 仅 SDK 注入

初始化容器不支持的 instrumentation：

• Go（不支持多容器 Pod）
• Apache HTTPD
• Nginx

[!NOTE] Kubernetes 保证在 Pod 规范的 initContainers 和 containers 列表中，容器名称是唯一的。这使得 Operator 能够明确识别容器名称是指初始化容器还是常规容器。

同时对初始化容器和常规容器进行 instrumentation 的示例：

apiVersion: apps/v1
kind: Deployment
metadata:
name: my-deployment-with-init-container
spec:
selector:
matchLabels:
app: my-app
replicas: 1
template:
metadata:
labels:
app: my-app
annotations:
instrumentation.opentelemetry.io/inject-python: "true"
instrumentation.opentelemetry.io/container-names: "my-init-job,myapp"
spec:
initContainers:
- name: my-init-job
image: my-python-init-image
containers:
- name: myapp
image: my-python-app-image

在此示例中，my-init-job（初始化容器）和 myapp（常规容器）都将使用 Python 自动 instrumentation 进行处理。

目标分配器（Target Allocator）

OpenTelemetry Operator 包含一个可选组件——目标分配器（Target Allocator）（TA）。创建 OpenTelemetryCollector 自定义资源（CR）并启用 TA 后，Operator 将创建新的 Deployment 和 Service，为该 CR 中的每个 Collector Pod 提供特定的 http_sd_config 指令。它还会重写 CR 中的 Prometheus 接收器配置，以使其使用已部署的目标分配器。以下示例展示了如何开始使用目标分配器：

kubectl apply -f - <<EOF
apiVersion: opentelemetry.io/v1beta1
kind: OpenTelemetryCollector
metadata:
name: collector-with-ta
spec:
mode: statefulset
targetAllocator:
enabled: true
config:
receivers:
prometheus:
config:
scrape_configs:
- job_name: 'otel-collector'
scrape_interval: 10s
static_configs:
- targets: [ '0.0.0.0:8888' ]
metric_relabel_configs:
- action: labeldrop
regex: (id|name)
- action: labelmap
regex: label_(.+)
replacement: $1

exporters:
debug: {}

service:
pipelines:
metrics:
receivers: [prometheus]
exporters: [debug]
EOF

上述示例中替换键中 的使用基于 Prometheus 接收器 https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/prometheusreceiver/README.md 文档提供的信息，该文档指出：
注意：由于 Collector 配置支持环境变量替换，Prometheus 配置中的 $ 字符会被解释为环境变量。如果要在 Prometheus 配置中使用 $ 字符，必须使用 $ 进行转义。

在幕后，OpenTelemetry Operator 会在调和后将 Collector 的配置转换为以下内容：

receivers:
prometheus:
target_allocator:
endpoint: http://collector-with-ta-targetallocator:80
interval: 30s
collector_id: $POD_NAME

exporters:
debug:

service:
pipelines:
metrics:
receivers: [prometheus]
exporters: [debug]

OpenTelemetry Operator 还会在调和后将目标分配器的 Prometheus 配置转换为以下内容：

config:
scrape_configs:
- job_name: otel-collector
scrape_interval: 10s
static_configs:
- targets: ["0.0.0.0:8888"]
metric_relabel_configs:
- action: labeldrop
regex: (id|name)
- action: labelmap
regex: label_(.+)
replacement: $1

[!NOTE] 请注意，在这种情况下，Operator 会将替换键中的 "$$" 替换为单个 "$"。这是因为 Collector 支持环境变量替换，而 TA（目标分配器）不支持。因此，为确保兼容性，TA 配置应仅包含单个 "$" 符号。

有关 TargetAllocator 的更多信息，请参见 此处。

使用 Prometheus 自定义资源进行服务发现

目标分配器可以使用 prometheus-operator 生态系统中的自定义资源（如 ServiceMonitor 和 PodMonitor）进行服务发现，其功能类似于 prometheus-operator 本身。这可通过 Collector CR 中的 prometheusCR 部分启用。

以下是一个最小示例：

kubectl apply -f - <<EOF
apiVersion: opentelemetry.io/v1beta1
kind: OpenTelemetryCollector
metadata:
name: collector-with-ta-prometheus-cr
spec:
mode: statefulset
targetAllocator:
enabled: true
serviceAccount: everything-prometheus-operator-needs
prometheusCR:
enabled: true
serviceMonitorSelector: {}
podMonitorSelector: {}
scrapeClasses: []
config:
receivers:
prometheus:
config: {}

exporters:
debug: {}

service:
pipelines:
metrics:
receivers: [prometheus]
exporters: [debug]
EOF

scrapeClasses 属性引用 Prometheus Operator 的 ScrapeClass 功能。有关 scrape 类的更多信息，请参阅 [***]

设置资源属性的优先级

设置资源属性的优先级如下（找到的第一个值生效）：

1. 通过 OTEL_RESOURCE_ATTRIBUTES 和 OTEL_SERVICE_NAME 环境变量设置的资源属性
2. 通过注解（带有 resource.opentelemetry.io/ 前缀）设置的资源属性
3. 通过标签（例如 app.kubernetes.io/name）设置的资源属性（前提是 Instrumentation CR 的 defaults.useLabelsForResourceAttributes 为 true，见上文）
4. 从 Pod 元数据计算得出的资源属性（例如 k8s.pod.name）
5. 通过 Instrumentation CR（在 spec.resource.resourceAttributes 部分）设置的资源属性

此优先级针对每个资源属性单独应用，因此可以通过注解设置某些属性，通过标签设置其他属性。

如何从 Pod 元数据计算资源属性

以下资源属性是从 Pod 元数据计算得出的。

如何计算 service.name

选择找到的第一个值：

• pod.annotation[resource.opentelemetry.io/service.name]
• if (config[useLabelsForResourceAttributes]) pod.label[app.kubernetes.io/name]
• k8s.deployment.name
• k8s.replicaset.name
• k8s.statefulset.name
• k8s.daemonset.name
• k8s.cronjob.name
• k8s.job.name
• k8s.pod.name
• k8s.container.name

如何计算 service.version

选择找到的第一个值：

• pod.annotation[resource.opentelemetry.io/service.version]
• if (cfg[useLabelsForResourceAttributes]) pod.label[app.kubernetes.io/version]
• if (contains(container docker image tag, '/') == false) container docker image tag

如何计算 service.instance.id

选择找到的第一个值：

• pod.annotation[resource.opentelemetry.io/service.instance.id]
• concat([k8s.namespace.name, k8s.pod.name, k8s.container.name], '.')

如何计算 service.namespace

选择找到的第一个值：

• pod.annotation[resource.opentelemetry.io/service.namespace]
• k8s.namespace.name