创建和管理自定义报告

本页面适用于 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 文档。

利用自定义报告，您可以深入到特定 API 指标，也可以查看想要查看的确切数据。您可以使用 Apigee 中内置的任何指标和维度来创建自定义报告。

自定义报告有两种类型：

  • 实时报告（也称为同步报告）：当您在 Apigee 界面中指定报告参数时，实时报告会在几分钟内显示在 Apigee 界面中。
  • 报告作业（也称为异步报告）：对于自定义报告作业，您可以请求报告并在稍后检索结果。

请参阅实时报告与报告作业。

自定义报告的可用性

如果您是 Apigee 订阅客户，则对 Apigee API Analytics 的访问权限和自定义报告功能包含在订阅权益中，并为您的每个 Apigee 环境自动启用。

如果您是Pay-as-you-go客户，则必须将 Apigee API Analytics 作为付费插件启用，才能访问分析功能并生成自定义报告。如需详细了解如何为中间或综合 Apigee 环境启用 Apigee API Analytics 插件，请参阅管理 Apigee API Analytics 插件。

如果您不确定您使用的是订阅还是随用随付 Apigee 组织，请与您的 Apigee 组织管理员联系。

自定义报告简介

生成自定义报告时，您可以选择您要查看的数据（指标），以有意义的方式对数据进行分组（维度），并视情况基于数据的特定特征限制所返回的数据（过滤条件）。

您还可以将自定义报告中显示的图表类型设置为柱形图或折线图。下图显示了按 API 代理维度分组的每秒事务数指标的图表示例：

  • 柱形 - 每个 API 代理由不同的柱形表示：

    自定义柱形图

  • 折线 - 每个 API 由不同的线条表示：

    自定义折线图

设置指标和维度

您为自定义报告选择的指标指定了您尝试测量的数据。常见指标包括：
  • 每秒事务数
  • 响应时间
  • 政策错误

除了标准指标和维度之外，您还可以为使用 DataCapture 政策收集的自定义数据创建自定义报告。请参阅使用 DataCapture 政策收集自定义数据。

某些指标允许您设置针对指标运行的聚合函数。例如，您可以将以下聚合函数与响应时间指标结合使用：

  • avg：返回平均响应时间。
  • min：返回最短响应时间。
  • max：返回最长响应时间。
  • sum：返回所有响应时间的总和。

并非所有指标都支持所有聚合函数。指标中的文档包含一个列明了指标名称和指标所支持函数（sum、avg、min、max）的表。

维度指定如何对指标数据进行分组。例如，您想创建一个显示响应时间指标的自定义报告。您可以使用维度按 API 产品、API 代理或开发者电子邮件（也可以是 AppGroup ID）对指标数据进行分组来获取以下数据：

  • 每个 API 产品的响应时间
  • 每个 API 代理的响应时间
  • 每个开发者电子邮件的响应时间

自定义维度在自定义报告图表中的显示方式取决于图表类型：

  • 柱形图：每个柱形对应不同的维度值。
  • 折线图：图表中的每条线对应不同的维度值，x 轴表示时间。

设置过滤条件

借助过滤条件，您可以通过对要返回的指标数据设置特定特性来限制自定义报告中显示的指标数据。例如，您可以创建过滤条件，以便仅查看响应时间大于特定值的指标数据，或仅查看具有特定名称的 API 代理的指标数据。

您可以使用条件语法和运算符（如 eq、ne、gt、lt 等）构建复杂的过滤条件。

自定义报告示例

在最简单类型的自定义报告中，您需要指定一个指标和一个维度。例如，您可以使用以下设置定义一个自定义报告：

  • 类型 = 柱形
  • 指标 = 平均每秒事务数
  • 维度 = API 代理

该自定义报告包含一个柱形图，其中显示按 API 代理维度分组的“平均每秒事务数”指标数据：

自定义报告 TPS

您可以向自定义报告添加多个指标。例如，假设您定义了一个包含两个指标的自定义报告：

  • 类型 = 柱形
  • 指标 = 平均每秒事务数
  • 指标 = 政策错误数
  • 维度 = API 代理

自定义报告中的每一个指标都有一张单独的图表：

自定义报告两个指标

您可以向自定义报告添加多个维度。例如，假设您使用以下设置定义一个自定义报告，该报告包括两个指标和两个维度：

  • 类型 = 柱形
  • 指标 = 平均每秒事务数
  • 指标 = 政策错误数
  • 维度 = API 代理
  • 维度 = 请求动词

