openstack/oslo.log
Code Issues Proposed changes

Use updated 'project' keyword for config docs

Browse Source 
The 'project' and 'project_name' keyword has been in used since Change
Id6d4b6eaa2b96ba5bd53e8b2dae5d9eea13b25d9

Also updated other minor docs

[1] https://opendev.org/openstack/oslo.log/src/branch/stable/2024.2/oslo_log/_options.py#L181

Change-Id: Iac1e5f98d9dd1dd423789cbe39589e93d62fb5e1
This commit is contained in:
Jake Yip
2025-03-06 11:27:42 +11:00
parent 0c290b13a9
commit 3635659871
3 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
doc/source/configuration/index.rst
View File

@ -127,14 +127,14 @@ oslo.context.*
* The name of the authenticated user, if available.
- * ``%(user)s``
* The ID of the authenticated user, if available.
- * ``%(tenant_name)s``
* The name of the authenticated tenant, if available.
- * ``%(tenant)s``
* The ID of the authenticated tenant, if available.
- * ``%(project_name)s``
* The name of the authenticated project, if available.
- * ``%(project)s``
* The ID of the authenticated project, if available.
- * ``%(user_domain)s``
* The ID of the authenticated user domain, if available.
- * ``%(project_domain)s``
* The ID of the authenticated project/tenant, if available.
* The ID of the authenticated project, if available.
- * ``%(request_id)s``
* The ID of the current request. This value can be used to tie
multiple log messages together as relating to the same

2
doc/source/user/examples/usage_context.py
View File

@ -80,6 +80,6 @@ if __name__ == '__main__':
LOG.info("Welcome to Oslo Logging")
LOG.info("Without context")
context.RequestContext(user='6ce90b4d',
tenant='d6134462',
project='d6134462',
domain='a6b9360e')
LOG.info("With context")

2
doc/source/user/guidelines.rst
View File

@ -281,7 +281,7 @@ REST API deprecation warnings
- Should **not** be logged any higher than ``DEBUG``, since these are
not operator-facing messages.
- Should be logged no more than once per REST API usage / tenant,
- Should be logged no more than once per REST API usage / project,
definitely not on *every* REST API call.
**Rationale:** The users of the REST API don't have access to the