创建自定义仪表板以进行监控 Code Engine

使用 IBM Cloud Monitoring 来全面了解 Code Engine 工作负载的运行状况和性能。 您可以根据 Code Engine 工作负载的需求，自定义 Monitoring 仪表板，使其显示一组量身定制的指标，从而帮助您识别瓶颈或预测可能的生产环境问题。

创建自定义仪表板以进行监控 Code Engine

您可以为 Code Engine 工作负载创建一个自定义的 Monitoring 仪表板，以显示一组量身定制的指标。

在 Monitoring 中创建自定义仪表板之前，您必须先为 Code Engine 工作负载配置监控。 请在您要监控的 Code Engine 项目所在的同一区域中，设置 Monitoring 服务实例并启用平台指标。 如果您在多个区域都有部署，则必须为每个区域配置 Monitoring 并启用平台指标。 有关配置 IBM Cloud Monitoring 服务实例以及访问 IBM Cloud Monitoring 指标仪表板以监控 Code Engine 工作负载的更多信息，请参阅 《 Code Engine 监控指南》。

Code Engine 提供 IBM Code Engine Project Overview 仪表板，该仪表板由预定义的面板组成，用于监控 Code Engine 工作负载的各个方面。 您可能需要为 Code Engine 工作负载创建一个自定义的 Monitoring 仪表板，以显示一组量身定制的指标。

  1. 设置 IBM Cloud Monitoring 服务实例。 要查看正在运行的 IBM Cloud Monitoring 实例，请参阅 可观测性仪表板。

  2. 确保有监控数据可用。 由于在有数据可供监控时，设计自定义仪表盘会更容易，因此拥有一个正在运行的 应用程序 或 作业 非常重要。 某些 Code Engine 指标仅在环境中可用时才会存在。

  3. 查看 Code Engine 的可用 指标。

  4. 访问您的 IBM Cloud Monitoring 指标。

    1. 在“IBM Cloud”导航菜单中，选择 “可观测性”。
    2. 选择监视。
    3. 在监控实例的 “视图”列中单击“仪表板”，即可打开该监控实例的仪表板。
    4. 从导航菜单中，依次选择 “仪表板”→“IBM”→“IBM”→“Code Engine”→“项目概览”。 如果菜单中未显示“Code Engine”仪表板，您可以通过在 Code Engine 应用程序或作业中选择 “添加监控”来开始监控。

  5. 点击“复制到我的仪表板”，即可复制“IBM Code Engine Project Overview”仪表板。 为您的自定义仪表板输入名称，然后点击 “创建并打开”。 例如，将仪表板命名为“My custom IBM Code Engine Project Overview”。

  6. 通过添加或删除仪表板面板来自定义您的仪表板。 有关如何自定义仪表板以监控 Code Engine 应用程序和作业运行工作负载的示例，请参阅 “场景 1”和 “场景 2”。 有关使用 IBM Cloud Monitoring 仪表板的更多信息，请参阅 “使用仪表板”。

    每当您更改仪表板的布局时，请务必点击 “保存布局”以保存所做的更改。 在继续自定义仪表板之前，您必须先保存布局更改或取消操作。

  7. 保存定制仪表板。 自定义仪表板可在仪表板导航菜单的 “仪表板”→“我的仪表板” 中找到。

场景 1：关注 Code Engine 应用程序实例和作业运行