实时报告与报告作业

借助 Apigee Analytics，您可以运行实时报告或报告作业。

  • 对于实时报告，您可以请求报告，只要分析服务器提供响应，报告就会立即显示。但是，由于报告可能需要处理大量数据（例如 100 GB），实时报告可能会由于超时而失败。

    实时报告的时间范围上限为 92 天。如果您选择的时间范围大于此值，则报告将作为报告作业运行。

    请参阅运行自定义报告。

  • 对于报告作业，您可以请求报告并在稍后检索结果。报告作业可能是不错的替代方案的一些情况包括：

    • 分析和生成跨越很长时间间隔的报告。
    • 使用各种分组维度以及增加查询复杂性的其他限制条件来分析数据
    • 在发现某些用户或组织的数据量大幅增加时管理查询。

    您还可以使用 API 运行报告作业，如使用异步自定义报告 API 中所述。 请参阅查看报告作业。

打开“Custom Reports”（自定义报告）页面。

Cloud 控制台中的 Apigee

如需打开“自定义报告”页面，请执行以下操作：

  1. 打开 Cloud 控制台中的 Apigee 界面。
  2. 依次选择 Analytics> Custom Reports（自定义报告）。

系统会显示“自定义报告”页面，如下所示。

自定义报告信息中心

“自定义报告”页面有两个标签页：

  • 报告：显示实时报告。
  • Report Jobs：显示报告作业。

请参阅实时报告与报告作业。

两个标签页都会显示已创建的报告或报告作业的列表。如需查看报告或报告作业，请点击相应报告的名称。如需查看示例，请参阅生成报告。

报告

报告标签页显示有关每个报告的以下信息：

  • 显示名称：报告的名称。
  • 维度：报告中包含的维度。
  • 指标：报告中包含的指标和聚合函数（例如 sum）。
  • 上次修改时间：报告上次运行时间和日期。

Report Jobs

Report Jobs 标签页显示有关每个报告作业的以下信息：

  • Report Name（报告名称）：报告的名称。
  • Start Time Range (UTC)：报告作业的开始时间。
  • End Time Range (UTC)：报告作业的结束时间。
  • 状态：报告作业的状态，可以是正在运行、已完成或已过期。
  • 已提交：报告作业的提交日期和时间。

通过“自定义报告”页面中，您可以执行以下操作：

经典版 Apigee

如需打开“自定义报告”页面，请执行以下操作：

  1. 登录 Apigee 界面。
  2. 依次选择分析 > 自定义报告 > 报告。

自定义报告页面显示了为您的组织创建的所有自定义报告，如下图所示：

自定义报告信息中心

如图中的突出显示部分所示，您可以在自定义报告页面中：

  • 查看所有自定义报告的列表。
  • 添加自定义报告。
  • 在列表中点击自定义报告的名称，以运行自定义报告。默认情况下，系统使用过去一小时收集的数据来生成报告，并且数据会显示在自定义报告信息中心内。请参阅浏览自定义报告信息中心。
  • 在搜索框中输入完整或一部分的相关字符串，以便在自定义报告列表中进行搜索。系统会在所有显示的字段中搜索该字符串。
  • 删除自定义报告。

浏览自定义报告信息中心

自定义报告信息中心会显示特定时间范围内的自定义报告结果，包括指定指标的柱形图或折线图：

自定义报告信息中心

在自定义报告信息中心中，您可以：

  • 查看选定时间范围内的自定义报告数据。
  • 选择要查看其自定义报告数据的环境。
  • 选择特定维度以过滤自定义报告数据。仅当您为报告指定了多个维度时此区域才会启用。

  • 选择图表或表格视图。

  • 通过选择相关指标的表格行中的 “自定义报告分析”图标。 图标来分析指标。查看异常值，并将其与上一时间段或其他指标进行比较。
  • 通过点击和设置时间范围来运行自定义报告。
  • 以 CSV 文件格式下载自定义报告。该文件的命名方式如下：metric.csv。例如：Average_of_total_response_time.csv。
  • 修改自定义报告。

创建自定义报告

本部分介绍了如何创建自定义报告。

Cloud 控制台中的 Apigee

