Skip to content

gh-135361: update documentation for remote_debugger_script audit event #135362

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Jun 15, 2025
Merged

gh-135361: update documentation for remote_debugger_script audit event #135362

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f3446a1
gh-135361: update documentation for remote_debugger_script audit event
Zheaoli Jun 10, 2025
8ed5410
fix review idea
Zheaoli Jun 15, 2025
2d79997
Merge branch 'main' into manjusaka/gh135361
Zheaoli Jun 15, 2025
a25fcda
Update docs
Zheaoli Jun 15, 2025
4df1a15
Merge branch 'manjusaka/gh135361' of github.com:Zheaoli/cpython into …
Zheaoli Jun 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions Doc/library/sys.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1933,6 +1933,13 @@ always available. Unless explicitly noted otherwise, all variables are read-only
interpreter is pre-release (alpha, beta, or release candidate) then the
local and remote interpreters must be the same exact version.

Copy link
Member

Choose a reason for hiding this comment

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

I misunderstood the audit event. It's recorded by the debugged process. The documentation should clarify that.

Or maybe the audit event should also be logged by the process which calls sys.remote_exec().

Copy link
Member

Choose a reason for hiding this comment

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

We can do both no?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I can update and add more info, BTW I think we can logged the event at both side

Copy link
Member

Choose a reason for hiding this comment

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

I think we should get an audit event in sys.remote_exec() yes

Copy link
Member

Choose a reason for hiding this comment

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

we need a new issue for that

.. audit-event:: remote_debugger_script script_path

When the script is executed in the remote process, an
:ref:`auditing event <auditing>`
``sys.remote_debugger_script`` is raised
with the path in the remote process.

.. availability:: Unix, Windows.
.. versionadded:: 3.14

Expand Down
Loading