假设您希望缩小对 Code Engine 工作负载的监控范围，以便重点关注正在运行的应用程序实例和作业运行情况。 监控这些信息可能会很有帮助，因为如果您的应用程序扩展到零，或者您的任务或构建未运行，那么您就不会消耗资源。 本示例以您之前基于现有“IBM Code Engine Project Overview”仪表板创建的“My custom IBM Code Engine Project Overview”仪表板为基础，通过修改和删除面板来简化该自定义仪表板。 在此场景下，必须在项目中定义一个作业和一个应用程序。

  1. 打开您的自定义仪表盘。 本示例假设您是从“IBM Code Engine Project Overview”仪表板的副本开始操作的。 自定义仪表板可在仪表板导航菜单中找到，路径为“仪表板”→“我的仪表板”。

  2. 修改“Total number of Applications”数字面板，并修改查询，以便使用 ibm_codeengine_application_actual_instances 指标。

    1. 点击铅笔图标以编辑该面板。
    2. 在“查询”选项卡中，单击“ibm_codeengine_application_service_count”指标以修改该指标。 输入 ibm_codeengine_ ，即可查看适用于您项目的 Code Engine 指标列表。 在此示例中，请选择“ibm_codeengine_application_actual_instances”指标，并指定“Maximum”时间聚合和“Maximum”分组汇总。
    3. 在“面板”选项卡中，将此面板重命名为“Total number of Application Instances”。
    4. 单击 “保存”以保存此面板的更改。

  3. 修改“Total number of Application revisions”数字面板，并将查询改为显示作业运行次数，方法是使用 ibm_codeengine_jobruns 指标显示作业运行次数。

    1. 点击铅笔图标以编辑该面板。
    2. 在“查询”选项卡中，单击“ibm_codeengine_application_revision_count”指标以修改该指标。 输入 ibm_codeengine_ ，即可查看适用于您项目的 Code Engine 指标列表。 在此示例中，请选择“ibm_codeengine_jobruns”指标，并指定“Maximum”时间聚合和“Maximum”分组汇总。
    3. 在“面板”选项卡中，将此面板重命名为“Total number of Job Runs”。
    4. 单击 “保存”以保存此面板的更改。

  4. 使用操作菜单删除 Total number of Application routes 的数字面板。

  5. 修改 Applications overview 时间图表面板，并使用 ibm_codeengine_application_actual_instances 和 ibm_codeengine_jobruns 指标来显示应用程序和作业运行实例的监控信息。

    1. 点击铅笔图标以编辑该面板。
    2. 在“查询”选项卡中，保留“ibm_codeengine_application_actual_instances”指标，并通过这些指标的操作菜单删除其他指标行。
    3. 在“查询”选项卡中，找到“ibm_codeengine_application_actual_instances”指标，并修改细分设置以包含应用程序版本信息。 点击 ibm_codeengine_application_name，并添加 ibm_codeengine_revision_name。 请确保取消勾选“Apply to All Queries”选项。
    4. 在“查询”选项卡中，单击 “添加查询”以添加用于作业运行的查询。 在“指标”字段中，输入 ibm_codeengine_，即可查看适用于您项目的 Code Engine 指标列表。 选择“ibm_codeengine_jobruns”指标，并指定“Maximum”时间聚合和“Maximum”分组汇总。 为该指标指定 ibm_codeengine_jobrun_condition 分段。
    5. 请确认您仅为该面板设置了“ibm_codeengine_application_actual_instances”和“ibm_codeengine_jobruns”这两项指标。
    6. 在“面板”选项卡中，将此面板的名称更改为“Application and Job Run Instances”。
    7. 点击 “保存”以保存此面板的更改

  6. 保留在此场景中前几个步骤中已更新的面板，但使用“操作”菜单删除其他面板。 删除不需要的面板后，您可以根据需要调整各个面板的大小和布局。

    每当您更改仪表板的布局时，请务必点击 “保存布局”以保存所做的更改。 在继续对仪表板进行修改之前，您必须先保存布局更改或取消操作。

完成场景 1 后，您的自定义仪表板将包含三个面板：Total number of Application Instances、Total number of Job Runs 和 Application and Job Run Instances。

场景 2：在 Code Engine 工作负载中使用 PromQL 查询

假设您希望利用在“场景 1”中创建的自定义仪表板，通过 IBM Cloud Monitoring 提供的 Prometheus 查询语言（ PromQL ）查询功能，将应用程序和作业运行次数指标汇总到一个面板中。 在此场景中，让我们使用“PromQL”将应用程序实例数和作业运行次数添加到一个数字面板中。

  1. 打开您使用“场景 1”自定义的仪表板。 自定义仪表板可在仪表板导航菜单的 “仪表板”→“我的仪表板” 中找到。

  2. 修改“Total number of Applications”数字面板，并将查询改为计算应用程序实例数和作业运行次数之和。

    1. 点击铅笔图标以编辑该面板。
    2. 在“查询”选项卡中，单击“PromQL”以使用 PromQL 查询。
    3. 在“查询”选项卡中，将查询内容替换为 sum(max(ibm_codeengine_application_actual_instances) + max(ibm_codeengine_jobruns))。 更新选项，将单位设置为 number。 单击运行查询。
    4. 在“面板”选项卡中，将此面板重命名为“Total number of Application instances and Job Runs”。
    5. 单击 “保存”以保存此面板的更改。

  3. 请使用“操作”菜单删除“Total number of Job Runs”数字面板，因为在上一步中，我们已将应用程序总数和作业运行次数合并到一个数字面板中。

  4. 您可以根据需要调整各个面板的大小和布局。

    每当您更改仪表板的布局时，请务必点击 “保存布局”以保存所做的更改。 在继续自定义仪表板之前，您必须先保存布局更改或取消操作。

完成场景 2 后，您的自定义仪表板将包含两个面板：Total number of Application instances and Job Runs 和 Application and Job Run Instances。