Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Translate the python agent README.md into English #58

Merged
merged 4 commits into from
Aug 28, 2023

Conversation

dbgsprw
Copy link
Contributor

@dbgsprw dbgsprw commented Mar 29, 2023

No description provided.

@dbgsprw dbgsprw requested review from a team and junoyoon as code owners March 29, 2023 05:58
@github-actions
Copy link

github-actions bot commented Mar 29, 2023

Scavenger Test Results

158 files  158 suites   1m 53s ⏱️
263 tests 251 ✔️ 12 💤 0
277 runs  265 ✔️ 12 💤 0

Results for commit 49aa4fe.

♻️ This comment has been updated with latest results.

@taeyeon-Kim
Copy link
Contributor

@dbgsprw Can you add information about the Python agent to the README.md as well?

@@ -17,6 +17,8 @@ Scavenger provides more sophisticated and clear UI and elaborate the instrumenta
* Provide APs for exploring invocations.
* Scavenger Frontend
* Provides UI.
* Scavenger Python Agent (BETA)
* Python agent of Scavenger Agent described above.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about adding a link to the guide as well?

Copy link
Collaborator

@junoyoon junoyoon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dbgsprw
I left reviews, please check it

### 한계
* Graceful Shutdown에 대한 구현은 기존 프레임워크와의 충돌 가능성으로 인해 자동으로 지원하지 않습니다. 대신 아래와 같은 `agent.shutdown()` 함수를 지원하므로 직접 등록하여서 사용하여야 합니다.
### Limitations
* The implementation of Graceful Shutdown is not automatically supported due to potential conflicts with existing frameworks. Instead, the `agent.shutdown()` function as shown below is supported, so you must register and use it yourself.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* The implementation of Graceful Shutdown is not automatically supported due to potential conflicts with existing frameworks. Instead, the `agent.shutdown()` function as shown below is supported, so you must register and use it yourself.
* The implementation of Graceful Shutdown is not automatically supported due to potential conflicts with existing frameworks. Instead, the `agent.shutdown()` function as shown below is provided, so you must register it into your framework shutdown routine by yourself.

@@ -96,4 +97,4 @@ app = Flask(__name__)
def hello_world():
return 'Hello World!'
```
* 코드를 직접 읽어서 메서드를 탐색해야 하므로 pyc 파일은 현재 지원되지 않습니다.
* Pyc files are currently not supported because Python code must be read by the agent.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Pyc files are currently not supported because Python code must be read by the agent.
* The direct Instrumentation for pyc files are currently not supported because Python code must be read by the scavenger agent.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In that case, how about updating Korean too?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good!!

@junoyoon
Copy link
Collaborator

@dbgsprw please check the review result

@junoyoon
Copy link
Collaborator

@dbgsprw please. comment sth~

@dbgsprw dbgsprw force-pushed the update-python-agent-readme branch from 131284e to 829f64a Compare June 14, 2023 13:13
@dbgsprw
Copy link
Contributor Author

dbgsprw commented Jun 14, 2023

@junoyoon
I'm sorry. I checked the notification mail too late.
I updated README.md as you suggested.

@dbgsprw dbgsprw merged commit fbba51e into develop Aug 28, 2023
5 checks passed
@dbgsprw dbgsprw deleted the update-python-agent-readme branch August 28, 2023 00:34
@kojandy kojandy linked an issue Aug 30, 2023 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

python agent 가이드 영문화
4 participants