Skip to content

gh-136697: Use the standard audit event format for sys.monitoring docs #136747

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 3 commits into from
Jul 17, 2025
Merged

gh-136697: Use the standard audit event format for sys.monitoring docs #136747

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8e6b516
Use the standard audit event format for sys.monitoring docs
gaogaotiantian Jul 17, 2025
52b06a5
Merge branch 'main' into monitoring-audit-docs
gaogaotiantian Jul 17, 2025
180abe7
Update sys.monitoring.rst
gaogaotiantian Jul 17, 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
4 changes: 2 additions & 2 deletions Doc/library/sys.monitoring.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -333,6 +333,8 @@ Registering callback functions
it is unregistered and returned.
Otherwise :func:`register_callback` returns ``None``.

.. audit-event:: sys.monitoring.register_callback func sys.monitoring.register_callback

Functions can be unregistered by calling
``sys.monitoring.register_callback(tool_id, event, None)``.

Expand All @@ -343,8 +345,6 @@ globally and locally. As such, if an event could be turned on for both global
and local events by your code then the callback needs to be written to handle
either trigger.

Registering or unregistering a callback function will generate a :func:`sys.audit` event.


Callback function arguments
'''''''''''''''''''''''''''
Expand Down
Loading