Apache SkyWalking Python 项目教程

Apache SkyWalking Python 项目教程

skywalking-pythonThe Python agent for Apache SkyWalking项目地址:https://gitcode.com/gh_mirrors/sk/skywalking-python

1. 项目的目录结构及介绍

Apache SkyWalking Python 项目的目录结构如下：

skywalking-python/
├── docker/
├── docs/
├── protocol/
├── skywalking/
├── tests/
├── tools/
├── .asf.yaml
├── .dockerignore
├── .gitignore
├── .gitmodules
├── .licenserc.yaml
├── CHANGELOG.md
├── CONTRIBUTING.md
├── LICENSE
├── Makefile
├── NOTICE
├── README.md
├── poetry.lock
├── poetry.toml
├── pyproject.toml
└── setup.cfg

目录介绍

• docker/: 包含与 Docker 相关的文件和配置。
• docs/: 包含项目的文档文件。
• protocol/: 包含协议相关的文件。
• skywalking/: 核心代码目录，包含 Python 代理的主要实现。
• tests/: 包含测试文件和测试配置。
• tools/: 包含项目使用的工具文件。
• .asf.yaml: Apache 软件基金会配置文件。
• .dockerignore: Docker 忽略文件。
• .gitignore: Git 忽略文件。
• .gitmodules: Git 子模块配置文件。
• .licenserc.yaml: 许可证配置文件。
• CHANGELOG.md: 变更日志文件。
• CONTRIBUTING.md: 贡献指南文件。
• LICENSE: 许可证文件。
• Makefile: Makefile 文件，用于构建和测试。
• NOTICE: 通知文件。
• README.md: 项目自述文件。
• poetry.lock: Poetry 锁定文件。
• poetry.toml: Poetry 配置文件。
• pyproject.toml: Python 项目配置文件。
• setup.cfg: 安装配置文件。

2. 项目的启动文件介绍

项目的启动文件主要位于 skywalking/ 目录下，其中 skywalking/__init__.py 是项目的入口文件。该文件初始化并配置 SkyWalking Python 代理，使其能够进行追踪、度量、日志和性能分析。

3. 项目的配置文件介绍

项目的配置文件主要包括以下几个：

• pyproject.toml: 定义了项目的依赖、构建系统和元数据。
• setup.cfg: 包含安装和打包的配置信息。
• skywalking/config.py: 包含 SkyWalking Python 代理的配置选项，如追踪开关、日志级别等。

pyproject.toml 示例

[tool.poetry]
name = "skywalking"
version = "0.0.1"
description = "The Python agent for Apache SkyWalking"
authors = ["Apache SkyWalking <dev@skywalking.apache.org>"]
license = "Apache-2.0"

[tool.poetry.dependencies]
python = "^3.6"

setup.cfg 示例

[metadata]
name = skywalking
version = 0.0.1
description = The Python agent for Apache SkyWalking
author = Apache SkyWalking
author_email = dev@skywalking.apache.org
license = Apache-2.0

[options]
packages = find:
python_requires = >=3.6

skywalking/config.py 示例

class Config:
    TRACE_ENABLED = True
    LOG_LEVEL = 'INFO'
    # 其他配置选项...

通过这些配置文件，用户可以自定义 SkyWalking Python 代理的行为和功能。

skywalking-pythonThe Python agent for Apache SkyWalking项目地址:https://gitcode.com/gh_mirrors/sk/skywalking-python