From 36356598717d1f63e225980667fe2464e5e0c4d5 Mon Sep 17 00:00:00 2001 From: Jake Yip Date: Thu, 6 Mar 2025 11:27:42 +1100 Subject: [PATCH] Use updated 'project' keyword for config docs 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 --- doc/source/configuration/index.rst | 10 +++++----- doc/source/user/examples/usage_context.py | 2 +- doc/source/user/guidelines.rst | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/source/configuration/index.rst b/doc/source/configuration/index.rst index 22f81434..5b876a9e 100644 --- a/doc/source/configuration/index.rst +++ b/doc/source/configuration/index.rst @@ -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 diff --git a/doc/source/user/examples/usage_context.py b/doc/source/user/examples/usage_context.py index dd5aeadc..dc14c4af 100644 --- a/doc/source/user/examples/usage_context.py +++ b/doc/source/user/examples/usage_context.py @@ -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") diff --git a/doc/source/user/guidelines.rst b/doc/source/user/guidelines.rst index c35c0454..4ed1fd4c 100644 --- a/doc/source/user/guidelines.rst +++ b/doc/source/user/guidelines.rst @@ -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