设置路况提醒

<ph type="x-smartling-placeholder"></ph> 您正在查看 Apigee Edge 文档。
转到 Apigee X 文档。 信息

使用流量提醒提高 在环境、代理或区域的流量变化指定百分比时发送通知 特定时间范围内的数据

您需要将时间范围设置为：

  • 1 小时
  • 1 天
  • 7 天
  • 15 天（仅限 API）
  • 30 天（仅限 API）

这种提醒的工作原理是比较当前时间范围的流量与上一个时间范围的流量。 例如，您指定的时间范围是一小时。然后，提醒会比较最近一小时的流量 与前一个小时的流量进行比较，以计算流量的变化百分比：

percentChange = ((currentTraffic - previousTraffic) / previousTraffic) * 100

正值表示流量增加了，负值表示流量减少了。

然后以 API 流量的增减百分比的形式设置触发流量提醒的阈值 在指定时间段内获得的所有收入

在设置该百分比之前，请确保其与您的正常值 流量模式 例如，如果您的 API 流量在一天中通常会波动，每小时流量峰值最高会达到 100% 在某些高峰时段出现这些峰值属于正常现象，不会触发提醒。但是，如果 然后，您可以将提醒配置为在每小时流量增加 50% 时触发， 您的平时路况就会收到不必要的提醒。

如需详细了解提醒，请参阅设置提醒和通知。

添加路况提醒和通知

要添加路况提醒和通知，请执行以下操作： <ph type="x-smartling-placeholder">
    </ph>
  1. 在 Edge 界面中点击分析 > 提醒规则。
  2. 点击 +提醒。
  3. 输入以下有关提醒的常规信息：
    字段 说明
    提醒名称 提醒的名称。请使用能够描述触发器且对您有意义的名称。 该名称不能超过 128 个字符。
    说明 提醒的说明。
    提醒类型 选择总流量。请参阅 如需了解详情，请参阅提醒类型简介。
    环境 从下拉列表中选择环境。
    状态 切换以启用或停用提醒。
  4. 为触发提醒的条件定义阈值和维度。
    条件字段 说明
    阈值

    指定在流量增加时发出提醒，或者 与之前的时间间隔相比，下降了特定百分比。

    将增加幅度百分比设置为大于或等于 0% 的值。 将降低百分比设置为大于或等于 0% 的值， 且小于或等于 100%。

    您可以选择以下时间间隔：

    • 1 小时
    • 1 天
    • 1 周
    维度

    点击 + 添加维度，然后指定要返回哪些维度的详细信息，包括 API 代理和区域。

    将特定维度设置为：

    • 代理 - 设置为特定代理或所有代理。 Proxy 不支持 "Any" 值。改为 则可以为所需的每个代理添加单独的提醒。
    • 区域 - 设置为特定区域或所有区域。 Region 不支持 "Any" 的值。改为 则可以针对您感兴趣的每个区域添加单独的提醒
  5. 点击 + 通知 即可添加提醒通知。
    通知详情 说明
    Channel 选择要使用的通知渠道并指定目标位置：Email、Slack、PagerDuty 或网络钩子。
    目标 根据所选渠道类型指定目标位置： <ph type="x-smartling-placeholder">
      </ph>
    • 电子邮件地址 - 电子邮件地址，例如 joe@company.com
    • Slack - Slack 频道网址，例如 https://hooks.slack.com/services/T00000000/B00000000/XXXXX
    • PagerDuty - PagerDuty 代码（例如 abcd1234efgh56789）
    • 网络钩子 - 网络钩子网址，例如 https://apigee.com/test-webhook

      注意：您只能为每条通知指定一个目标位置。 要为同一渠道类型指定多个目的位置，请添加其他通知。
  6. 要添加其他通知，请重复上一步。
  7. 如果您添加了通知，请设置以下字段：
    字段 说明
    Playbook （可选）自由格式文本字段，用于简要说明针对 在触发提醒时解决警告。您还可以指定内部 Wiki 的链接，或 其中介绍了最佳做法的社区页面。此字段中的信息将 。此字段中的内容不能超过 1500 个字符。
    Throttle 发送通知的频率。从下拉列表中选择一个值。
  8. 点击保存。

在事件信息中心内查看提醒

当 Edge 检测到警报条件时，会自动将该条件记录到 Edge 界面中的事件信息中心。事件信息中心中显示的事件列表 包括所有提醒，包括固定提醒和证书提醒。

