python-openstackclient/openstackclient/volume/v3/block_storage_log_level.py
whoami-rajat a9e3049e9c Add block storage log level {list, set} commands
This patch adds the ``block storage log level list`` and
``block storage log level set`` commands that allow
operators to list the current log levels of cinder services
and also enables them to set a particular log level.

Change-Id: I16cd8084fb505a9e68a35a936ef3b8b1f3cdc712
2023-02-16 04:33:40 +00:00

148 lines
4.6 KiB
Python

#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
#
"""Block Storage Service action implementations"""
from cinderclient import api_versions
from osc_lib.command import command
from osc_lib import exceptions
from osc_lib import utils
from openstackclient.i18n import _
class BlockStorageLogLevelList(command.Lister):
"""List log levels of block storage service.
Supported by --os-volume-api-version 3.32 or greater.
"""
def get_parser(self, prog_name):
parser = super().get_parser(prog_name)
parser.add_argument(
"--host",
metavar="<host>",
default="",
help=_("List block storage service log level of specified host "
"(name only)")
)
parser.add_argument(
"--service",
metavar="<service>",
default="",
choices=(
'',
'*',
'cinder-api',
'cinder-volume',
'cinder-scheduler',
'cinder-backup'),
help=_("List block storage service log level of the specified "
"service (name only)")
)
parser.add_argument(
"--log-prefix",
metavar="<log-prefix>",
default="",
help="Prefix for the log, e.g. 'sqlalchemy'"
)
return parser
def take_action(self, parsed_args):
service_client = self.app.client_manager.volume
columns = [
"Binary",
"Host",
"Prefix",
"Level",
]
if service_client.api_version < api_versions.APIVersion('3.32'):
msg = _(
"--os-volume-api-version 3.32 or greater is required to "
"support the 'block storage log level list' command"
)
raise exceptions.CommandError(msg)
data = service_client.services.get_log_levels(
binary=parsed_args.service,
server=parsed_args.host,
prefix=parsed_args.log_prefix)
return (columns,
(utils.get_item_properties(
s, columns,
) for s in data))
class BlockStorageLogLevelSet(command.Command):
"""Set log level of block storage service
Supported by --os-volume-api-version 3.32 or greater.
"""
def get_parser(self, prog_name):
parser = super().get_parser(prog_name)
parser.add_argument(
"level",
metavar="<log-level>",
choices=('INFO', 'WARNING', 'ERROR', 'DEBUG'),
type=str.upper,
help=_("Desired log level.")
)
parser.add_argument(
"--host",
metavar="<host>",
default="",
help=_("Set block storage service log level of specified host "
"(name only)")
)
parser.add_argument(
"--service",
metavar="<service>",
default="",
choices=(
'',
'*',
'cinder-api',
'cinder-volume',
'cinder-scheduler',
'cinder-backup'),
help=_("Set block storage service log level of specified service "
"(name only)")
)
parser.add_argument(
"--log-prefix",
metavar="<log-prefix>",
default="",
help="Prefix for the log, e.g. 'sqlalchemy'"
)
return parser
def take_action(self, parsed_args):
service_client = self.app.client_manager.volume
if service_client.api_version < api_versions.APIVersion('3.32'):
msg = _(
"--os-volume-api-version 3.32 or greater is required to "
"support the 'block storage log level set' command"
)
raise exceptions.CommandError(msg)
service_client.services.set_log_levels(
level=parsed_args.level,
binary=parsed_args.service,
server=parsed_args.host,
prefix=parsed_args.log_prefix)