1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298
|
# Copyright 2013 OpenStack Foundation.
#
# 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.
#
"""Usage action implementations"""
import datetime
import functools
from cliff import columns as cliff_columns
from osc_lib.command import command
from osc_lib import utils
from openstackclient.i18n import _
# TODO(stephenfin): This exists in a couple of places and should be moved to a
# common module
class ProjectColumn(cliff_columns.FormattableColumn):
"""Formattable column for project column.
Unlike the parent FormattableColumn class, the initializer of the class
takes project_cache as the second argument.
``osc_lib.utils.get_item_properties`` instantiates ``FormattableColumn``
objects with a single parameter, the column value, so you need to pass a
partially initialized class like ``functools.partial(ProjectColumn,
project_cache)`` to use this.
"""
def __init__(self, value, project_cache=None):
super().__init__(value)
self.project_cache = project_cache or {}
def human_readable(self):
project = self._value
if not project:
return ''
if project in self.project_cache.keys():
return self.project_cache[project].name
return project
class CountColumn(cliff_columns.FormattableColumn):
def human_readable(self):
return len(self._value) if self._value is not None else None
class FloatColumn(cliff_columns.FormattableColumn):
def human_readable(self):
return float(f"{self._value:.2f}")
def _formatters(project_cache):
return {
'project_id': functools.partial(
ProjectColumn, project_cache=project_cache
),
'server_usages': CountColumn,
'total_memory_mb_usage': FloatColumn,
'total_vcpus_usage': FloatColumn,
'total_local_gb_usage': FloatColumn,
}
def _get_usage_marker(usage):
marker = None
if hasattr(usage, 'server_usages') and usage.server_usages:
marker = usage.server_usages[-1]['instance_id']
return marker
def _get_usage_list_marker(usage_list):
marker = None
if usage_list:
marker = _get_usage_marker(usage_list[-1])
return marker
def _merge_usage(usage, next_usage):
usage.server_usages.extend(next_usage.server_usages)
usage.total_hours += next_usage.total_hours
usage.total_memory_mb_usage += next_usage.total_memory_mb_usage
usage.total_vcpus_usage += next_usage.total_vcpus_usage
usage.total_local_gb_usage += next_usage.total_local_gb_usage
def _merge_usage_list(usages, next_usage_list):
for next_usage in next_usage_list:
if next_usage.project_id in usages:
_merge_usage(usages[next_usage.project_id], next_usage)
else:
usages[next_usage.project_id] = next_usage
class ListUsage(command.Lister):
_description = _("List resource usage per project")
def get_parser(self, prog_name):
parser = super().get_parser(prog_name)
parser.add_argument(
"--start",
metavar="<start>",
default=None,
help=_(
"Usage range start date, ex 2012-01-20"
" (default: 4 weeks ago)"
),
)
parser.add_argument(
"--end",
metavar="<end>",
default=None,
help=_("Usage range end date, ex 2012-01-20 (default: tomorrow)"),
)
return parser
def take_action(self, parsed_args):
def _format_project(project):
if not project:
return ""
if project in project_cache.keys():
return project_cache[project].name
else:
return project
compute_client = self.app.client_manager.sdk_connection.compute
columns = (
"project_id",
"server_usages",
"total_memory_mb_usage",
"total_vcpus_usage",
"total_local_gb_usage",
)
column_headers = (
"Project",
"Servers",
"RAM MB-Hours",
"CPU Hours",
"Disk GB-Hours",
)
date_cli_format = "%Y-%m-%d"
now = datetime.datetime.now(datetime.timezone.utc).replace(tzinfo=None)
if parsed_args.start:
start = datetime.datetime.strptime(
parsed_args.start, date_cli_format
)
else:
start = now - datetime.timedelta(weeks=4)
if parsed_args.end:
end = datetime.datetime.strptime(parsed_args.end, date_cli_format)
else:
end = now + datetime.timedelta(days=1)
usage_list = list(
compute_client.usages(
start=start,
end=end,
detailed=True,
)
)
# Cache the project list
project_cache = {}
try:
for p in self.app.client_manager.identity.projects.list():
project_cache[p.id] = p
except Exception: # noqa: S110
# Just forget it if there's any trouble
pass
if parsed_args.formatter == 'table' and len(usage_list) > 0:
self.app.stdout.write(
_("Usage from %(start)s to %(end)s: \n")
% {
"start": start.strftime(date_cli_format),
"end": end.strftime(date_cli_format),
}
)
return (
column_headers,
(
utils.get_item_properties(
s,
columns,
formatters=_formatters(project_cache),
)
for s in usage_list
),
)
class ShowUsage(command.ShowOne):
_description = _("Show resource usage for a single project")
def get_parser(self, prog_name):
parser = super().get_parser(prog_name)
parser.add_argument(
"--project",
metavar="<project>",
default=None,
help=_("Name or ID of project to show usage for"),
)
parser.add_argument(
"--start",
metavar="<start>",
default=None,
help=_(
"Usage range start date, ex 2012-01-20"
" (default: 4 weeks ago)"
),
)
parser.add_argument(
"--end",
metavar="<end>",
default=None,
help=_("Usage range end date, ex 2012-01-20 (default: tomorrow)"),
)
return parser
def take_action(self, parsed_args):
identity_client = self.app.client_manager.identity
compute_client = self.app.client_manager.sdk_connection.compute
date_cli_format = "%Y-%m-%d"
now = datetime.datetime.now(datetime.timezone.utc).replace(tzinfo=None)
if parsed_args.start:
start = datetime.datetime.strptime(
parsed_args.start, date_cli_format
)
else:
start = now - datetime.timedelta(weeks=4)
if parsed_args.end:
end = datetime.datetime.strptime(parsed_args.end, date_cli_format)
else:
end = now + datetime.timedelta(days=1)
if parsed_args.project:
project = utils.find_resource(
identity_client.projects,
parsed_args.project,
).id
else:
# Get the project from the current auth
project = self.app.client_manager.auth_ref.project_id
usage = compute_client.get_usage(
project=project,
start=start,
end=end,
)
if parsed_args.formatter == 'table':
self.app.stdout.write(
_("Usage from %(start)s to %(end)s on project %(project)s: \n")
% {
"start": start.strftime(date_cli_format),
"end": end.strftime(date_cli_format),
"project": project,
}
)
columns = (
"project_id",
"server_usages",
"total_memory_mb_usage",
"total_vcpus_usage",
"total_local_gb_usage",
)
column_headers = (
"Project",
"Servers",
"RAM MB-Hours",
"CPU Hours",
"Disk GB-Hours",
)
data = utils.get_item_properties(
usage, columns, formatters=_formatters(None)
)
return column_headers, data
|