要查看提醒，请执行以下操作：

  1. 在 Edge 界面中依次点击 Analyze > Events。系统会显示新的“活动”信息中心：

  2. 按以下条件过滤“事件”信息中心：

    • 环境
    • 区域
    • 时间段
  3. 在事件信息中心内选择一行，以显示包含即将过期的证书的密钥库 进一步调查相应提醒。在“密钥库”页面中，您可以上传新证书并删除 即将过期的证书

将 Alert API 用于路况提醒

您用来创建和管理路况提醒的大多数 API 都与您所用的 API 相同 其他提醒类型：

但是，一些 API 具有用于支持异常值提醒的其他属性，包括：

创建或更新路况提醒

使用相同的 API 创建 或更新 设置路况提醒的方式与目前针对其他提醒类型执行的操作一样。 用于创建或更新路况提醒的 API 调用的正文与 并进行了以下更改：

  • 添加以下新属性，以指定此提醒是路况提醒：

    "alertType": "runtime"
"alertSubType": "trafficfixed"

    这些属性的默认值为：

    "alertType": "runtime"
"alertSubType": "fixed"
  • 在 conditions 数组的 dimensions 元素中： <ph type="x-smartling-placeholder">
      </ph>
    • 您必须设置 org、env、proxy 和 region 属性。仅支持这些属性。 您可以将 proxy 和 region 设置为 ALL。
    • 您必须将 traffic 属性的值设置为 total。

  • 在 conditions 数组中：

    • metrics 属性的值必须为 trafficChange。
    • comparator 属性设置为 increasedBy 或 decreasedBy。
    • threshold 属性包含一个正值，用于指定流量增加或减少的百分比 其中值 1.0 对应的是 100%。对于 increasedBy，该值 必须大于或等于 0.0 (0%)。对于 decreasedBy，该值必须为 大于或等于 0.0 (0%) 且小于或等于 1.0 (100%)。
    • durationSeconds 属性必须设置为以下值之一： 3600（1 小时）、86400（1 天）、604800（7 天）、 1296000（15 天）、2592000（30 天）。
  • 路况提醒不支持 reportEnabled 属性。
。 以下示例展示了如何设置提醒，当 组织和环境在一小时内增长了 50%。 当提醒被触发时，系统会向指定的 PagerDuty 代码发送通知。 
curl 'https://apimonitoring.enterprise.apigee.com/alerts' \
  -X POST \
  -H 'Accept: application/json, text/plain, */*' -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -d '{
     "organization":"myorg",
     "name":"My Traffic Alert",
     "description":"My traffic alert",
     "environment":"prod",
     "enabled":true,
     "alertType":"runtime",
     "alertSubType":"trafficfixed",
     "conditions":[
     {
        "description":"",
        "dimensions": {
            "org":"nyorg",
            "env":"prod",
            "proxy":"ALL",
            "region":"ALL",
            "traffic":"total"
        },
        "metric": "trafficChange",
        "threshold": 0.5,
        "durationSeconds": 3600,
        "comparator": "increasedBy"
     }
     ],
     "notifications":[{ "channel":"pagerduty", "destination":"abcd1234efgh56789"}],
     "playbook":"http://acme.com/myplaybook.html",
     "throttleIntervalSeconds":3600,
     "reportEnabled":true
}'

按照说明，将 $ACCESS_TOKEN 设置为您的 OAuth 2.0 访问令牌 获取 OAuth 2.0 访问令牌。 如需了解此示例中使用的 c网址 选项，请参阅使用 c网址。

如需详细了解如何使用此 API，请参阅查看事件。

接收路况提醒

默认情况下，Get Alerts API 会返回有关所有已定义的提醒的信息。 此 API 现在接受查询参数，可用于过滤结果：

  • enabled - 如果 true 指定仅返回已启用的提醒。默认值为 false。
  • alertType - 指定要返回的提醒类型。允许的值为 runtime（默认值）和 cert。
  • alertSubType - 指定要返回的提醒子类型。 默认值未设置，这意味着返回所有提醒子类型。

例如，使用以下 API 调用即可仅为名为 myorg 的组织启用提醒：

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg&enabled=true'

以下调用仅返回路况提醒，包括已启用和已停用的提醒：

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg&alertType=runtime&alertSubType=trafficfixed'

按照获取 OAuth 2.0 访问令牌中的说明，将 $ACCESS_TOKEN 设置为您的 OAuth 2.0 访问令牌。如需了解此示例中使用的 c网址 选项，请参阅使用 c网址。