Skip to content

Commit de65b32

Browse files
authored
Docs/update repo name (#218)
2 parents bced622 + c0e721f commit de65b32

64 files changed

Lines changed: 214 additions & 214 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/loongsuite-release.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
# - Use publish_target: testpypi to publish to Test PyPI instead of production
2424
#
2525
# PyPI wheels: loongsuite_otel_util_genai-*, loongsuite_distro-*, loongsuite_site_bootstrap-*, loongsuite_instrumentation_* (from instrumentation-loongsuite).
26-
# loongsuite-python-agent-*.tar.gz is for GitHub Release only and must NOT be uploaded to PyPI.
26+
# loongsuite-python-*.tar.gz is for GitHub Release only and must NOT be uploaded to PyPI.
2727
#
2828
name: LoongSuite Release
2929

@@ -130,7 +130,7 @@ jobs:
130130
with:
131131
name: github-release
132132
path: |
133-
dist/loongsuite-python-agent-*.tar.gz
133+
dist/loongsuite-python-*.tar.gz
134134
dist/release-notes.md
135135
136136
# Publish to production PyPI
@@ -196,9 +196,9 @@ jobs:
196196
run: |
197197
VERSION="${{ needs.build.outputs.loongsuite_version }}"
198198
gh release create "v${VERSION}" \
199-
--title "loongsuite-python-agent ${VERSION}" \
199+
--title "loongsuite-python ${VERSION}" \
200200
--notes-file dist/release-notes.md \
201-
dist/loongsuite-python-agent-${VERSION}.tar.gz
201+
dist/loongsuite-python-${VERSION}.tar.gz
202202
203203
# Create post-release PR to main (archive changelogs + bump dev versions)
204204
post-release-pr:
@@ -256,7 +256,7 @@ jobs:
256256
--base main \
257257
--head "$BRANCH" \
258258
--title "chore: post-release ${VERSION} — archive changelogs & bump dev versions" \
259-
--body "## Post-release updates for loongsuite-python-agent ${VERSION}
259+
--body "## Post-release updates for loongsuite-python ${VERSION}
260260
261261
Automated housekeeping after the \`${VERSION}\` release:
262262

CHANGELOG-loongsuite.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
> [!NOTE]
99
> The following components are released independently and maintain individual CHANGELOG files.
10-
> Use [this search for a list of all CHANGELOG-loongsuite.md files in this repo](https://github.com/search?q=repo%3Aalibaba%2Floongsuite-python-agent+path%3A**%2FCHANGELOG-loongsuite.md&type=code).
10+
> Use [this search for a list of all CHANGELOG-loongsuite.md files in this repo](https://github.com/search?q=repo%3Aalibaba%2Floongsuite-python+path%3A**%2FCHANGELOG-loongsuite.md&type=code).
1111
1212
## Unreleased
1313

@@ -41,18 +41,18 @@ There are no changelog entries for this release.
4141
### Added
4242

4343
- Release tooling: build and publish **`instrumentation-loongsuite/*`** as separate PyPI wheels (with **`loongsuite_pypi_manifest.py`** defining which distributions are uploaded; some remain tar-only until ready), and add a **PyPI packages** section to aggregated release notes
44-
([#155](https://github.com/alibaba/loongsuite-python-agent/pull/155))
44+
([#155](https://github.com/alibaba/loongsuite-python/pull/155))
4545
- **`loongsuite-site-bootstrap`**: initialize .pth-based OTel auto-instrumentation package
46-
([#156](https://github.com/alibaba/loongsuite-python-agent/pull/156))
46+
([#156](https://github.com/alibaba/loongsuite-python/pull/156))
4747
- **Top-level docs**: add Chinese README (**`README-zh.md`**) translated from **`README.md`**.
48-
([#159](https://github.com/alibaba/loongsuite-python-agent/pull/158))
48+
([#159](https://github.com/alibaba/loongsuite-python/pull/159))
4949

5050
### Changed
5151

5252
- **`instrumentation-loongsuite/*`**, **`loongsuite-distro`**, and **`util/opentelemetry-util-genai`**: `pyproject.toml` metadata and dependencies for standalone PyPI installs
53-
([#155](https://github.com/alibaba/loongsuite-python-agent/pull/155))
53+
([#155](https://github.com/alibaba/loongsuite-python/pull/155))
5454
- **`loongsuite-site-bootstrap`**, **`loongsuite-distro`** docs: update **`README.md`**.
55-
([#159](https://github.com/alibaba/loongsuite-python-agent/pull/158))
55+
([#159](https://github.com/alibaba/loongsuite-python/pull/159))
5656

5757
## Version 0.2.0 (2026-03-12)
5858

@@ -63,9 +63,9 @@ There are no changelog entries for this release.
6363
### Fixed
6464

6565
- Add `from __future__ import annotations` to fix Python 3.9 compatibility for union type syntax (`X | Y`)
66-
([#80](https://github.com/alibaba/loongsuite-python-agent/pull/80))
66+
([#80](https://github.com/alibaba/loongsuite-python/pull/80))
6767

6868
### Added
6969

7070
- `loongsuite-distro`: initialize loongsuite python agent distro
71-
([#126](https://github.com/alibaba/loongsuite-python-agent/pull/126))
71+
([#126](https://github.com/alibaba/loongsuite-python/pull/126))

CONTRIBUTING-loongsuite-zh.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 贡献代码到 loongsuite-python-agent
1+
# 贡献代码到 loongsuite-python
22

33
为了得到更快速的响应,强烈建议您进入 DingTalk SIG 进行讨论。
44

@@ -8,7 +8,7 @@ LoongSuite Python SIG:
88

99
## 目录
1010

11-
- [贡献代码到 loongsuite-python-agent](#贡献代码到-loongsuite-python-agent)
11+
- [贡献代码到 loongsuite-python](#贡献代码到-loongsuite-python)
1212
- [目录](#目录)
1313
- [开发](#开发)
1414
- [虚拟环境](#虚拟环境)
@@ -125,19 +125,19 @@ def test_simple_start_span(benchmark):
125125

126126
### 如何创建 PR
127127

128-
欢迎所有人通过 GitHub Pull Request(PR) 为 `loongsuite-python-agent` 贡献代码。
128+
欢迎所有人通过 GitHub Pull Request(PR) 为 `loongsuite-python` 贡献代码。
129129

130130
要创建新的 PR,请在 GitHub 上 fork 项目并克隆上游仓库:
131131

132132
```sh
133-
git clone https://github.com/alibaba/loongsuite-python-agent.git
134-
cd loongsuite-python-agent
133+
git clone https://github.com/alibaba/loongsuite-python.git
134+
cd loongsuite-python
135135
```
136136

137137
将您的 fork 添加为 origin:
138138

139139
```sh
140-
git remote add fork https://github.com/YOUR_GITHUB_USERNAME/loongsuite-python-agent.git
140+
git remote add fork https://github.com/YOUR_GITHUB_USERNAME/loongsuite-python.git
141141
```
142142

143143
确保您已安装所有支持的 Python 版本,首次安装 `tox`
@@ -171,7 +171,7 @@ git commit
171171
git push fork feature
172172
```
173173

174-
针对 `loongsuite-python-agent` 仓库打开 PR。
174+
针对 `loongsuite-python` 仓库打开 PR。
175175

176176
### 如何接收评论
177177

@@ -184,7 +184,7 @@ git push fork feature
184184

185185
请在 PR 中 @ 对应组件的贡献者,如果您找不到合适的 Reviewer,则可以联系 Maintainer 解决。
186186

187-
为了得到更快速的响应,强烈建议您进入 DingTalk SIG 进行讨论。请查看[贡献代码到 loongsuite-python-agent](#贡献代码到-loongsuite-python-agent)
187+
为了得到更快速的响应,强烈建议您进入 DingTalk SIG 进行讨论。请查看[贡献代码到 loongsuite-python](#贡献代码到-loongsuite-python)
188188

189189
> [!TIP]
190190
> 即使您是新手,您的审查也很重要——对项目很有价值。请随时参与任何开放的 PR:检查文档、运行测试、提出问题,或在看起来不错时给出 +1。任何人都可以审查 PR 并帮助它们被合并。每条评论都推动项目向前发展,所以如果您有专业知识来审查 PR,请不要犹豫。
@@ -204,7 +204,7 @@ git push fork feature
204204

205205
## 设计选择
206206

207-
与其他 LoongSuite 探针一样,loongsuite-python-agent 遵循
207+
与其他 LoongSuite 探针一样,loongsuite-python 遵循
208208
[opentelemetry-specification](https://github.com/open-telemetry/opentelemetry-specification)
209209

210210
推荐阅读 [库指南](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/library-guidelines.md)
@@ -224,7 +224,7 @@ OpenTelemetry 是一个不断发展的规范,其中需求和
224224

225225
## 本地运行测试
226226

227-
1. 转到您的 Python Agent 仓库目录。`git clone git@github.com:alibaba/loongsuite-python-agent.git && cd loongsuite-python-agent`
227+
1. 转到您的 Python Agent 仓库目录。`git clone git@github.com:alibaba/loongsuite-python.git && cd loongsuite-python`
228228
2. 确保您已安装 `tox``pip install tox`
229229
3. 运行 `tox` 不带任何参数以运行所有包的测试。阅读更多关于 [tox](https://tox.readthedocs.io/en/latest/) 的信息。
230230

@@ -247,7 +247,7 @@ tox -e py312-test-instrumentation-aiopg
247247
CORE_REPO_SHA=c49ad57bfe35cfc69bfa863d74058ca9bec55fc3 tox
248248
```
249249

250-
持续集成会根据[此处](https://github.com/alibaba/loongsuite-python-agent/blob/main/.github/workflows/test_0.yml#L14)的配置覆盖该环境变量。
250+
持续集成会根据[此处](https://github.com/alibaba/loongsuite-python/blob/main/.github/workflows/test_0.yml#L14)的配置覆盖该环境变量。
251251

252252
## 风格指南
253253

@@ -262,28 +262,28 @@ CORE_REPO_SHA=c49ad57bfe35cfc69bfa863d74058ca9bec55fc3 tox
262262
- 为了确保一致性,我们鼓励与 [STABLE](https://opentelemetry.io/docs/specs/otel/document-status/#lifecycle-status) 语义约定(如果可用)对齐的贡献。这种方法有助于我们避免潜在的混淆,并减少支持多个过时版本的语义约定的需要。但是,我们仍然愿意考虑有充分理由的例外情况。
263263
- 与过时的 HTTP 语义约定相关的贡献(在成为[稳定](https://github.com/open-telemetry/semantic-conventions/tree/v1.23.0)之前的约定)可能会被劝阻,因为它们增加了复杂性和误解的可能性。
264264
- 包含一个在 [Pypi](https://pypi.org/) 中尚未被占用的名称。如果所需名称已被占用,请联系维护者。
265-
- 继承自 [BaseInstrumentor](https://github.com/alibaba/loongsuite-python-agent/blob/2518a4ac07cb62ad6587dd8f6cbb5f8663a7e179/opentelemetry-instrumentation/src/opentelemetry/instrumentation/instrumentor.py#L35)
265+
- 继承自 [BaseInstrumentor](https://github.com/alibaba/loongsuite-python/blob/2518a4ac07cb62ad6587dd8f6cbb5f8663a7e179/opentelemetry-instrumentation/src/opentelemetry/instrumentation/instrumentor.py#L35)
266266
- 支持自动 instrumentation
267267
- [在此处](./instrumentation-loongsuite/)新增一个新的 instrumentation 包,命名必须以 loongsuite-instrumentation 开头
268-
- 添加入口点(例如 <https://github.com/alibaba/loongsuite-python-agent/blob/2518a4ac07cb62ad6587dd8f6cbb5f8663a7e179/instrumentation/opentelemetry-instrumentation-requests/pyproject.toml#L44>
268+
- 添加入口点(例如 <https://github.com/alibaba/loongsuite-python/blob/2518a4ac07cb62ad6587dd8f6cbb5f8663a7e179/instrumentation/opentelemetry-instrumentation-requests/pyproject.toml#L44>
269269
- 添加新的 instrumentation 包后运行 `python scripts/generate_instrumentation_bootstrap.py`
270-
- 在其他 instrumentation 中通用且可以抽象的功能[在此处](https://github.com/alibaba/loongsuite-python-agent/tree/main/opentelemetry-instrumentation/src/opentelemetry/instrumentation),如果需要修改其中的内容,建议优先提交 issue 或 draft PR,Maintainer 会协助你贡献到上游的 OpenTelemetry 社区。
271-
- HTTP instrumentation 的请求/响应 [hooks](https://github.com/alibaba/loongsuite-python-agent/issues/408)
270+
- 在其他 instrumentation 中通用且可以抽象的功能[在此处](https://github.com/alibaba/loongsuite-python/tree/main/opentelemetry-instrumentation/src/opentelemetry/instrumentation),如果需要修改其中的内容,建议优先提交 issue 或 draft PR,Maintainer 会协助你贡献到上游的 OpenTelemetry 社区。
271+
- HTTP instrumentation 的请求/响应 [hooks](https://github.com/alibaba/loongsuite-python/issues/408)
272272
- `suppress_instrumentation` 功能
273-
- 例如 <https://github.com/alibaba/loongsuite-python-agent/blob/2518a4ac07cb62ad6587dd8f6cbb5f8663a7e179/opentelemetry-instrumentation/src/opentelemetry/instrumentation/utils.py#L191>
273+
- 例如 <https://github.com/alibaba/loongsuite-python/blob/2518a4ac07cb62ad6587dd8f6cbb5f8663a7e179/opentelemetry-instrumentation/src/opentelemetry/instrumentation/utils.py#L191>
274274
- 抑制传播功能
275-
- https://github.com/alibaba/loongsuite-python-agent/issues/344 了解更多上下文
275+
- https://github.com/alibaba/loongsuite-python/issues/344 了解更多上下文
276276
- `exclude_urls` 功能
277-
- 例如 <https://github.com/alibaba/loongsuite-python-agent/blob/2518a4ac07cb62ad6587dd8f6cbb5f8663a7e179/instrumentation/opentelemetry-instrumentation-flask/src/opentelemetry/instrumentation/flask/__init__.py#L327>
277+
- 例如 <https://github.com/alibaba/loongsuite-python/blob/2518a4ac07cb62ad6587dd8f6cbb5f8663a7e179/instrumentation/opentelemetry-instrumentation-flask/src/opentelemetry/instrumentation/flask/__init__.py#L327>
278278
- `url_filter` 功能
279-
- 例如 <https://github.com/alibaba/loongsuite-python-agent/blob/2518a4ac07cb62ad6587dd8f6cbb5f8663a7e179/instrumentation/opentelemetry-instrumentation-aiohttp-client/src/opentelemetry/instrumentation/aiohttp_client/__init__.py#L268>
279+
- 例如 <https://github.com/alibaba/loongsuite-python/blob/2518a4ac07cb62ad6587dd8f6cbb5f8663a7e179/instrumentation/opentelemetry-instrumentation-aiohttp-client/src/opentelemetry/instrumentation/aiohttp_client/__init__.py#L268>
280280
- 在非采样 span 上的 `is_recording()` 优化
281-
- 例如 <https://github.com/alibaba/loongsuite-python-agent/blob/2518a4ac07cb62ad6587dd8f6cbb5f8663a7e179/instrumentation/opentelemetry-instrumentation-requests/src/opentelemetry/instrumentation/requests/__init__.py#L234>
281+
- 例如 <https://github.com/alibaba/loongsuite-python/blob/2518a4ac07cb62ad6587dd8f6cbb5f8663a7e179/instrumentation/opentelemetry-instrumentation-requests/src/opentelemetry/instrumentation/requests/__init__.py#L234>
282282
- 适当的错误处理
283-
- 例如 <https://github.com/alibaba/loongsuite-python-agent/blob/2518a4ac07cb62ad6587dd8f6cbb5f8663a7e179/instrumentation/opentelemetry-instrumentation-requests/src/opentelemetry/instrumentation/requests/__init__.py#L220>
283+
- 例如 <https://github.com/alibaba/loongsuite-python/blob/2518a4ac07cb62ad6587dd8f6cbb5f8663a7e179/instrumentation/opentelemetry-instrumentation-requests/src/opentelemetry/instrumentation/requests/__init__.py#L220>
284284
- 隔离同步和异步测试
285285
- 对于同步测试,典型的测试用例类继承自 `opentelemetry.test.test_base.TestBase`。但是,如果您想编写异步测试,测试用例类还应继承自 `IsolatedAsyncioTestCase`。将异步测试添加到公共测试类可能导致测试通过但实际上没有运行,这可能会产生误导。
286-
- 例如 <https://github.com/alibaba/loongsuite-python-agent/blob/60fb936b7e5371b3e5587074906c49fb873cbd76/instrumentation/opentelemetry-instrumentation-grpc/tests/test_aio_server_interceptor.py#L84>
286+
- 例如 <https://github.com/alibaba/loongsuite-python/blob/60fb936b7e5371b3e5587074906c49fb873cbd76/instrumentation/opentelemetry-instrumentation-grpc/tests/test_aio_server_interceptor.py#L84>
287287
- 大多数 instrumentation 具有相同的版本。如果您要开发新的 instrumentation,它可能具有 `X.Y.dev` 版本,并依赖于 `opentelemetry-instrumentation``opentelemetry-semantic-conventions`[兼容版本](https://peps.python.org/pep-0440/#compatible-release)。这意味着您可能需要从 git 安装此仓库的 instrumentation 依赖项和核心仓库的依赖项。
288288
- 文档
289289
- 添加新 instrumentation 时,请记住在 `docs/instrumentation/` 中添加名为 `<instrumentation>/<instrumentation>.rst` 的条目,以便从索引中引用 instrumentation 文档。您可以使用[此处](./_template/autodoc_entry.rst)提供的条目模板
@@ -329,7 +329,7 @@ instruments-any = [
329329

330330
* Approve PR:任意来源的 approve 都是允许的,您可以通过 approve 来推动 PR 的合并进程,但在合并事实达成之前,仍需 Maintainer 之一进行 approve。
331331

332-
* 跟踪和创建问题:要跟踪与生成式 AI 相关的问题,请在创建或搜索问题时过滤或添加标签 [genai](https://github.com/alibaba/loongsuite-python-agent/issues?q=is%3Aissue%20state%3Aopen%20label%3Agenai)。如果您没有看到与您想要贡献的 instrumentation 相关的问题,请创建一个新的跟踪问题,以便社区了解其进展。
332+
* 跟踪和创建问题:要跟踪与生成式 AI 相关的问题,请在创建或搜索问题时过滤或添加标签 [genai](https://github.com/alibaba/loongsuite-python/issues?q=is%3Aissue%20state%3Aopen%20label%3Agenai)。如果您没有看到与您想要贡献的 instrumentation 相关的问题,请创建一个新的跟踪问题,以便社区了解其进展。
333333

334334
## 对贡献者的期望
335335

README-zh.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# loongsuite-python-agent
1+
# loongsuite-python
22
<img src="docs/_assets/img/loongsuite-logo.png" width="600" height="100">
33

44
<div align="center">
@@ -12,8 +12,8 @@ LoongSuite Python Agent 是 LoongSuite(阿里巴巴统一可观测数据采集
1212

1313
LoongSuite 包含以下核心组件:
1414
* [LoongCollector](https://github.com/alibaba/loongcollector):通用节点 Agent,基于 eBPF 提供日志采集、Prometheus 指标采集以及网络与安全采集能力。
15-
* [LoongSuite Python Agent](https://github.com/alibaba/loongsuite-python-agent):为 Python 应用提供埋点能力的进程 Agent。
16-
* [LoongSuite Go Agent](https://github.com/alibaba/loongsuite-go-agent):支持编译期埋点的 Golang 进程 Agent。
15+
* [LoongSuite Python Agent](https://github.com/alibaba/loongsuite-python):为 Python 应用提供埋点能力的进程 Agent。
16+
* [LoongSuite Go Agent](https://github.com/alibaba/loongsuite-go):支持编译期埋点的 Golang 进程 Agent。
1717
* [LoongSuite Java Agent](https://github.com/alibaba/loongsuite-java-agent):面向 Java 应用的进程 Agent。
1818
* 其他语言 Agent 正在建设中。
1919

@@ -228,7 +228,7 @@ LoongSuite Python Agent 同时也是上游 [OTel Python Agent](https://github.co
228228

229229
**步骤 2 — 安装 instrumentations**
230230

231-
使用 **`loongsuite-bootstrap`**(随 `loongsuite-distro` 提供)可从 [GitHub Release](https://github.com/alibaba/loongsuite-python-agent/releases) tarball 安装 LoongSuite wheel,并从 PyPI 安装兼容版本的 `opentelemetry-instrumentation-*`。Bootstrap 采用**两阶段**安装:先安装 Release 中的 LoongSuite 制品,再安装固定版本 OpenTelemetry instrumentation(见 [docs/loongsuite-release.md](docs/loongsuite-release.md))。
231+
使用 **`loongsuite-bootstrap`**(随 `loongsuite-distro` 提供)可从 [GitHub Release](https://github.com/alibaba/loongsuite-python/releases) tarball 安装 LoongSuite wheel,并从 PyPI 安装兼容版本的 `opentelemetry-instrumentation-*`。Bootstrap 采用**两阶段**安装:先安装 Release 中的 LoongSuite 制品,再安装固定版本 OpenTelemetry instrumentation(见 [docs/loongsuite-release.md](docs/loongsuite-release.md))。
232232

233233
以下方式三选一:
234234

@@ -365,15 +365,15 @@ loongsuite-instrument \
365365
**步骤 1 — 克隆仓库并切换分支**
366366

367367
```bash
368-
git clone https://github.com/alibaba/loongsuite-python-agent.git
368+
git clone https://github.com/alibaba/loongsuite-python.git
369369
```
370370

371371
**步骤 2 — 安装上游 OpenTelemetry Python core 与本地 LoongSuite 组件**
372372

373373
[opentelemetry-python](https://github.com/open-telemetry/opentelemetry-python) 的 Git checkout 安装 core,并与本地可编辑包一次性安装,例如:
374374

375375
```bash
376-
cd loongsuite-python-agent
376+
cd loongsuite-python
377377
GIT_ROOT="git+https://github.com/open-telemetry/opentelemetry-python.git"
378378
# 必须用一条 pip install:让 resolver 同时看到全部约束;
379379
# 分步安装时,后续安装本地 editable 包可能触发 api/semconv 被降级或替换。

0 commit comments

Comments
 (0)