监控 IBM API Connect 应用程序

IBM API Connect 应用程序运行时监控侧重于监控生产环境中的关键应用程序性能指标,尤其是通过 DataPower API Gateway 进行的事务监控。 Instana 代理可以自动收集基础设施资源指标,但若要使该代理能够从 IBM API Connect 收集跟踪信息,您必须完成本主题中概述的额外步骤。

DataPower 的指标 API Gateway

Instana DataPower 传感器用于监测 DataPower API Gateway。 安装 Instana 主机代理后, IBM DataPower 传感器会自动安装,但您需要配置 IBM DataPower 传感器。 如需了解更多信息,请参阅《 监控 IBM DataPower 》。

DataPower 的追踪 API Gateway

Instana ( DataPower-tracing )功能可监控 API Management 功能,并查看 API 在 DataPower ( API Gateway )中的启动方式。

Instana DataPower Tracing 仅支持以下版本的 Red Hat OpenShift 中,通过 API Connect Operator 部署 DataPower 实例的场景:

  • API Connect 操作程序 3.5.0 以及更高版本和更低版本 5.2.0
  • API Connect 10.0.5.5 及更高版本和更低版本 10.0.8.0
  • DataPower Gateway 操作程序 1.6.10 以及 1.11.0 之前的版本

要在 VMware 上部署 IBM API Connect ,您需要部署一台 DataPower Gateway 设备。 通常,会使用 DataPower 物理设备或 DataPower 虚拟设备作为 API Gateway。 若要为 DataPower 物理设备或 DataPower 虚拟设备启用跟踪功能,请参阅 IBM DataPower Tracing

要对 DataPower API Gateway启用跟踪,必须安装并配置 DataPower 跟踪代理程序。

安装 DataPower 跟踪代理

如果您已为 DataPower, 启用了 Jaeger 追踪功能,请编辑该 GatewayCluster 自定义资源,将 Jaeger 追踪代理镜像替换为 Instana DataPower 追踪代理镜像。 但是,如果您尚未为 DataPower, 启用 Jaeger 跟踪功能,请编辑该 GatewayCluster 自定义资源以添加 jaegerTracing 属性,然后将 image 属性设置为 Instana DataPower 跟踪代理映像 URL。

要配置并运行 Instana 追踪代理sidecar容器,请编辑自定义 GatewayCluster 资源,在以下 YAML 文件中添加或修改 jaegerTracing 属性:

spec:
  jaegerTracing:
    samplingType: const
    propagationFormat: w3c
    samplingRate: '1'
    agentImage: 'icr.io/instana/instana-dp-agent-image:latest'
    tls:
      disabled: true
      skipHostVerify: false
    env:
      - name: INSTANA_AGENT_HOST
        valueFrom:
          fieldRef:
            apiVersion: v1
            fieldPath: status.hostIP

有关的更多 jaegerTracing信息,请参阅 DataPower 运算符文档

在 Red Hat OpenShift 控制台上验证结果,如以下示例中所示:

关闭问题

您可以在 Instana 用户界面中查看 IBM API Connect API Gateway 的跟踪数据。 DataPower 跟踪的缺省服务名称为 datapower:<datapower pod name>,例如 datapower:apis-minimum-gw-0

如需了解更多信息,请参阅 Instana 中的“在 Kubernetes 上安装主机代理的代理要求 ”。

取消配置 DataPower 跟踪代理

要取消配置 DataPower 跟踪代理,请从 YAML 文件中的相应 GatewayCluster 自定义资源中删除 jaegerTracing 属性。

已知限制

  • DataPower Tracing 仅支持 API 网关,不支持其他服务,例如多协议网关和 Web 服务代理。

创建应用程序视图

要创建一个应用程序视图以查看从 IBM API Connect 应用程序运行时收集的跟踪信息,请完成以下步骤:

  1. 通过下列其中一种方法打开应用程序透视图向导:
    • 在 Instana 仪表板中的 “应用程序 ”列表中,点击 “新建应用程序视图”
    • Go 在 Instana 仪表板导航面板中转到 “应用程序 ”,然后在“应用程序”页面上单击 “添加” > “新建应用程序视图 ”。
  2. 选择 服务或端点,然后单击 下一步
  3. 单击 添加过滤器,然后选择服务名称。 可以使用 OR 条件来选择多个服务和端点。 对于 DataPower 服务,服务名称类似于 datapower:<datapower-appliance-name>,例如 datapower:apis-minimum-gw-0
  4. “应用程序视图名称 ”字段中,为“ IBM API Connect ”应用程序视图输入一个名称,然后单击 “创建 ”。

故障诊断

缺少 DataPower :在 Instana 用户界面中追踪呼叫

如果“ DataPower ”的跟踪调用未按预期显示在“ Instana ”用户界面中,请执行以下步骤:

  1. 启用 Instana DataPower 的跟踪调试:
    1. 访问 DataPower pod ,然后转至 jaeger-tracing-agent 容器中的 /app/libs 目录。
    2. 通过将 <root level="info"> 更改为 <root level="debug">来编辑 logback.xml 文件。 更改将在一分钟内生效。
  2. 使用该 oc logs <datapower-pod-name> -c jaeger-tracing-agent 命令收集 Instana DataPower 跟踪代理的调试信息。