在“自定义报告”页面中，您可以创建实时报告或报告作业。为此，请执行以下操作：

  1. 打开“自定义报告”页面。
  2. 点击 + 创建。
    • 如需创建实时报告，请选择自定义报告。
    • 如需创建报告作业，请选择 Custom Report Job。
  4. 在基本部分中，输入以下信息：
    • 报告名称：报告的名称。
    • 仅对于实时报告，您还可以输入报告的说明（可选）。
  5. 以下部分取决于您要创建实时报告还是报告作业：
    • 仅适用于实时报告：

      在图表类型之后，选择图表样式以呈现您的数据：

      • 柱形：X 轴表示按维度指定的组。
      • 折线：X 轴表示时间。

    • 仅适用于报告作业：
      • 报告详情：在环境字段中，选择要在其中运行报告的环境。请注意，对于实时报告，您可以在报告运行后，在报告页面中选择环境。
      • 报告日期范围：选择报告的开始时间和结束时间。

        注意：报告作业的日期范围不得超过 365 天。对于需要精确到秒的日期范围的报告，请使用 Custom Reports API 创建报告作业。该 API 接受包括秒数在内的日期范围输入。

  6. 在 Metrics（指标）部分执行以下操作：
    1. 选择要分析的指标。
    2. 选择一个聚合函数以显示总和、平均值、最小值或最大值。
    3. 点击完成。

    注意：除了标准指标和维度之外，您还可以选择与使用 DataCapture 政策收集的自定义数据对应的指标或维度。

  7. 在 Dimensions（维度）字段选择一个维度，例如“Proxy”（代理），以限制用于生成报告的数据集。您可以添加其他维度以进一步限制数据。

  8. 在 Filter（过滤条件）部分，您可以通过向报告定义添加过滤条件来进一步缩小显示的数据范围。例如，您可以添加一个排除天气 API 代理或开发者 jane@example.com 的数据的过滤条件。

    首先，点击 Add a Filter（添加过滤条件）以打开 New Filter（新过滤条件）部分。

    1. 选择要过滤的实体的名称，可以是指标或维度。
    2. 选择一个运算符（例如 = 或 !=）和值。
    3. 输入指标或维度的值。
    4. 点击 Done（完成）以添加过滤条件。
  9. 点击 Save（保存）以保存报告。

经典版 Apigee

要添加自定义报告，请按以下步骤操作：

  1. 打开“Custom Reports”（自定义报告）页面。
  2. 点击 + 自定义报告。
  3. 在“基本”部分中，输入以下信息：
    字段 说明
    报告名称 报告的名称。
    报告说明 报告的说明。
    图表类型 选择要用于呈现自定义分析数据的图表样式。
    • 柱形：X 轴表示按维度指定的组。
    • 折线：X 轴表示时间。
  4. 在“指标”部分执行以下操作：
    1. 点击 Metrics（指标）的 加号图标。 图标。
    2. 选择要分析的指标。
    3. 选择一个聚合函数以显示总和、平均值、最小值或最大值。
    4. 点击保存。
    5. 点击 加号图标 图标可添加其他指标。

    注意：除了标准指标和维度之外，您还可以选择与使用 DataCapture 政策收集的自定义数据对应的指标或维度。

  5. 在 Dimensions（维度）部分点击 加号图标 并选择一个维度，例如“Proxy”（代理），以限制用于生成报告的数据集。您可以添加其他维度以进一步限制数据。

  6. 在 Filter（过滤条件）部分，您可以通过向报告定义添加过滤条件来进一步缩小显示的数据范围。例如，您可以添加一个排除天气 API 代理或开发者 jane@example.com 的数据的过滤条件。

    1. 点击 加号图标 并选择要过滤的实体的名称、运算符（例如 = 或 !=）和值。
    2. 点击添加以保存过滤条件。
    3. 点击 加号图标 添加其他过滤条件，然后选择“AND”（和）或“OR”（或）连接器。
  7. 点击 Save（保存）以保存报告。

运行报告

Cloud 控制台中的 Apigee

如需运行实时报告，请执行以下操作：

  1. 打开“自定义报告”页面。
  2. 在报告标签页中，选择要运行的报告。

报告准备就绪后，会如下所示。

已显示自定义报告。

报告会显示数据图表和摘要表。

在报告页面中，您可以为报告选择以下选项：

  • Environment（环境）：运行报告的环境。
  • 报告的时间段。
  • Dimension（维度）：报告的维度。 一次只能显示一个维度。
  • 值：维度的特定值，或选择全部以显示所有值。

