菜单
开源

Python

当Python配置文件与Pyroscope集成时,它可以改变您分析和优化Python应用程序的方式。这种组合提供了无与伦比的实时洞察力,深入了解您的Python代码库,精确识别性能问题。它是专注于提高代码效率和应用程序速度的Python开发者的必备工具。

注意

有关支持每种语言的支持配置文件类型列表,请参阅可用的配置文件类型

开始之前

要捕获和分析性能分析数据,您需要一个托管 Pyroscope OSS 服务器或一个带有 Grafana Cloud Profiles 的托管 Pyroscope 实例(需要免费 Grafana Cloud 账户)。

Pyroscope 服务器可以是用于开发的本地服务器或用于生产的远程服务器。

将 Python 性能分析添加到您的应用程序

安装 pyroscope-io pip 包

bash
pip install pyroscope-io

配置 Python 客户端

将以下代码添加到您的应用程序中。此代码将初始化 Pyroscope 分析器和开始分析

python
import pyroscope

pyroscope.configure(
  application_name = "my.python.app", # replace this with some name for your application
  server_address   = "http://my-pyroscope-server:4040", # replace this with the address of your Pyroscope server
)

可选,您可以配置一些其他参数

python
import pyroscope

pyroscope.configure(
    application_name    = "my.python.app", # replace this with some name for your application
    server_address      = "http://my-pyroscope-server:4040", # replace this with the address of your Pyroscope server
    sample_rate         = 100, # default is 100
    detect_subprocesses = False, # detect subprocesses started by the main process; default is False
    oncpu               = True, # report cpu time only; default is True
    gil_only            = True, # only include traces for threads that are holding on to the Global Interpreter Lock; default is True
    enable_logging      = True, # does enable logging facility; default is False
    tags                = {
        "region": '{os.getenv("REGION")}',
    }
)

将性能标签添加到 Python 应用程序

您可以在代码的某些部分添加标签

python
# You can use a wrapper:
with pyroscope.tag_wrapper({ "controller": "slow_controller_i_want_to_profile" }):
    slow_code()

使用 Python SDK 将数据发送到 Pyroscope OSS 或 Grafana Cloud Profiles

python
import pyroscope

pyroscope.configure(
    application_name = "example.python.app",
    server_address = "<URL>",
    basic_auth_username = '<User>',
    basic_auth_password = '<Password>',
    # Optional Pyroscope tenant ID (only needed if using multi-tenancy). Not needed for Grafana Cloud.
    # tenant_id = "<TenantID>",
)

要配置 Python SDK 以将数据发送到 Pyroscope,将 <URL> 占位符替换为适当的服务器 URL。这可以是 Grafana Cloud URL 或您自己的自定义 Pyroscope 服务器 URL。

如果您需要将数据发送到 Grafana Cloud,您必须配置 HTTP Basic 认证。将 <User> 替换为您的 Grafana Cloud 堆栈用户,将 <Password> 替换为您的 Grafana Cloud API 密钥。

如果您的 Pyroscope 服务器已启用多租户,您需要配置一个租户 ID。将 <TenantID> 替换为您的 Pyroscope 租户 ID。

Python 性能分析示例

查看以下资源以了解更多关于 Python 性能分析的信息