GenericRandomErrorPlugin

失败请求,其中包含模拟错误的文件中随机选择的错误。

命令提示符的屏幕截图,其中开发人员代理模拟了配置文件中定义的 OpenAI API 请求的错误之一。

配置示例

{
  "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v4.0.0/rc.schema.json",
  "plugins": [
    {
      "name": "GenericRandomErrorPlugin",
      "enabled": true,
      "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
      "configSection": "genericRandomErrorPlugin"
    }
  ],
  "urlsToWatch": [
    "https://api.openai.com/*"
  ],
  "genericRandomErrorPlugin": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v4.0.0/genericrandomerrorplugin.schema.json",
    "errorsFile": "errors.json"
  }
}

配置属性

财产 描述 违约
errorsFile 包含错误响应的文件的路径。 errors.json
rate 失败的请求百分比,并出现随机错误。 介于 0 和 100 之间的值。 50
retryAfterInSeconds 重试请求之前等待的秒数。 包含在动态限制的 Retry-After 响应标头中。 5

命令行选项

名称 描述 违约
-f, --failure-rate <failure rate> 失败的请求百分比,并出现随机错误。 介于 0 和 100 之间的值。 50

注解

响应正文

如果将错误响应的属性设置为 body JSON 对象或数组,则开发人员代理将其序列化为 JSON。 如果将字符串设置为字符串,则 Dev Proxy 将发送字符串 as-is,而不用周围引号。 一个以 开头 @ 的字符串被视为相对于错误文件的路径,以及响应正文。 由于开发代理将标头默认为 Content-Typeapplication/json,因此在返回非 JSON 内容时, Content-Type 请将标头设置为与内容匹配,例如 text/plain。

每个响应 Retry-After 值

开发代理在标头中解析@dynamic任何状态代码,例如429,503或529。Retry-After 它与标头名称匹配,而不考虑大小写。 解析 @dynamic后,它还向 RetryAfterPlugin 注册请求,该请求报告应用在时间启动之前 Retry-After 发送的请求。

默认情况下, Retry-After 标头使用全局 retryAfterInSeconds 值。 可以使用错误响应文件中的语法(即@dynamic=N重试前等待的秒数)基于N每个响应重写此值。

{
  "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v4.0.0/genericrandomerrorplugin.errorsfile.schema.json",
  "errors": [
    {
      "request": {
        "url": "https://api.openai.com/*"
      },
      "responses": [
        {
          "statusCode": 429,
          "headers": [
            {
              "name": "Retry-After",
              "value": "@dynamic=17"
            }
          ],
          "body": {
            "error": {
              "message": "Rate limit exceeded. Wait 17 seconds."
            }
          }
        }
      ]
    }
  ]
}

在此示例中, Retry-After 标头对此响应使用 17 秒,而不考虑全局 retryAfterInSeconds 设置。 该值在每个后续限制请求上递增,就像使用纯 @dynamic 令牌一样。

默认 Content-Type 标头

如果错误响应具有 body 且未定义 Content-Type 标头,则 Dev Proxy 返回具有标头的 Content-Type: application/json 响应。 若要返回其他内容类型,请将 Content-Type 标头添加到错误文件中的响应中。 开发代理使用指定的值。

后续步骤