Locust测试CloudRunAPI：trust\_env作用详解

在使用Locust对Cloud Run API进行性能测试时，遇到连接超时问题？本文深入解析了`trust_env`参数在解决此类问题中的关键作用。当Locust脚本报告ConnectTimeoutError，而本地测试和curl请求均正常时，问题可能源于Locust未能正确识别并利用系统或环境中的代理设置。解决方案在于确保在HTTP请求中设置`trust_env = True`，强制Locust的底层HTTP客户端信任并应用环境中的代理配置，从而成功建立与Cloud Run服务的连接。通过本文的详细示例和注意事项，您将能够有效解决Locust测试Cloud Run API时的连接超时问题，确保性能测试顺利进行。

问题描述与分析

在使用Locust对部署在Google Cloud Run上的API进行性能测试时，开发者可能会遇到ConnectTimeoutError，即使本地API版本和Cloud Run上的API版本通过curl命令都能正常响应。这种现象尤其令人困惑，因为这表明API本身是可访问的，问题出在Locust发起请求的环节。

常见的排查步骤可能包括：

1. 验证API可访问性： 确认Cloud Run服务已部署并公开可用，使用curl命令直接访问其URL验证连通性。
2. 检查Locust脚本中的URL： 确保Locust脚本中使用的API URL是正确的Cloud Run服务URL。
3. 考虑代理配置： 如果Locust运行环境或目标API需要通过代理访问，开发者通常会在Locust脚本中尝试配置proxies参数。
4. 检查认证问题： 即使API被设置为公开，有时也可能因权限配置不当导致访问受阻，因此尝试将API设为完全公开进行测试也是一个排查方向。
5. 查看日志： 检查Cloud Run服务的日志，看是否有任何请求到达的记录，或者是否有错误日志。如果日志中没有任何请求信息，则表明请求根本没有到达Cloud Run服务。

当上述排查均无效，特别是Locust报告ConnectTimeoutError且Cloud Run日志没有任何请求记录时，问题往往指向Locust客户端（底层使用Python requests库）在建立连接时的网络配置问题，尤其是与代理相关的配置。

解决方案：trust_env = True

问题的核心在于requests库（Locust的HttpClient底层所使用的库）在处理代理配置时的一个细节：trust_env参数。

requests库默认会检查并使用来自环境的环境变量（如HTTP_PROXY、HTTPS_PROXY、NO_PROXY）来配置代理。然而，在某些特定场景下，或者如果requests.Session对象被显式配置了trust_env=False，或者在复杂的网络环境中，即使你通过proxies参数显式地在Locust脚本中设置了代理，requests库可能仍然无法正确地利用这些代理或环境中的其他代理设置来建立连接。

解决方案是，在Locust脚本中发起HTTP请求时，确保将trust_env参数设置为True。这将强制requests库信任并应用来自环境的代理配置，使其能够正确地通过代理服务器路由请求，从而成功连接到Cloud Run服务。

示例代码

以下是一个Locust脚本的示例，演示了如何在TaskSet或User类中正确使用trust_env=True来解决连接超时问题：

from locust import HttpUser, task, between

class MyCloudRunUser(HttpUser):
    """
    一个用于测试Cloud Run API的Locust用户类
    """
    wait_time = between(1, 2)  # 用户每次任务之间的等待时间
    host = "https://your-cloud-run-service-url.run.app"  # 替换为你的Cloud Run服务URL

    @task
    def access_api_endpoint(self):
        """
        定义一个任务，访问API的一个特定端点。
        这里演示了如何使用 trust_env=True。
        """
        try:
            # Locust的HttpClient (self.client) 是 requests.Session 的一个包装。
            # 可以在请求方法中直接传递 trust_env 参数。
            response = self.client.get("/your-api-path", trust_env=True)

            # 检查响应状态码
            if response.status_code == 200:
                print(f"请求成功: {response.status_code}")
            else:
                print(f"请求失败: {response.status_code}, 响应: {response.text}")

        except Exception as e:
            print(f"请求发生错误: {e}")
            # 可以选择在这里报告失败，例如 self.environment.events.request.fire(...)
            # 但Locust通常会自动捕获连接错误并报告为失败。

    # 如果你的API有其他端点，可以添加更多任务
    # @task
    # def another_api_endpoint(self):
    #     self.client.post("/another-path", json={"key": "value"}, trust_env=True)

如何运行此脚本：

1. 将host变量替换为你的实际Cloud Run服务URL。
2. 将/your-api-path替换为你的API实际路径。
3. 保存为your_locust_script.py。
4. 在终端中运行Locust：locust -f your_locust_script.py
5. 打开浏览器访问Locust Web UI（通常是http://localhost:8089），开始测试。

注意事项与总结

1. 代理配置优先级： 当trust_env=True时，requests库会优先考虑通过proxies参数显式传入的代理配置，然后是环境变量中的代理配置。确保你的环境配置和脚本中的显式配置不会相互冲突或导致意外行为。
2. 环境代理变量： 确保Locust运行的环境中，如果需要通过代理访问外部网络，相应的环境变量（如HTTP_PROXY, HTTPS_PROXY, NO_PROXY）已正确设置。例如，在Linux或macOS上：

   export HTTP_PROXY="http://your_proxy_ip:port"
   export HTTPS_PROXY="http://your_proxy_ip:port"
   # 如果有不需要走代理的地址，可以设置 NO_PROXY
   export NO_PROXY="localhost,127.0.0.1,your-internal-domain.com"

3. Cloud Run网络配置： 尽管本文的解决方案主要针对Locust客户端问题，但也要确认Cloud Run服务的网络配置是否允许来自Locust运行环境的入站连接。对于公开的Cloud Run服务，通常不是问题，但如果是内部服务或需要VPC连接器，则需要额外配置。
4. Locust日志级别： 如果问题依然存在，可以尝试提高Locust的日志级别（例如，通过命令行参数--loglevel DEBUG），以获取更详细的调试信息，帮助定位问题。
5. 持续监控： 在性能测试过程中，除了Locust本身的报告，还应密切关注Cloud Run的日志和监控指标（如请求延迟、错误率），以便全面评估API的性能和稳定性。

通过理解requests库的trust_env参数及其与代理配置的交互，开发者可以有效解决Locust测试Cloud Run API时遇到的连接超时问题，确保性能测试能够顺利进行。

今天关于《Locust测试CloudRunAPI：trust\_env作用详解》的内容就介绍到这里了，是不是学起来一目了然！想要了解更多关于的内容请关注golang学习网公众号！