10.6. 对工具进行故障排除

流程

1. 运行以下命令验证 Instrumentation 对象是否已成功创建：

   $ oc get instrumentation -n <workload_project> 1

   1

   创建检测的命名空间。

2. 运行以下命令，以验证 opentelemetry-auto-instrumentation init-container 是否已成功启动，这是检测注入工作负载的先决条件：

   $ oc get events -n <workload_project> 1

   1

   为工作负载注入检测的命名空间。

   输出示例

   ... Created container opentelemetry-auto-instrumentation
   ... Started container opentelemetry-auto-instrumentation

3. 验证资源是否已正确部署，以便自动检测正常工作。正确的顺序是在应用程序前部署部署自定义资源(CR)的正确顺序。有关 Instrumentation CR 的详情，请参考"配置工具"部分。

   注意

   当 pod 启动时，Red Hat build of OpenTelemetry Operator 会检查 Instrumentation CR 中的注解，其中包含注入自动检测的说明。通常，Operator 会将 init-container 添加到应用程序的 pod 中，该 pod 会将自动检测和环境变量注入应用程序的容器中。如果在部署应用程序时 Operator 无法使用 Instrumentation CR，Operator 无法注入自动检测。

   修复部署顺序需要以下步骤：

   1. 更新检测设置。
   2. 删除检测对象。
   3. 重新部署应用。

4. 运行以下命令检查 Operator 日志中的检测错误：

   $ oc logs -l app.kubernetes.io/name=opentelemetry-operator --container manager -n openshift-opentelemetry-operator --follow

5. 对特定编程语言的检测的 pod 注解进行故障排除。请参阅"配置检测"中的所需的注解字段和值。

   1. 验证您要检测的应用程序 pod 是否使用正确的注解标记，并且应用了适当的自动检测设置。

      Example

      instrumentation.opentelemetry.io/inject-python="true"

      获取检测 Python 应用程序的 pod 注解的命令示例

      $ oc get pods -n <workload_project> -o jsonpath='{range .items[?(@.metadata.annotations["instrumentation.opentelemetry.io/inject-python"]=="true")]}{.metadata.name}{"\n"}{end}'

   2. 验证应用于检测对象的注解是否正确，适用于您检测的编程语言。

   3. 如果同一命名空间中有多个检测，请在注解中指定 Instrumentation 对象的名称。

      Example

      instrumentation.opentelemetry.io/inject-nodejs: "<instrumentation_object>"

   4. 如果 Instrumentation 对象位于不同的命名空间中，请在注解中指定命名空间。

      Example

      instrumentation.opentelemetry.io/inject-nodejs: "<other_namespace>/<instrumentation_object>"

   5. 验证 OpenTelemetryCollector 自定义资源是否在 spec.template.metadata.annotations 下指定 auto-instrumentation 注解。如果 auto-instrumentation 注解位于 spec.metadata.annotations 中，请将其移到 spec.template.metadata.annotations 中。

流程

1. 验证检测是否将数据传送到正确的端点：

   $ oc get instrumentation <instrumentation_name> -n <workload_project> -o jsonpath='{.spec.endpoint}'

   Instrumentation 对象的默认端点 http://localhost:4317 仅适用于部署为应用程序 pod 中的 sidecar 的 Collector 实例。如果您使用不正确的端点，请通过编辑 Instrumentation 对象并重新部署应用程序来纠正该端点。

2. 检查应用程序日志中可能表明检测已出现故障的错误消息：

   $ oc logs <application_pod> -n <workload_project>

3. 如果应用程序日志包含表明检测可能会出现故障的错误消息，请在本地安装 OpenTelemetry SDK 和库。然后，在本地运行应用程序并进行故障排除，以便在没有 OpenShift Container Platform 的情况下检测库和应用程序间的问题。
4. 使用 Debug Exporter 验证遥测数据是否到达目的地 OpenTelemetry Collector 实例。如需更多信息，请参阅"Debug Exporter"。