您还可以在报告页面的顶部选择以下选项：

  • 修改：修改报告的详细信息。
  • 导出：以 CSV 文件的形式下载报告数据。
  • 提交作业：将报告作为报告作业提交。点击提交作业后，系统会打开一个对话框，其中提供了创建自定义报告中所述的选项。输入这些选项后，点击创建以创建报告作业。

如需详细了解报告作业，请参阅查看报告作业。

经典版 Apigee

要针对特定时间范围运行自定义报告，请执行以下操作：

  1. 访问“自定义报告”页面。
  2. 选择要运行的报告。默认情况下，报告会显示前一小时的数据。

    注意：如果报告运行时间超过 60 秒，系统会自动将其转换为实时报告。

  3. 要针对不同的时间范围运行报告，请执行以下操作：

    1. 点击报告顶部的时间范围区域，以打开 Custom Report Time Selection 弹出式窗口。
    2. 您可以选择以下选项之一：
      • 预定义时间范围，例如过去 1 小时、昨天或过去 7 天。

      • 自定义范围，选择开始/结束日期和时间，或者使用日历选择开始日期和结束日期。点击 UTC 以使用世界协调时间 (UTC)。

    3. 要运行该报告，请选择以下选项之一：

      • 选择 Apply（应用）以运行报告。报告完成后，结果将显示在自定义报告信息中心内。

      • 选择提交作业以将报告作为报告作业运行。 会出现以下对话框：

        异步提交

        点击对话框中的查看状态可查看报告作业的状态。

查看报告作业

Cloud 控制台中的 Apigee

如需查看报告作业，请选择“自定义报告”页面顶部的 Report Jobs 标签页。

此时会显示 Report Jobs（报告作业）标签页，如下所示：

报告作业

在“Report Jobs”（报告作业）页面中，您可以：

  • 查看过去 7 天内提交的所有报告作业。

  • 选择要显示其报告作业的环境。

  • 在搜索框中输入相关字符串的全部或部分，以在自定义报告列表中进行搜索；系统会在所有显示的字段中搜索该字符串。

要查看自定义报告，请确保其状态为已完成。 然后点击报告名称以查看报告。

经典版 Apigee

如需查看报告作业，请选择以下其中一项：

  • 在 Report Submitted as Background Job 对话框中点击查看状态。
  • 从左侧导航栏中选择分析 > 自定义报告 > 报告作业。

此时会显示“报告作业”页面，如下图所示：

报告作业

在“Report Jobs”（报告作业）页面中，您可以：

  • 查看过去 7 天内提交的所有报告作业结果。

  • 选择要显示其报告作业的环境。

  • 要查看自定义报告，请确保其状态为已完成。 然后，将鼠标悬停在报告对应的行上。 此时会显示 查看报告 和 下载报告 图标。选择 查看报告 以查看报告。

  • 下载自定义报告。

修改自定义报告

Cloud 控制台中的 Apigee

要修改自定义报告，请按以下步骤操作：

  1. 打开“自定义报告”页面。
  2. 点击 Actions（操作）下的三点状菜单。
  3. 选择修改。此操作会打开 Edit custom report（修改自定义报告）对话框，您可以在其中修改报告选项。创建自定义报告中介绍了这些选项。
  4. 点击更新以保存更改。

经典版 Apigee

要修改自定义报告，请按以下步骤操作：

  1. 打开“Custom Reports”（自定义报告）页面。
  2. 将鼠标悬停在要修改的报告的名称上。 页面右侧会显示修改 “修改”图标 和删除 “删除”图标 图标。
  3. 点击修改图标。
  4. 修改自定义报告详细信息。
  5. 点击保存。

您将返回到自定义报告结果。

删除自定义报告。

Cloud 控制台中的 Apigee

  1. 打开“自定义报告”页面。
  2. 点击 Actions（操作）下的三点状菜单。
  3. 点击 Delete（删除）以删除报告。

经典版 Apigee

要删除自定义报告，请按以下步骤操作：

  1. 打开“Custom Reports”（自定义报告）页面。
  2. 将鼠标悬停在要修改的报告的名称上。页面右侧会显示修改 “修改”图标 和删除 “删除”图标 图标。
  3. 点击删除图标以删除报告。