配置 Collector
使用接收器、处理器、导出器、连接器和扩展设置遥测数据管道
摘要
第 1 章 配置 Collector 复制链接链接已复制到粘贴板!
红帽构建的 OpenTelemetry Operator 使用自定义资源定义(CRD)文件来定义创建和部署分布式追踪平台 (Tempo) 资源时要使用的架构和配置设置。您可以安装默认配置或修改该文件。
1.1. 部署模式 复制链接链接已复制到粘贴板!
OpenTelemetryCollector 自定义资源允许您为 OpenTelemetry Collector 指定以下部署模式之一:
- Deployment
- 默认。
- StatefulSet
- 如果您需要运行有状态工作负载,例如使用 Collector 的 File Storage Extension 或 Tail Sampling Processor 时,请使用 StatefulSet 部署模式。
- DaemonSet
- 如果您需要从每个节点中提取遥测数据,例如使用 Collector 的 Filelog Receiver 来读取容器日志,请使用 DaemonSet 部署模式。
- Sidecar
如果您需要访问容器内的日志文件,请将 Collector 注入 sidecar,并使用 Collector 的 Filelog Receiver 和共享卷,如
emptyDir。如果您需要将应用程序配置为通过
localhost发送遥测数据,请将 Collector 注入 sidecar,并设置 Collector 通过加密和经过身份验证的连接将遥测数据转发到外部服务。当作为 sidecar 注入时,Collector 会与应用程序在同一 pod 中运行。注意如果选择 sidecar 部署模式,那么除了在
OpenTelemetryCollector自定义资源 CR 中设置spec.mode: sidecar字段外,还必须将sidecar.opentelemetry.io/inject注解设置为 pod 注解或命名空间注解。如果在 pod 和命名空间上设置了此注解,如果 pod 注解被设置为false或OpenTelemetryCollectorCR 名称,则 pod 注解会优先使用。作为 pod 注解,
sidecar.opentelemetry.io/inject注解支持几个值:Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- 支持的值:
false- 不注入 Collector。如果缺少注解,这是默认设置。
true-
使用同一命名空间中的
OpenTelemetryCollectorCR 配置注入 Collector。 <collector_name>-
使用同一命名空间中的
<collector_name>OpenTelemetryCollectorCR 配置注入 Collector。 <namespace>/<collector_name>-
使用
<namespace>命名空间中的<collector_name>OpenTelemetryCollectorCR 配置注入 Collector。
1.2. OpenTelemetry Collector 配置选项 复制链接链接已复制到粘贴板!
OpenTelemetry Collector 由访问遥测数据的一组组件组成:
- Receivers
- Processors
- Exporters
- 连接器
- 扩展
您可以在自定义资源 YAML 文件中定义多个组件实例。配置后,必须通过 YAML 文件的 spec.config.service 部分中定义的管道启用这些组件。作为最佳实践,仅启用您需要的组件。
OpenTelemetry Collector 自定义资源文件示例
- 1
- 如果一个组件被配置但没有在
service部分中定义,则组件不会被启用。
| 参数 | 描述 | 值 | default |
|---|---|---|---|
receivers:
| 接收器用于控制数据如何进入 Collector。默认情况下,不会配置接收器。必须至少有一个启用的接收器才能使配置被视为有效。接收器通过添加到管道中来启用。 |
| None |
processors:
| 处理器在导出前会处理接收的数据。默认情况下,不启用处理器。 |
| None |
exporters:
| 导出器将数据发送到一个或多个后端或目的地。默认情况下,不会配置导出器。必须至少启用了一个 exporter 时,配置才被视为有效。将导出器添加到管道中即可启用。导出器可能会与其默认设置一起使用,但很多需要配置至少指定目标和安全设置。 |
| None |
connectors:
| 连接器通过将数据作为管道导出器来加入管道对,并将数据作为 Start-of-pipeline 接收器发送。连接器可用于总结、复制或路由消耗的数据。 |
| None |
extensions:
| 不涉及处理遥测数据的任务的可选组件。 |
| None |
service: pipelines:
|
组件通过将组件添加到 | ||
service:
pipelines:
traces:
receivers:
|
您可以通过在 | 无 | |
service:
pipelines:
traces:
processors:
|
您可以通过在 | 无 | |
service:
pipelines:
traces:
exporters:
|
您可以通过在 | None | |
service:
pipelines:
metrics:
receivers:
|
您可以通过在 | None | |
service:
pipelines:
metrics:
processors:
|
您可以通过在 | None | |
service:
pipelines:
metrics:
exporters:
|
您可以通过在 | None |
1.3. 配置集信号 复制链接链接已复制到粘贴板!
Profile 信号是一个新兴的遥测数据格式,用于观察代码执行和资源消耗。
Profile 信号只是一个技术预览功能。技术预览功能不受红帽产品服务等级协议(SLA)支持,且功能可能并不完整。红帽不推荐在生产环境中使用它们。这些技术预览功能可以使用户提早试用新的功能,并有机会在开发阶段提供反馈意见。
有关红帽技术预览功能支持范围的更多信息,请参阅技术预览功能支持范围。
Profile 信号允许您将代码低到特定功能。通过这种性能分析,您可以精确识别性能瓶颈,并将资源效率降低到特定的代码行。通过将此类高风险配置集数据与 trace、metrics 和 logs 进行比较,它可以在生产环境中启用全面的性能分析和目标代码优化。
分析可以针对应用程序或操作系统:
- 使用性能分析来观察应用,帮助开发人员验证代码性能、防止回归和监控资源消耗,如内存和 CPU 使用量,从而识别并改进低效的代码。
- 使用性能分析观察操作系统可以深入了解基础架构、系统调用、内核操作和 I/O 等待时间,这有助于优化基础架构以提高效率和节约成本。
带有启用的 Profile 信号的 OpenTelemetry Collector 自定义资源
1.4. 自动创建所需的 RBAC 资源 复制链接链接已复制到粘贴板!
有些 Collector 组件需要配置 RBAC 资源。
流程
在
opentelemetry-operator-controller-manage服务帐户中添加以下权限,以便红帽构建的 OpenTelemetry Operator 可以自动创建它们:Copy to Clipboard Copied! Toggle word wrap Toggle overflow
1.5. 目标分配器 复制链接链接已复制到粘贴板!
目标分配器是 OpenTelemetry Operator 的一个可选组件,它会在部署的 OpenTelemetry Collector 实例间分片提取目标。目标分配器与 Prometheus PodMonitor 和 ServiceMonitor 自定义资源 (CR) 集成。启用目标分配器时,OpenTelemetry Operator 会将 http_sd_config 字段添加到连接到目标分配器服务的启用的 prometheus 接收器。
目标分配器只是一个技术预览功能。技术预览功能不受红帽产品服务等级协议(SLA)支持,且功能可能并不完整。红帽不推荐在生产环境中使用它们。这些技术预览功能可以使用户提早试用新的功能,并有机会在开发阶段提供反馈意见。
有关红帽技术预览功能支持范围的更多信息,请参阅技术预览功能支持范围。
带有启用的 Target Allocator 的 OpenTelemetryCollector CR 示例
- 1
- 启用 Target Allocator 时,部署模式必须设置为
statefulset。 - 2
- 启用目标分配器。默认值为
false。 - 3
- Target Allocator 部署的服务帐户名称。服务帐户需要具有 RBAC 才能从集群中获取
ServiceMonitor、PodMonitor自定义资源和其他对象,以便在提取的指标上正确设置标签。默认服务名称为<collector_name>-targetallocator。 - 4
- 启用与 Prometheus
PodMonitor和ServiceMonitor自定义资源集成。 - 5
- Prometheus
ServiceMonitor自定义资源的标签选择器。当留空时,请启用所有服务监视器。 - 6
- Prometheus
PodMonitor自定义资源的标签选择器。留空时,启用所有 pod 监视器。 - 7
- Prometheus 接收器带有 minimal, empty
scrape_config: []配置选项。
Target Allocator 部署使用 Kubernetes API 从集群中获取相关对象,因此它需要自定义 RBAC 配置。
目标 Allocator 服务帐户的 RBAC 配置
第 2 章 Receivers 复制链接链接已复制到粘贴板!
接收器将数据放入 Collector 中。接收器可以基于推送或拉取 (pull)。通常,接收器接受指定格式的数据,将其转换为内部格式,并将其传递给适用管道中定义的处理器和导出器。默认情况下,不会配置接收器。必须配置一个或多个接收器。接收器可以支持一个或多个数据源。
目前,红帽构建的 OpenTelemetry 提供了以下正式发行(GA)和技术预览接收器:
2.1. OTLP Receiver 复制链接链接已复制到粘贴板!
使用 OpenTelemetry Protocol (OTLP) 的 OTLP Receiver ingests traces, metrics, 和日志。
启用了 OTLP Receiver 的 OpenTelemetry Collector 自定义资源
- 1
- OTLP gRPC 端点。如果省略,则使用默认的
0.0.0.0:4317。 - 2
- 服务器端 TLS 配置。定义 TLS 证书的路径。如果省略,则禁用 TLS。
- 3
- 服务器验证客户端证书的 TLS 证书的路径。这会将
TLSConfig中的ClientCAs和ClientAuth的值设置为RequireAndVerifyClientCert。如需更多信息,请参阅 Golang TLS 软件包的配置。 - 4
- 指定重新载入证书的时间间隔。如果没有设置值,则证书永远不会重新加载。
reload_interval字段接受包含有效时间单位的字符串,如ns、us、ms、s、m、h。 - 5
- OTLP HTTP 端点。默认值为
0.0.0.0:4318。 - 6
- 服务器端 TLS 配置。如需更多信息,请参阅
grpc协议配置部分。
2.2. Jaeger Receiver 复制链接链接已复制到粘贴板!
Jaeger Receiver ingests trace 使用 Jaeger 格式。
启用了 Jaeger Receiver 的 OpenTelemetry Collector 自定义资源
2.3. 主机指标接收器 复制链接链接已复制到粘贴板!
OTLP 格式的 Host Metrics Receiver ingests metrics。
启用了 Host Metrics Receiver 的 OpenTelemetry Collector 自定义资源
- 1
- 设置主机指标集合的时间间隔。如果没有指定,则默认值为
1m。 - 2
- 为主机指标集合设置初始的时间延迟。如果没有指定,则默认值为
1s。 - 3
- 配置
root_path,以便 Host Metrics Receive 知道 root 文件系统的位置。如果运行多个 Host Metrics Receiver 实例,需要为每个实例设置相同的root_path值。 - 4
- 列出启用的 host metrics scraper。可用的 scraper 为
cpu,disk,load,filesystem,memory,network,paging,processes, 和process。
2.4. Kubernetes Objects Receiver 复制链接链接已复制到粘贴板!
Kubernetes Objects Receiver 拉取或监视要从 Kubernetes API 服务器收集的对象。此接收器主要监视 Kubernetes 事件,但可以收集任何类型的 Kubernetes 对象。此接收器会收集整个集群的遥测数据,因此只需要一个接收器实例就可以收集所有数据。
Kubernetes Objects Receiver 只是一个技术预览功能。技术预览功能不受红帽产品服务等级协议(SLA)支持,且功能可能并不完整。红帽不推荐在生产环境中使用它们。这些技术预览功能可以使用户提早试用新的功能,并有机会在开发阶段提供反馈意见。
有关红帽技术预览功能支持范围的更多信息,请参阅技术预览功能支持范围。
启用了 Kubernetes Objects Receiver 的 OpenTelemetry Collector 自定义资源
2.5. kubelet Stats Receiver 复制链接链接已复制到粘贴板!
Kubelet Stats Receiver 从 kubelet 的 API 服务器中提取与节点、Pod、容器和卷相关的指标。然后,这些指标通过 metrics-processing 管道进行额外的分析。
启用了 Kubelet Stats Receiver 的 OpenTelemetry Collector 自定义资源
- 1
- 设置
K8S_NODE_NAME以向 API 进行身份验证。
对于用于运行 OpenTelemetry Collector 的服务帐户,Kubelet Stats Receiver 需要额外权限。
服务帐户所需的权限
- 1
- 使用
extra_metadata_labels或request_utilization或limit_utilization指标时所需的权限。
2.6. Prometheus Receiver 复制链接链接已复制到粘贴板!
Prometheus Receiver 提取指标端点。
启用了 Prometheus Receiver 的 OpenTelemetry Collector 自定义资源
2.7. OTLP JSON File Receiver 复制链接链接已复制到粘贴板!
OTLP JSON 文件 Receiver 从包含 ProtoJSON 格式的数据的文件中提取管道信息,并符合 OpenTelemetry 协议规格。接收器会监视指定的目录,以了解创建或修改的文件要处理的更改。
OTLP JSON 文件接收器只是一个技术预览功能。技术预览功能不受红帽产品服务等级协议(SLA)支持,且功能可能并不完整。红帽不推荐在生产环境中使用它们。这些技术预览功能可以使用户提早试用新的功能,并有机会在开发阶段提供反馈意见。
有关红帽技术预览功能支持范围的更多信息,请参阅技术预览功能支持范围。
OpenTelemetry Collector 自定义资源带有启用的 OTLP JSON File Receiver
2.8. Zipkin Receiver 复制链接链接已复制到粘贴板!
Zipkin Receiver ingests traces 使用 Zipkin v1 和 v2 格式。
启用了 Zipkin Receiver 的 OpenTelemetry Collector 自定义资源
2.9. Kafka Receiver 复制链接链接已复制到粘贴板!
Kafka 接收器以 OTLP 格式接收 Kafka 中的 trace、metrics 和日志。
Kafka Receiver 只是一个技术预览功能。技术预览功能不受红帽产品服务等级协议(SLA)支持,且功能可能并不完整。红帽不推荐在生产环境中使用它们。这些技术预览功能可以使用户提早试用新的功能,并有机会在开发阶段提供反馈意见。
有关红帽技术预览功能支持范围的更多信息,请参阅技术预览功能支持范围。
启用了 Kafka Receiver 的 OpenTelemetry Collector 自定义资源
2.10. Kubernetes Cluster Receiver 复制链接链接已复制到粘贴板!
Kubernetes Cluster Receiver 从 Kubernetes API 服务器收集集群指标和实体事件。它使用 Kubernetes API 接收有关更新的信息。对此接收器的身份验证只支持使用服务账户。
Kubernetes Cluster Receiver 只是一个技术预览功能。技术预览功能不受红帽产品服务等级协议(SLA)支持,且功能可能并不完整。红帽不推荐在生产环境中使用它们。这些技术预览功能可以使用户提早试用新的功能,并有机会在开发阶段提供反馈意见。
有关红帽技术预览功能支持范围的更多信息,请参阅技术预览功能支持范围。
启用了 Kubernetes Cluster Receiver 的 OpenTelemetry Collector 自定义资源
此接收器需要配置服务帐户、集群角色的 RBAC 规则,以及将 RBAC 与服务帐户绑定的集群角色绑定。
ServiceAccount 对象
ClusterRole 对象的 RBAC 规则
ClusterRoleBinding 对象
2.11. OpenCensus Receiver 复制链接链接已复制到粘贴板!
OpenCensus Receiver 与 OpenCensus 项目向后兼容性,以便更轻松地迁移检测代码库。它以 OpenCensus 格式通过 gRPC 或 HTTP 和 JSON 接收指标和追踪。
OpenCensus Receiver 已被弃用,可能在以后的版本中删除。
启用了 OpenCensus Receiver 的 OpenTelemetry Collector 自定义资源
2.12. Filelog Receiver 复制链接链接已复制到粘贴板!
Filelog Receiver tail 并解析来自文件的日志。
Filelog Receiver 只是一个技术预览功能。技术预览功能不受红帽产品服务等级协议(SLA)支持,且功能可能并不完整。红帽不推荐在生产环境中使用它们。这些技术预览功能可以使用户提早试用新的功能,并有机会在开发阶段提供反馈意见。
有关红帽技术预览功能支持范围的更多信息,请参阅技术预览功能支持范围。
带有启用的 Filelog Receiver 的 OpenTelemetry Collector 自定义资源,它 tails 一个文本文件
您可以通过以下两种方式之一从 pod 文件系统收集日志:
- 在与应用程序 pod 一起运行的 sidecar 容器中配置接收器。
- 将接收器部署为主机上具有适当权限访问 Kubernetes 日志的 DaemonSet。
要从应用程序容器收集日志,您可以使用带有 sidecar 注入的接收器。红帽构建的 OpenTelemetry Operator 允许将 OpenTelemetry Collector 作为 sidecar 容器注入应用程序 pod。当应用程序将日志写入容器文件系统中的文件时,这种方法很有用。然后,此接收器可以跟踪日志文件并应用操作器来解析日志。
要在 sidecar 模式中使用此接收器从应用程序容器收集日志,您必须在 OpenTelemetryCollector 自定义资源中配置卷挂载。应用程序容器和 sidecar Collector 必须挂载相同的共享卷,如 emptyDir。在应用的 Pod 规格中定义卷。请参见以下示例:
OpenTelemetry Collector 自定义资源使用在 sidecar 模式中配置的 Filelog Receiver
2.13. Journald Receiver 复制链接链接已复制到粘贴板!
Journald Receiver 解析来自 systemd journal 的 journald 事件,并将它们作为日志发送。
Journald Receiver 只是一个技术预览功能。技术预览功能不受红帽产品服务等级协议(SLA)支持,且功能可能并不完整。红帽不推荐在生产环境中使用它们。这些技术预览功能可以使用户提早试用新的功能,并有机会在开发阶段提供反馈意见。
有关红帽技术预览功能支持范围的更多信息,请参阅技术预览功能支持范围。
启用了 Journald Receiver 的 OpenTelemetry Collector 自定义资源
- 1
- 按消息优先级或优先级范围过滤输出。默认值为
info。 - 2
- 列出要从中读取条目的单元。如果为空,则从所有单元读取条目。
- 3
- 包含非常长的日志,以及带有不可打印字符的日志。默认值为
false。 - 4
- 如果设置为
true,则接收器会暂停读取文件,并在遇到下游组件错误时尝试重新发送当前的批处理日志。默认值为false。 - 5
- 在第一次失败后进行重现尝试需要等待的时间间隔。默认值为
1s。单位是ms、s、m、h。 - 6
- 重试 backoff 间隔的上限。当达到这个值时,连续重试尝试之间的时间间隔会恒定保持这个值。默认值为
30s。支持的单位是ms、s、m、h。 - 7
- 尝试将日志批处理发送到下游消费者的最大时间间隔,包括重试尝试。达到这个值时,数据将被丢弃。如果设置的值是
0,重试永远不会停止。默认值为5m。支持的单位是ms、s、m、h。
2.14. Kubernetes Events Receiver 复制链接链接已复制到粘贴板!
Kubernetes Events Receiver 从 Kubernetes API 服务器收集事件。收集的事件被转换为日志。
Kubernetes Events Receiver 只是一个技术预览功能。技术预览功能不受红帽产品服务等级协议(SLA)支持,且功能可能并不完整。红帽不推荐在生产环境中使用它们。这些技术预览功能可以使用户提早试用新的功能,并有机会在开发阶段提供反馈意见。
有关红帽技术预览功能支持范围的更多信息,请参阅技术预览功能支持范围。
Kubernetes Events Receiver 所需的 OpenShift Container Platform 权限
启用了 Kubernetes Event Receiver 的 OpenTelemetry Collector 自定义资源
2.15. Prometheus Remote Write Receiver 复制链接链接已复制到粘贴板!
Prometheus Remote Write Receiver 使用 Remote Write 协议从 Prometheus 接收指标,并将其转换为 OpenTelemetry 格式。此接收器只支持 Prometheus Remote Write v2 协议。
Prometheus Remote Write Receiver 只是一个技术预览功能。技术预览功能不受红帽产品服务等级协议(SLA)支持,且功能可能并不完整。红帽不推荐在生产环境中使用它们。这些技术预览功能可以使用户提早试用新的功能,并有机会在开发阶段提供反馈意见。
有关红帽技术预览功能支持范围的更多信息,请参阅技术预览功能支持范围。
OpenTelemetry Collector 自定义资源带有启用的 Prometheus Remote Write Receiver
- 1
- 接收器侦听 Prometheus Remote Write 请求的端点。
以下是将此接收器与 Prometheus 搭配使用的先决条件:
- Prometheus 在启用了元数据 WAL 记录功能标记的情况下启动。
- Prometheus Remote Write v2 协议在 Prometheus 远程写入配置中被启用。
- 使用功能标记在 Prometheus 中启用了原生直方图。
- Prometheus 被配置为将经典直方图转换为原生直方图。
有关启用这些 Prometheus 功能的更多信息,请参阅 Prometheus 文档。
第 3 章 Processors 复制链接链接已复制到粘贴板!
处理器处理接收和导出的数据。处理器是可选的。默认情况下,不启用处理器。每个数据源都必须启用处理器。不是所有处理器都支持所有数据源。根据数据源,可能会启用多个处理器。请注意,处理器的顺序很重要。
目前,红帽构建的 OpenTelemetry 提供了以下正式发行(GA)和技术预览处理器:
3.1. Batch Processor 复制链接链接已复制到粘贴板!
Batch Processor 会批处理跟踪和指标,以减少传输遥测信息所需的传出连接数量。
使用 Batch Processor 时 OpenTelemetry Collector 自定义资源示例
| 参数 | 描述 | default |
|---|---|---|
|
| 将批处理发送到特定的持续时间,无论批处理大小如何。 |
|
|
| 在指定数量的 span 或 metrics 后发送遥测数据的批处理。 |
|
|
|
批处理的最大允许大小。必须等于或大于 |
|
|
|
激活后,会为在 |
|
|
|
在填充 |
|
3.2. Memory Limiter Processor 复制链接链接已复制到粘贴板!
Memory Limiter Processor 定期检查 Collector 的内存用量,并在达到软内存限制时暂停数据处理。这个处理器支持 trace、metrics 和 logs。前面的组件(通常是接收器)应该重试发送同一数据,并可能对传入的数据应用回溯。当内存用量超过硬限制时,Memory Limiter Processor 会强制运行垃圾回收操作。
使用 Memory Limiter Processor 时 OpenTelemetry Collector 自定义资源示例
| 参数 | 描述 | default |
|---|---|---|
|
|
内存用量测量之间的时间。最佳值为 |
|
|
| 硬限制,即堆上分配的最大内存量(以 MiB 为单位)。通常,OpenTelemetry Collector 的内存用量大约比这个值高 50 MiB。 |
|
|
|
spike 限制,这是 MiB 中内存使用率最大激增。最佳值为 |
|
|
|
与 |
|
|
|
与 |
|
3.3. Resource Detection Processor 复制链接链接已复制到粘贴板!
Resource Detection Processor 识别主机资源详情与 OpenTelemetry 的资源语义标准保持一致。使用检测到的信息,此处理器可以在遥测数据中添加或替换资源值。这个处理器支持 trace 和 metrics。您可以将这个处理器与多个检测器一起使用,如 Docket 元数据检测器或 OTEL_RESOURCE_ATTRIBUTES 环境变量检测器。
Resource Detection Processor 只是一个技术预览功能。技术预览功能不受红帽产品服务等级协议(SLA)支持,且功能可能并不完整。红帽不推荐在生产环境中使用它们。这些技术预览功能可以使用户提早试用新的功能,并有机会在开发阶段提供反馈意见。
有关红帽技术预览功能支持范围的更多信息,请参阅技术预览功能支持范围。
Resource Detection Processor 所需的 OpenShift Container Platform 权限
使用 Resource Detection Processor 的 OpenTelemetry Collector
OpenTelemetry Collector 使用带有环境变量检测器的资源检测器
- 1
- 指定要使用的检测器。在本例中,指定了环境检测器。
3.4. Attributes Processor 复制链接链接已复制到粘贴板!
Attributes Processor 可以修改 span, log, 或 metric 的属性。您可以配置此处理器来过滤和匹配输入数据,并为特定操作包含或排除此类数据。
处理器对操作列表进行操作,按配置中指定的顺序执行它们。支持以下操作:
- insert
- 当指定的键尚不存在时,将新属性插入到输入数据中。
- Update(更新)
- 如果密钥已存在,更新输入数据中的属性。
- Upsert
- 合并 insert 和 update 操作:如果键尚不存在,则插入新属性。如果密钥已存在,则更新 属性。
- 删除
- 从输入数据中删除属性。
- Hash
- 将现有属性值哈希为 SHA1。
- extract
-
通过使用输入键的正则表达式规则将值提取到规则中定义的目标键。如果目标键已存在,它将被像使用现有属性作为源的 Span 处理器
to_attributes设置一样覆盖。 - Convert
- 将现有属性转换为指定类型。
OpenTelemetry Collector 使用 ttributes Processor
3.5. Resource Processor 复制链接链接已复制到粘贴板!
Resource Processor 应用对资源属性的更改。这个处理器支持 trace、metrics 和 logs。
使用 Resource Processor 的 OpenTelemetry 收集器
属性代表应用到资源属性的操作,如删除属性、插入属性或 upsert 属性。
3.6. Span Processor 复制链接链接已复制到粘贴板!
Span Processor 根据其属性修改 span 名称,或者从 span 名称中提取 span 属性。此处理器也可以更改 span 状态,并包含或排除 span。这个处理器支持 trace。
span rename 需要使用 from_attributes 配置为新名称指定属性。
Span Processor 只是一个技术预览功能。技术预览功能不受红帽产品服务等级协议(SLA)支持,且功能可能并不完整。红帽不推荐在生产环境中使用它们。这些技术预览功能可以使用户提早试用新的功能,并有机会在开发阶段提供反馈意见。
有关红帽技术预览功能支持范围的更多信息,请参阅技术预览功能支持范围。
OpenTelemetry Collector 使用 Span Processor 重命名 span
您可以使用处理器从 span 名称中提取属性。
OpenTelemetry Collector 使用 Span Processor 从范围名称中提取属性
- 1
- 此规则定义如何执行提取。您可以定义更多规则:例如,如果正则表达式与名称匹配,则会创建一个
documentID属性。在本例中,如果输入 span 名称是/api/v1/document/12345678/update,则会产生/api/v1/document/{documentId}/update输出 span 名称,并且新的"documentId"="12345678"属性被添加到 span 中。
您可以修改 span 状态。
OpenTelemetry Collector 使用 Span Processor 进行状态更改
3.7. Kubernetes Attributes Processor 复制链接链接已复制到粘贴板!
Kubernetes Attributes Processor 使用 Kubernetes 元数据启用 span、metrics 和 log 资源属性的自动配置。这个处理器支持 trace、metrics 和 logs。此处理器自动识别 Kubernetes 资源,从它们中提取元数据,并将此提取的元数据作为资源属性合并到相关的 span、metrics 和 logs 中。它使用 Kubernetes API 来发现在集群内运行的所有 pod,维护其 IP 地址、pod UID 和其他相关元数据的记录。
Kubernetes Attributes Processor 所需的最小 OpenShift Container Platform 权限
OpenTelemetry Collector 使用 Kubernetes Attributes Processor
3.8. Filter Processor 复制链接链接已复制到粘贴板!
Filter Processor 利用 OpenTelemetry Transformation Language 来建立丢弃遥测数据的条件。如果满足这些条件,遥测数据将被丢弃。您可以使用逻辑 OR 运算符对多个条件进行组合。这个处理器支持 trace、metrics 和 logs。
Filter Processor 只是一个技术预览功能。技术预览功能不受红帽产品服务等级协议(SLA)支持,且功能可能并不完整。红帽不推荐在生产环境中使用它们。这些技术预览功能可以使用户提早试用新的功能,并有机会在开发阶段提供反馈意见。
有关红帽技术预览功能支持范围的更多信息,请参阅技术预览功能支持范围。
OpenTelemetry Collector 自定义资源带有启用的 Filter Processor
3.9. Cumulative-to-Delta Processor 复制链接链接已复制到粘贴板!
Cumulative-to-Delta Processor 将 monotonic、cumulative-sum 和 histogram 指标转换为 monotonic delta 指标。
您可以使用 include: 或 exclude: 字段过滤指标,并指定 strict 或 regexp 进行名称匹配。
由于此处理器通过存储指标先前的值来计算 delta,所以您必须设置指标源,以将指标数据发送到单个有状态收集器实例,而不是部署多个 Collector。
这个处理器不会转换非单调和以及指数直方图。
Cumulative-to-Delta Processor 只是一个技术预览功能。技术预览功能不受红帽产品服务等级协议(SLA)支持,且功能可能并不完整。红帽不推荐在生产环境中使用它们。这些技术预览功能可以使用户提早试用新的功能,并有机会在开发阶段提供反馈意见。
有关红帽技术预览功能支持范围的更多信息,请参阅技术预览功能支持范围。
带有启用了 Cumulative-to-Delta Processor 的 OpenTelemetry Collector 自定义资源示例
- 1
- 要将 Collector 的生命周期绑定到指标源,您可以将 Collector 作为 sidecar 运行,来向发送累积时序指标的应用程序运行。
- 2
- 可选:您可以通过在此片段中明确定义您要转换的指标来限制处理器转换的指标数据。如果省略此字段,处理器会转换所有指标,但
exclude字段中列出的指标除外。 - 3
- 定义
metrics字段提供的值(使用strict参数作为一个完全准确匹配;使用regex参数作为一个正则表达式)。 - 4
- 列出您要转换的指标的名称。处理器对正则表达式进行完全准确匹配或一般匹配。如果指标与
include和exclude过滤都匹配,则exclude过滤具有更高的优先权。 - 5
- 可选:您可以通过在此处明确定义,从转换中排除某些指标。
3.10. Group-by-Attributes Processor 复制链接链接已复制到粘贴板!
Group-by-Attributes Processor 组所有 span、logging 记录和指标数据点,通过将其重新分配给与这些属性匹配的资源。
Group-by-Attributes Processor 只是一个技术预览功能。技术预览功能不受红帽产品服务等级协议(SLA)支持,且功能可能并不完整。红帽不推荐在生产环境中使用它们。这些技术预览功能可以使用户提早试用新的功能,并有机会在开发阶段提供反馈意见。
有关红帽技术预览功能支持范围的更多信息,请参阅技术预览功能支持范围。
至少配置此处理器涉及指定要将 span、日志记录或指标数据点分组在一起的属性键数组,如下例所示:
使用 Group-by-Attributes Processor 时 OpenTelemetry Collector 自定义资源的示例
3.11. Transform Processor 复制链接链接已复制到粘贴板!
Transform Processor 启用根据指定的规则修改遥测数据,并在 OpenTelemetry Transformation Language (OTTL) 中修改遥测数据。对于每个信号类型,处理器处理与特定 OTTL 上下文类型关联的一系列条件和语句,然后按照配置中指定的在传入遥测数据上执行它们。每个条件和语句都可以使用各种功能访问和修改遥测数据,允许条件指示是否要执行的函数。
所有语句都是在 OTTL 中编写的。您可以为不同的信号、跟踪、指标和日志配置多个上下文语句。context 类型的值指定在解释关联的语句时,处理器必须使用哪个 OTTL 上下文。
Transform 处理器只是一个技术预览功能。技术预览功能不受红帽产品服务等级协议(SLA)支持,且功能可能并不完整。红帽不推荐在生产环境中使用它们。这些技术预览功能可以使用户提早试用新的功能,并有机会在开发阶段提供反馈意见。
有关红帽技术预览功能支持范围的更多信息,请参阅技术预览功能支持范围。
配置概述
使用 Transform Processor 时 OpenTelemetry Collector 自定义资源示例
| 信号声明 | 有效上下文 |
|---|---|
|
|
|
|
|
|
|
|
|
| 值 | 描述 |
|---|---|
|
| 忽略并记录声明返回的错误,然后继续到下一个语句。 |
|
| 忽略并不记录声明返回的错误,然后继续到下一个语句。 |
|
| 返回错误管道并丢弃有效负载。隐式默认值。 |
3.12. Tail Sampling Processor 复制链接链接已复制到粘贴板!
当所有 span 都完成后,Tail Sampling 处理器会根据用户定义的策略抽样 trace。通过基于尾部的抽样,您可以过滤感兴趣的追踪,并降低数据生成和存储成本。
Tail Sampling 处理器只是一个技术预览功能。技术预览功能不受红帽产品服务等级协议(SLA)支持,且功能可能并不完整。红帽不推荐在生产环境中使用它们。这些技术预览功能可以使用户提早试用新的功能,并有机会在开发阶段提供反馈意见。
有关红帽技术预览功能支持范围的更多信息,请参阅技术预览功能支持范围。
此处理器将 span 组合成新的批处理,并剥离原始上下文。
- 在管道中,将依赖上下文的任何处理器下游放在管道中:例如,在 Kubernetes Attributes Processor 后。
- 如果扩展 Collector,请确保一个 Collector 实例接收同一 trace 的所有范围,以便此处理器根据指定的抽样策略做出正确的抽样决策。您可以通过设置 Collector 的两层来实现此目的:使用 Load Balancing Exporter 的 Collector 的第一层,以及使用 Tail Sampling Processor 的 Collector 的第二个层。
使用 Tail Sampling Processor 时 OpenTelemetry Collector 自定义资源的示例
您可以从以下列表中选择和组合策略:
以下策略抽样所有 trace:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 以下策略只对位于指定范围内的持续时间进行追踪:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- 提供的
5000和10000值只是一个示例。您可以通过查看最早的开始时间值和最新结束时间值来估算所需的延迟值。如果省略upper_threshold_ms字段,则此策略会抽样超过指定threshold_ms值的所有延迟。
以下策略示例根据数字值与 resource 和 record 属性匹配:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- 提供的
50和100值只是示例。
以下策略示例仅对 trace 的百分比进行抽样:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- 提供的
10值是一个示例。
以下策略示例根据状态代码对 trace 进行抽样:
OK、ERROR或UNSET:Copy to Clipboard Copied! Toggle word wrap Toggle overflow 以下策略示例根据字符串值与 resource 和 record 属性匹配:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- 此策略定义支持完全匹配和常规表达式值。
cache_max_size字段中提供的10值是一个示例。
以下策略示例根据每秒 span 率进行追踪:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- 提供的
35值是一个示例。
以下策略示例根据最小和最大 span 数量对 trace 进行抽样:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- 如果 trace 中的所有 span 的总和超出范围阈值,则 trace 不会被抽样。提供的
2和20值只是一个示例。
以下通过
TraceState值的 trace 匹配:Copy to Clipboard Copied! Toggle word wrap Toggle overflow 以下策略示例根据布尔值属性(资源和记录)进行跟踪:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 以下策略示例由给定布尔值 OTTL 条件为 span 或 span 事件进行追踪:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 以下是一个
AND策略,它基于多个策略的组合对 trace 进行抽样:Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- 提供的
50和100值只是示例。
以下是一个
DROP策略,它根据多个策略的组合从抽样中丢弃 trace:Copy to Clipboard Copied! Toggle word wrap Toggle overflow 以下策略示例根据前面的抽样器的组合,以及每个 sampler 的排序和速率分配的组合对 trace 进行抽样:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
3.13. Probabilistic Sampling Processor 复制链接链接已复制到粘贴板!
如果您处理大量遥测数据,并希望通过降低处理的数据量来降低成本,您可以使用 Probabilistic Sampling Processor 作为 Tail Sampling Processor 的替代选择。
Probabilistic Sampling Processor 只是一个技术预览功能。技术预览功能不受红帽产品服务等级协议(SLA)支持,且功能可能并不完整。红帽不推荐在生产环境中使用它们。这些技术预览功能可以使用户提早试用新的功能,并有机会在开发阶段提供反馈意见。
有关红帽技术预览功能支持范围的更多信息,请参阅技术预览功能支持范围。
处理器在无状态和每个请求中抽样指定百分比的 trace 范围或日志记录。
处理器将有关已用的有效抽样概率的信息添加到遥测数据中:
-
在 trace span 中,处理器在 W3C Trace Context
tracestate字段中对阈值和可选的随机性信息进行编码。 - 在日志记录中,处理器将阈值和随机信息编码为属性。
以下是用于抽样追踪的 Probabilistic Sampling Processor 的 OpenTelemetryCollector 自定义资源配置示例:
- 1
- 对于追踪管道,随机性的来源是 span 跟踪 ID 的散列值。
- 2
- 必需。接受 32 位浮点百分比值,在其中对 span 进行抽样。
- 3
- 可选。接受抽样逻辑模式支持的字符串值:默认的
hash_seed、proportional,或equalizing。hash_seed模式将 Fowler-Noll-Vo (FNV)哈希功能应用到 trace ID,并将散列值用于抽样百分比值。您还可以使用hash_seed模式,以及 trace ID 以外的遥测单元。proportional模式对总范围数量有严格的、基于概率的比例进行抽样,并基于 OpenTelemetry 和 World Wide Web Consortium 规格。equalizing模式可用于将抽样概率降低到整个管道中的最小值,或者在 Collector 部署中应用统一的抽样可能性,其中 client SDK 具有混合抽样配置。 - 4
- 可选。接受 32 位未签名的整数,该整数用于计算哈希算法。如果没有配置此字段,则默认的 seed 值为
0。如果使用多个 Collector 实例层,您必须将同一层的所有收集器配置为相同的 seed 值。 - 5
- 可选。决定用于编码抽样阈值的十六进制数。接受整数值。支持的值
1-14。如果阈值4包含超过 16 个重要位(使用 56 位proportional模式)时,默认值 4 会导致对阈值进行舍入。如果您选择proportional模式,请为前面的 samplers 应用保留精度的目的使用更大的值。 - 6
- 可选。拒绝 span,带有抽样错误。接受一个布尔值。默认值为
true。
以下是用于抽样日志记录的 Probabilistic Sampling Processor 的 OpenTelemetryCollector 自定义资源配置示例:
- 1
- 必需。接受 32 位浮点百分比值,在其中对 span 进行抽样。
- 2
- 可选。接受抽样逻辑模式支持的字符串值:默认的
hash_seed、equalizing, 或proportional。hash_seed模式将 Fowler-Noll-Vo (FNV)哈希功能应用到 trace ID 或指定的日志记录属性,然后根据抽样百分比值来权衡散列值。您也可以将hash_seed模式与遥测 ID 的其他单元一起使用,例如,使用service.instance.id资源属性从 pod 中收集日志记录。equalizing模式可用于将抽样概率降低到整个管道中的最小值,或者在 Collector 部署中应用统一的抽样可能性,其中 client SDK 具有混合抽样配置。proportional模式对总范围数量有严格的、基于概率的比例进行抽样,并基于 OpenTelemetry 和 World Wide Web Consortium 规格。 - 3
- 可选。接受 32 位未签名的整数,该整数用于计算哈希算法。如果没有配置此字段,则默认的 seed 值为
0。如果使用多个 Collector 实例层,您必须将同一层的所有收集器配置为相同的 seed 值。 - 4
- 可选。决定用于编码抽样阈值的十六进制数。接受整数值。支持的值
1-14。如果阈值4包含超过 16 个重要位(使用 56 位proportional模式)时,默认值 4 会导致对阈值进行舍入。如果您选择proportional模式,请为前面的 samplers 应用保留精度的目的使用更大的值。 - 5
- 可选。定义
from_attribute中查找日志记录属性的位置。日志记录属性用作随机性的来源。接受默认的traceID值或record值。 - 6
- 可选。用于计算抽样哈希的日志记录属性的名称,如唯一的日志记录 ID。接受字符串值。默认值为
""。只有在需要在缺少 trace ID 或 trace ID 抽样被禁用或将attribute_source字段设置为record值时,才需要指定日志记录属性作为随机性时才使用这个选项。 - 7
- 可选。拒绝 span,带有抽样错误。接受一个布尔值。默认值为
true。
第 4 章 Exporters 复制链接链接已复制到粘贴板!
导出器将数据发送到一个或多个后端或目的地。导出器可以基于推送或拉取 (pull)。默认情况下,不会配置导出器。必须配置一个或多个导出器。导出器可以支持一个或多个数据源。导出器可能会与其默认设置一起使用,但许多导出器需要配置来至少指定目标和安全设置。
目前,红帽构建的 OpenTelemetry 提供了以下正式发行(GA)和技术预览导出器:
4.1. OTLP Exporter 复制链接链接已复制到粘贴板!
OTLP gRPC Exporter 使用 OpenTelemetry 协议 (OTLP) 导出追踪和指标。
OpenTelemetry Collector 自定义资源带有启用的 OTLP Exporter
- 1
- OTLP gRPC 端点。如果使用
https://方案,则启用客户端传输安全性并覆盖tls中的不安全设置。 - 2
- 客户端 TLS 配置。定义 TLS 证书的路径。
- 3
- 当设置为
true时禁用客户端传输安全性。默认值为false。 - 4
- 当设置为
true时跳过验证证书。默认值为false。 - 5
- 指定重新载入证书的时间间隔。如果没有设置值,则证书永远不会重新加载。
reload_interval接受包含有效时间单位的字符串,如ns,us或µs,ms,s,m,h。 - 6
- 覆盖请求中的颁发机构的虚拟主机名,如授权标头字段。您可以使用此选项进行测试。
- 7
- 为建立的连接期间执行的每个请求发送标头。
4.2. OTLP HTTP Exporter 复制链接链接已复制到粘贴板!
OTLP HTTP Exporter 使用 OpenTelemetry 协议 (OTLP) 导出追踪和指标。
OpenTelemetry Collector 自定义资源带有启用的 OTLP Exporter
4.3. Debug Exporter 复制链接链接已复制到粘贴板!
Debug Exporter 将 trace 和 metrics 打印到标准输出。
OpenTelemetry Collector 自定义资源带有启用的 Debug Exporter
- 1
- debug 导出的详细程度为:
detailed或normal或basic。当设置为detailed时,管道数据会被详细记录。默认为normal。 - 2
- 每秒日志记录的初始消息数。默认值为每秒
2个消息。 - 3
- 在初始消息数后的抽样率,
sampling_initial中的值已被记录。默认禁用,默认值为1。使用大于1的值启用抽样。如需更多信息,请参阅 Go Project 网站上zapcore软件包中的 sampler 函数页。 - 4
- 当设置为
true时,为导出器启用 Collector 内部日志记录器的输出。
4.4. Load Balancing Exporter 复制链接链接已复制到粘贴板!
Load Balancing Exporter 根据 routing_key 配置,一致性地导出 span、metrics 和 logs。
Load Balancing Exporter 只是一个技术预览功能。技术预览功能不受红帽产品服务等级协议(SLA)支持,且功能可能并不完整。红帽不推荐在生产环境中使用它们。这些技术预览功能可以使用户提早试用新的功能,并有机会在开发阶段提供反馈意见。
有关红帽技术预览功能支持范围的更多信息,请参阅技术预览功能支持范围。
OpenTelemetry Collector 自定义资源带有启用的 Load Balancing Exporter
4.5. Prometheus Exporter 复制链接链接已复制到粘贴板!
Prometheus Exporter 以 Prometheus 或 OpenMetrics 格式导出指标。
Prometheus Exporter 只是一个技术预览功能。技术预览功能不受红帽产品服务等级协议(SLA)支持,且功能可能并不完整。红帽不推荐在生产环境中使用它们。这些技术预览功能可以使用户提早试用新的功能,并有机会在开发阶段提供反馈意见。
有关红帽技术预览功能支持范围的更多信息,请参阅技术预览功能支持范围。
OpenTelemetry Collector 自定义资源带有启用的 Prometheus Exporter
- 1
- 公开指标的网络端点。Red Hat build of OpenTelemetry Operator 会自动公开
endpoint字段中指定的端口,到<instance_name>-collector服务。 - 2
- 服务器端 TLS 配置。定义 TLS 证书的路径。
- 3
- 如果设置,在提供的值下导出指标。
- 4
- 每个导出的指标应用的键值对标签。
- 5
- 如果为
true,则使用 OpenMetrics 格式导出指标。Exemplars 仅以 OpenMetrics 格式导出,仅适用于直方和 monotonic 摘要指标,如counter。默认禁用此选项。 - 6
- 如果
enabled是true,所有资源属性都会转换为指标标签。默认禁用此选项。 - 7
- 定义在没有更新的情况下公开指标的时间。默认值为
5m。 - 8
- 添加指标类型和单元后缀。如果启用了 Jaeger 控制台中的 monitor 选项卡,则必须禁用。默认值是
true。
当 OpenTelemetryCollector 自定义资源 (CR) 中的 spec.observability.metrics.enableMetrics 字段设置为 true 时,OpenTelemetryCollector CR 会自动创建一个 Prometheus ServiceMonitor 或 PodMonitor CR,以便 Prometheus 提取您的指标。
4.6. Prometheus Remote Write Exporter 复制链接链接已复制到粘贴板!
Prometheus Remote Write Exporter 将指标导出到兼容后端。
Prometheus Remote Write Exporter 只是一个技术预览功能。技术预览功能不受红帽产品服务等级协议(SLA)支持,且功能可能并不完整。红帽不推荐在生产环境中使用它们。这些技术预览功能可以使用户提早试用新的功能,并有机会在开发阶段提供反馈意见。
有关红帽技术预览功能支持范围的更多信息,请参阅技术预览功能支持范围。
OpenTelemetry Collector 自定义资源带有启用的 Prometheus Remote Write Exporter
- 此导出器会丢弃 non-cumulative monotonic, histogram, 和 summary OTLP 指标。
-
您需要在远程 Prometheus 实例上启用
--web.enable-remote-write-receiver功能标记。如果没有它,则使用此导出器将指标推送到实例会失败。
4.7. Kafka Exporter 复制链接链接已复制到粘贴板!
Kafka Exporter 将日志、指标和追踪导出到 Kafka。此导出器使用同步制作者,用于阻止且不批处理消息。它必须与批处理和排队重试处理器一起使用,以获得更高的吞吐量和弹性。
OpenTelemetry Collector 自定义资源带有启用的 Kafka Exporter
- 1
- Kafka 代理列表。默认值为
localhost:9092。 - 2
- Kafka 协议版本。例如,
2.0.0。这个为必填字段。 - 3
- 要从中读取的 Kafka 主题的名称。以下是默认设置:
otlp_spans(用于 traces),otlp_metrics(用于 metrics),otlp_logs(用于 logs)。 - 4
- 纯文本形式的身份验证配置。如果省略,则禁用纯文本形式的身份验证。
- 5
- 客户端 TLS 配置。定义 TLS 证书的路径。如果省略,则禁用 TLS 身份验证。
- 6
- 禁用验证服务器的证书链和主机名。默认值为
false。 - 7
- ServerName 表示客户端请求的服务器名称,以支持虚拟主机。
4.8. AWS CloudWatch Logs Exporter 复制链接链接已复制到粘贴板!
AWS CloudWatch Logs Exporter 将日志数据发送到 Amazon CloudWatch Logs 服务,并使用 AWS SDK 为 Go 和默认凭证供应商链签名请求。
AWS CloudWatch Logs Exporter 只是一个技术预览功能。技术预览功能不受红帽产品服务等级协议(SLA)支持,且功能可能并不完整。红帽不推荐在生产环境中使用它们。这些技术预览功能可以使用户提早试用新的功能,并有机会在开发阶段提供反馈意见。
有关红帽技术预览功能支持范围的更多信息,请参阅技术预览功能支持范围。
OpenTelemetry Collector 自定义资源带有启用的 AWS CloudWatch Logs Exporter
- 1
- 必需。如果日志组尚不存在,则会自动创建它。
- 2
- 必需。如果日志流尚不存在,则会自动创建它。
- 3
- 可选。如果 AWS 区域还没有在默认凭证链中设置,您必须指定它。
- 4
- 可选。您可以覆盖将请求转发到的默认 Amazon CloudWatch Logs 服务端点。您必须包含协议,如
https://,作为端点值的一部分。有关区域服务端点列表,请参阅 Amazon CloudWatch Logs 端点和配额 (AWS General Reference)。 - 5
- 可选。使用这个参数,您可以为新的 Amazon CloudWatch 日志组设置日志保留策略。如果省略此参数或设置为
0,则日志默认不会过期。支持的保留值(以天为单位)是1,3,5,7,14,30,60,90,120,150,180,365,400,545,731,1827,2192,2557,2922,3288, 或3653。 - 6
- 可选。AWS Identity and Access Management (IAM)角色,将日志片段上传到其他帐户。
4.9. AWS EMF Exporter 复制链接链接已复制到粘贴板!
AWS EMF Exporter 将以下 OpenTelemetry 指标数据点转换为 AWS CloudWatch 嵌入式指标格式(EMF):
-
Int64DataPoints -
DoubleDataPoints -
SummaryDataPoints
然后,使用 PutLogEvents API 直接发送到 Amazon CloudWatch Logs 服务。
使用此导出器的一个好处是,可以在 Amazon CloudWatch 控制台中查看日志和指标,地址为 https://console.aws.amazon.com/cloudwatch/。
AWS EMF Exporter 只是一个技术预览功能。技术预览功能不受红帽产品服务等级协议(SLA)支持,且功能可能并不完整。红帽不推荐在生产环境中使用它们。这些技术预览功能可以使用户提早试用新的功能,并有机会在开发阶段提供反馈意见。
有关红帽技术预览功能支持范围的更多信息,请参阅技术预览功能支持范围。
OpenTelemetry Collector 自定义资源带有启用的 AWS EMF Exporter
- 1
log_group_name参数允许您自定义日志组名称,并支持默认的/metrics/default值或以下占位符:/aws/metrics/{ClusterName}占位符用于搜索指标数据中的ClusterName或aws.ecs.cluster.name资源属性,并将其替换为实际集群名称。{NodeName}占位符用于搜索NodeName或k8s.node.name资源属性。{TaskId}占位符用于搜索TaskId或aws.ecs.task.id资源属性。如果在资源属性映射中没有找到 resource 属性,则占位符将替换为
undefined值。- 2
- 您可以使用
log_stream_name参数自定义日志流名称,或者设置默认的otel-stream值或以下占位符:{ClusterName}占位符用于搜索ClusterName或aws.ecs.cluster.name资源属性。{ContainerInstanceId}占位符用于搜索ContainerInstanceId或aws.ecs.container.instance.id资源属性。此资源属性仅对 AWS ECS EC2 启动类型有效。{NodeName}占位符用于搜索NodeName或k8s.node.name资源属性。{TaskDefinitionFamily}占位符用于搜索TaskDefinitionFamily或aws.ecs.task.family资源属性。{TaskId}占位符用于搜索指标数据中的TaskId或aws.ecs.task.id资源属性,并将其替换为实际任务 ID。如果在资源属性映射中没有找到 resource 属性,则占位符将替换为
undefined值。 - 3
- 可选。将资源属性转换为遥测属性,如指标标签。默认禁用此选项。
- 4
- 日志流的 AWS 区域。如果默认凭证供应商链中尚未设置区域,您必须指定区域。
- 5
- 可选。您可以覆盖将请求转发到的默认 Amazon CloudWatch Logs 服务端点。您必须包含协议,如
https://,作为端点值的一部分。有关区域服务端点列表,请参阅 Amazon CloudWatch Logs 端点和配额 (AWS General Reference)。 - 6
- 可选。使用这个参数,您可以为新的 Amazon CloudWatch 日志组设置日志保留策略。如果省略此参数或设置为
0,则日志默认不会过期。支持的保留值(以天为单位)是1,3,5,7,14,30,60,90,120,150,180,365,400,545,731,1827,2192,2557,2922,3288, 或3653。 - 7
- 可选。Amazon CloudWatch 指标的自定义命名空间。
- 8
- 可选。AWS Identity and Access Management (IAM)角色,将指标片段上传到其他帐户。
4.10. AWS X-Ray Exporter 复制链接链接已复制到粘贴板!
AWS X-Ray Exporter 将 OpenTelemetry span 转换为 AWS X-Ray Segment 文档,然后将它们直接发送到 AWS X-Ray 服务。AWS X-Ray Exporter 使用 PutTraceSegments API,并使用 AWS SDK 为 Go 和默认凭证供应商链签名请求。
AWS X-Ray Exporter 只是一个技术预览功能。技术预览功能不受红帽产品服务等级协议(SLA)支持,且功能可能并不完整。红帽不推荐在生产环境中使用它们。这些技术预览功能可以使用户提早试用新的功能,并有机会在开发阶段提供反馈意见。
有关红帽技术预览功能支持范围的更多信息,请参阅技术预览功能支持范围。
OpenTelemetry Collector 自定义资源带有启用的 AWS X-Ray Exporter
- 1
- 发送到 AWS X-Ray 服务的 X-Ray 片段的目标区域。例如,
eu-west-1。 - 2
- 可选。您可以覆盖将请求转发到的默认 Amazon CloudWatch Logs 服务端点。您必须包含协议,如
https://,作为端点值的一部分。有关区域服务端点列表,请参阅 Amazon CloudWatch Logs 端点和配额 (AWS General Reference)。 - 3
- 运行 Collector 的 AWS 资源的 Amazon 资源名称 (ARN)。
- 4
- AWS Identity and Access Management (IAM) 角色,将 X-Ray 片段上传到其他帐户。
- 5
- 要转换为 X-Ray 注解的属性名称列表。
- 6
- Amazon CloudWatch Logs 的日志组名称列表。
- 7
- 请求超时前的持续时间(以秒为单位)。如果省略,则默认值为
30。
4.11. File Exporter 复制链接链接已复制到粘贴板!
文件 Exporter 将遥测数据写入持久性存储中的文件,并支持轮转、压缩和写入多个文件等文件操作。使用这个导出器,您还可以使用 resource 属性来控制文件命名。唯一必需的设置是 path,用于指定 persistent-volume 文件系统中遥测文件的目的地路径。
File Exporter 只是一个技术预览功能。技术预览功能不受红帽产品服务等级协议(SLA)支持,且功能可能并不完整。红帽不推荐在生产环境中使用它们。这些技术预览功能可以使用户提早试用新的功能,并有机会在开发阶段提供反馈意见。
有关红帽技术预览功能支持范围的更多信息,请参阅技术预览功能支持范围。
OpenTelemetry Collector 自定义资源带有启用的文件导出器
- 1
- 要写入数据的文件系统路径。没有默认值。
- 2
- 文件轮转是此导出器的可选功能。默认情况下,遥测数据导出到单个文件。添加
rotation设置以启用文件轮转。 - 3
max_megabytes设置是文件被允许访问的最大大小,直到它被轮转为止。默认值为100。- 4
max_days设置用于保留文件的天数,从文件名中的时间戳计数。没有默认值。- 5
max_backups设置用于保留几个较旧的文件。默认值为100。- 6
localtime设置指定时间戳的本地时间格式,该格式会在文件轮转时附加到任何扩展名前面的文件名中。默认为协调的通用时间 (UTC)。- 7
- 在将遥测数据写入文件之前,对遥测数据进行编码的格式。默认格式为
json。还支持proto格式。 - 8
- 文件压缩是可选的,默认情况下不设置。此设置定义导出到文件的数据的压缩算法。目前,只支持
zstd压缩算法。没有默认值。 - 9
- 刷新间隔。没有单位的值被设置为纳秒。当通过
rotation设置启用文件轮转时,会忽略此设置。
4.12. Google Cloud Exporter 复制链接链接已复制到粘贴板!
Google Cloud Exporter 将遥测数据发送到 Google Cloud Operations Suite。使用 Google Cloud Exporter,您可以将指标导出到 Google Cloud Monitoring,登录到 Google Cloud Logging,并将 trace 导出到 Google Cloud Trace。
Google Cloud Exporter 只是一个技术预览功能。技术预览功能不受红帽产品服务等级协议(SLA)支持,且功能可能并不完整。红帽不推荐在生产环境中使用它们。这些技术预览功能可以使用户提早试用新的功能,并有机会在开发阶段提供反馈意见。
有关红帽技术预览功能支持范围的更多信息,请参阅技术预览功能支持范围。
OpenTelemetry Collector 自定义资源带有启用的 Google Cloud Exporter
- 1
GOOGLE_APPLICATION_CREDENTIALS环境变量,指向身份验证key.json文件。key.json文件作为 secret 卷挂载到 OpenTelemetry Collector。- 2
- 可选。项目标识符。如果没有指定,则项目会自动从凭证决定。
默认情况下,导出器将遥测数据发送到导出器配置的
project字段中指定的项目。您可以使用gcp.project.id资源属性在每个指标上设置覆盖。例如,如果指标具有标签项目,您可以使用 Group-by-Attributes Processor 将它提升到资源标签,然后使用 Resource Processor 将属性从项目重命名为gcp.project.id。
第 5 章 连接器 复制链接链接已复制到粘贴板!
连接器连接两个管道。它在一个管道的末尾将数据视为导出器,并在另一个管道开始时将数据作为接收器发送。它可以消耗和发送相同或不同数据类型的数据。它可以生成并发送数据以汇总已消耗的数据,或者可以完全复制或路由数据。
目前,红帽构建的 OpenTelemetry 提供了以下正式发行(GA)和技术预览连接器:
5.1. 计数连接器 复制链接链接已复制到粘贴板!
Count Connector 计算 trace span、trace span 事件、指标、指标数据点和导出器管道中的日志记录。
Count Connector 只是一个技术预览功能。技术预览功能不受红帽产品服务等级协议(SLA)支持,且功能可能并不完整。红帽不推荐在生产环境中使用它们。这些技术预览功能可以使用户提早试用新的功能,并有机会在开发阶段提供反馈意见。
有关红帽技术预览功能支持范围的更多信息,请参阅技术预览功能支持范围。
以下是默认指标名称:
-
trace.span.count -
trace.span.event.count -
metric.count -
metric.datapoint.count -
log.record.count
您还可以公开自定义指标名称。
带有启用 Count Connector 的 OpenTelemetry Collector 自定义资源 (CR)
Count Connector 可以根据定义的条件计算遥测数据,并在配置时将这些数据公开为指标,如 spans, spanevents, metrics, datapoints, 或 logs。请参阅下个示例。
Count Connector 的 OpenTelemetry Collector CR 示例,按条件计算 span
使用 spans, spanevents, metrics, datapoints, 或 logs 等字段配置时,Count Connector 可以根据定义的属性计算遥测数据。请参阅下个示例。属性键被注入到遥测数据。您必须为缺少属性的 default_value 字段定义一个值。
Count Connector 的 OpenTelemetry Collector CR 示例,按属性计算日志
5.2. Routing Connector 复制链接链接已复制到粘贴板!
Routing Connector 根据资源属性及其路由条件将日志、指标和追踪路由到指定的管道,它们被写为 OpenTelemetry Transformation Language (OTTL) 语句。
Routing Connector 只是一个技术预览功能。技术预览功能不受红帽产品服务等级协议(SLA)支持,且功能可能并不完整。红帽不推荐在生产环境中使用它们。这些技术预览功能可以使用户提早试用新的功能,并有机会在开发阶段提供反馈意见。
有关红帽技术预览功能支持范围的更多信息,请参阅技术预览功能支持范围。
带有启用路由连接器的 OpenTelemetry Collector 自定义资源
5.3. Forward Connector 复制链接链接已复制到粘贴板!
Forward Connector 会合并同一类型的两个管道。
Forward Connector 只是一个技术预览功能。技术预览功能不受红帽产品服务等级协议(SLA)支持,且功能可能并不完整。红帽不推荐在生产环境中使用它们。这些技术预览功能可以使用户提早试用新的功能,并有机会在开发阶段提供反馈意见。
有关红帽技术预览功能支持范围的更多信息,请参阅技术预览功能支持范围。
启用了 Forward Connector 的 OpenTelemetry Collector 自定义资源
5.4. Spanmetrics Connector 复制链接链接已复制到粘贴板!
Spanmetrics Connector 聚合了来自 span 数据的 Request, Error, 和 Duration (R.E.D) OpenTelemetry 指标。
启用了 Spanmetrics Connector 的 OpenTelemetry Collector 自定义资源
- 1
- 定义生成的指标的清除间隔。默认值为
15s。
第 6 章 扩展 复制链接链接已复制到粘贴板!
扩展为 Collector 添加功能。例如,身份验证可以自动添加到接收器和导出器中。
目前,红帽构建的 OpenTelemetry 提供了以下正式发行(GA)和技术预览扩展:
6.1. BearerTokenAuth Extension 复制链接链接已复制到粘贴板!
BearerTokenAuth Extension 是基于 HTTP 和 gRPC 协议的接收器和导出器的验证器。您可以使用 OpenTelemetry Collector 自定义资源为接收器和 exporter 端的 BearerTokenAuth Extension 配置客户端身份验证和服务器身份验证。此扩展支持 trace、metrics 和 logs。
OpenTelemetry Collector 自定义资源,为 BearerTokenAuth Extension 配置了客户端和服务器身份验证
6.2. OAuth2Client Extension 复制链接链接已复制到粘贴板!
OAuth2Client Extension 是导出器的验证器,它基于 HTTP 和 gRPC 协议。OAuth2Client Extension 的客户端身份验证在 OpenTelemetry Collector 自定义资源中的单独部分中配置。此扩展支持 trace、metrics 和 logs。
OAuth2Client 扩展只是一个技术预览功能。技术预览功能不受红帽产品服务等级协议(SLA)支持,且功能可能并不完整。红帽不推荐在生产环境中使用它们。这些技术预览功能可以使用户提早试用新的功能,并有机会在开发阶段提供反馈意见。
有关红帽技术预览功能支持范围的更多信息,请参阅技术预览功能支持范围。
OpenTelemetry Collector 自定义资源,为 OAuth2Client Extension 配置了客户端身份验证
- 1
- 客户端标识符,由身份提供程序提供。
- 2
- 用于向身份提供程序验证客户端的机密密钥。
- 3
- 其他元数据,采用键值对格式,在身份验证过程中传输。例如,
audience指定访问令牌的预期受众,指示令牌的接收者。 - 4
- OAuth2 令牌端点的 URL,Collector 请求访问令牌。
- 5
- 范围定义客户端请求的特定权限或访问级别。
- 6
- 令牌客户端的传输层安全性 (TLS) 设置,用于在请求令牌时建立安全连接。
- 7
- 当设置为
true时,将 Collector 配置为使用不安全或非验证的 TLS 连接来调用配置的令牌端点。 - 8
- 用于在 TLS 握手过程中验证服务器证书的证书颁发机构 (CA) 文件的路径。
- 9
- 如果需要,客户端必须用来向 OAuth2 服务器验证自己的客户端证书文件的路径。
- 10
- 身份验证所需的客户端私钥文件的路径。
- 11
- 为令牌客户端的请求设置超时。
- 12
- 您可以将验证器配置分配给 OTLP 导出器。
6.3. File Storage Extension 复制链接链接已复制到粘贴板!
File Storage Extension 支持 trace、metrics 和 logs。此扩展可保留本地文件系统的状态。此扩展会保留基于 HTTP 和 gRPC 协议的 OpenTelemetry 协议 (OTLP) 导出器的发送队列。此扩展需要对目录的读和写访问权限。此扩展可以使用默认目录,但默认目录必须已存在。
File Storage Extension 只是一个技术预览功能。技术预览功能不受红帽产品服务等级协议(SLA)支持,且功能可能并不完整。红帽不推荐在生产环境中使用它们。这些技术预览功能可以使用户提早试用新的功能,并有机会在开发阶段提供反馈意见。
有关红帽技术预览功能支持范围的更多信息,请参阅技术预览功能支持范围。
OpenTelemetry Collector 自定义资源带有配置的文件存储扩展,它会保留 OTLP 发送队列
6.4. OIDC Auth Extension 复制链接链接已复制到粘贴板!
OIDC Auth Extension 使用 OpenID Connect (OIDC) 协议向接收器验证传入的请求。它针对签发者验证授权标头中的 ID 令牌,并更新传入请求的身份验证上下文。
OIDC Auth Extension 只是一个技术预览功能。技术预览功能不受红帽产品服务等级协议(SLA)支持,且功能可能并不完整。红帽不推荐在生产环境中使用它们。这些技术预览功能可以使用户提早试用新的功能,并有机会在开发阶段提供反馈意见。
有关红帽技术预览功能支持范围的更多信息,请参阅技术预览功能支持范围。
OpenTelemetry Collector 自定义资源带有配置的 OIDC Auth Extension
6.5. Jaeger Remote Sampling Extension 复制链接链接已复制到粘贴板!
Jaeger Remote Sampling Extension 在 Jaeger 的远程抽样 API 后启用服务抽样策略。您可以配置此扩展,将请求代理到后备远程抽样服务器,如 Jaeger 收集器关闭管道或从本地文件系统到静态 JSON 文件。
Jaeger Remote Sampling Extension 只是一个技术预览功能。技术预览功能不受红帽产品服务等级协议(SLA)支持,且功能可能并不完整。红帽不推荐在生产环境中使用它们。这些技术预览功能可以使用户提早试用新的功能,并有机会在开发阶段提供反馈意见。
有关红帽技术预览功能支持范围的更多信息,请参阅技术预览功能支持范围。
OpenTelemetry Collector 自定义资源带有配置的 Jaeger Remote Sampling Extension
Jaeger Remote Sampling 策略文件示例
6.6. Performance Profiler Extension 复制链接链接已复制到粘贴板!
Performance Profiler Extension 启用 Go net/http/pprof 端点。开发人员使用此扩展来收集性能配置集并调查服务的问题。
Performance Profiler 扩展只是一个技术预览功能。技术预览功能不受红帽产品服务等级协议(SLA)支持,且功能可能并不完整。红帽不推荐在生产环境中使用它们。这些技术预览功能可以使用户提早试用新的功能,并有机会在开发阶段提供反馈意见。
有关红帽技术预览功能支持范围的更多信息,请参阅技术预览功能支持范围。
OpenTelemetry Collector 自定义资源带有配置的 Performance Profiler Extension
6.7. Health Check Extension 复制链接链接已复制到粘贴板!
Health Check Extension 提供了一个 HTTP URL,用于检查 OpenTelemetry Collector 的状态。您可以将此扩展用作 OpenShift 上的存活度和就绪度探测。
健康检查扩展只是一个技术预览功能。技术预览功能不受红帽产品服务等级协议(SLA)支持,且功能可能并不完整。红帽不推荐在生产环境中使用它们。这些技术预览功能可以使用户提早试用新的功能,并有机会在开发阶段提供反馈意见。
有关红帽技术预览功能支持范围的更多信息,请参阅技术预览功能支持范围。
OpenTelemetry Collector 自定义资源带有配置的 Health Check Extension
6.8. zPages Extension 复制链接链接已复制到粘贴板!
zPages 扩展提供了一个 HTTP 端点,提供实时数据来实时调试检测组件。您可以使用此扩展进行进程诊断,并深入了解 trace 和 metrics,而无需依赖外部的后端。使用这个扩展,您可以通过观察提供的端点上的诊断信息来监控和排除 OpenTelemetry Collector 和相关组件的行为。
zPages 扩展只是一个技术预览功能。技术预览功能不受红帽产品服务等级协议(SLA)支持,且功能可能并不完整。红帽不推荐在生产环境中使用它们。这些技术预览功能可以使用户提早试用新的功能,并有机会在开发阶段提供反馈意见。
有关红帽技术预览功能支持范围的更多信息,请参阅技术预览功能支持范围。
OpenTelemetry Collector 自定义资源带有配置的 zPages Extension
- 1
- 指定提供 zPages 扩展的 HTTP 端点。默认值为
localhost:55679。
访问 HTTP 端点需要端口转发,因为红帽构建的 OpenTelemetry Operator 不会公开此路由。
您可以通过运行以下 oc 命令启用端口转发:
oc port-forward pod/$(oc get pod -l app.kubernetes.io/name=instance-collector -o=jsonpath='{.items[0].metadata.name}') 55679
$ oc port-forward pod/$(oc get pod -l app.kubernetes.io/name=instance-collector -o=jsonpath='{.items[0].metadata.name}') 55679
Collector 为诊断提供以下 zPages:
- ServiceZ
-
显示 Collector 服务和到以下 zPages 的链接的概述:PipelineZ、ExtensionZ 和 FeatureZ。本页还显示有关构建版本和运行时的信息。此页面的 URL 示例是
http://localhost:55679/debug/servicez。 - PipelineZ
-
显示有关 Collector 中活跃管道的详细信息。此页面显示管道类型,无论数据是否被修改,以及每个管道的相关接收器、处理器和导出器。此页面的 URL 示例是
http://localhost:55679/debug/pipelinez。 - ExtensionZ
-
显示 Collector 中当前活跃的扩展。此页面的 URL 示例是
http://localhost:55679/debug/extensionz。 - FeatureZ
-
显示 Collector 中启用的功能门及其状态和描述。此页面的 URL 示例是
http://localhost:55679/debug/featurez。 - TraceZ
-
显示延迟,按 span 分类。可用时间范围包括 0 µs, 10 µs, 100 µs, 1 ms, 10 ms, 100 ms, 1 s, 10 s, 1 m.此页面还允许快速检查错误示例。此页面的 URL 示例是
http://localhost:55679/debug/tracez。