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 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442
|
# (C) Copyright 2014-2017 Hewlett Packard Enterprise Development LP
# Copyright 2017 FUJITSU LIMITED
#
# 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.
import datetime
import numbers
import time
from keystoneauth1 import exceptions as k_exc
from osc_lib import exceptions as osc_exc
from monascaclient.common import utils
from oslo_serialization import jsonutils
# Alarm valid types
severity_types = ['LOW', 'MEDIUM', 'HIGH', 'CRITICAL']
state_types = ['UNDETERMINED', 'ALARM', 'OK']
enabled_types = ['True', 'true', 'False', 'false']
group_by_types = ['alarm_definition_id', 'name', 'state', 'severity',
'link', 'lifecycle_state', 'metric_name',
'dimension_name', 'dimension_value']
allowed_notification_sort_by = {'id', 'name', 'type', 'address', 'created_at', 'updated_at'}
allowed_alarm_sort_by = {'alarm_id', 'alarm_definition_id',
'alarm_definition_name', 'state', 'severity',
'lifecycle_state', 'link',
'state_updated_timestamp', 'updated_timestamp',
'created_timestamp'}
allowed_definition_sort_by = {'id', 'name', 'severity', 'updated_at', 'created_at'}
@utils.arg('name', metavar='<METRIC_NAME>',
help='Name of the metric to create.')
@utils.arg('--dimensions', metavar='<KEY1=VALUE1,KEY2=VALUE2...>',
help='key value pair used to create a metric dimension. '
'This can be specified multiple times, or once with parameters '
'separated by a comma. '
'Dimensions need quoting when they contain special chars [&,(,),{,},>,<] '
'that confuse the CLI parser.',
action='append')
@utils.arg('--value-meta', metavar='<KEY1=VALUE1,KEY2=VALUE2...>',
help='key value pair for extra information about a value. '
'This can be specified multiple times, or once with parameters '
'separated by a comma. '
'value_meta need quoting when they contain special chars [&,(,),{,},>,<] '
'that confuse the CLI parser.',
action='append')
@utils.arg('--time', metavar='<UNIX_TIMESTAMP>',
default=time.time() * 1000, type=int,
help='Metric timestamp in milliseconds. Default: current timestamp.')
@utils.arg('--project-id', metavar='<CROSS_PROJECT_ID>',
help='The Project ID to create metric on behalf of. '
'Requires monitoring-delegate role in keystone.')
@utils.arg('value', metavar='<METRIC_VALUE>',
type=float,
help='Metric value.')
def do_metric_create(mc, args):
'''Create metric.'''
fields = {}
fields['name'] = args.name
if args.dimensions:
fields['dimensions'] = utils.format_parameters(args.dimensions)
fields['timestamp'] = args.time
fields['value'] = args.value
if args.value_meta:
fields['value_meta'] = utils.format_parameters(args.value_meta)
if args.project_id:
fields['tenant_id'] = args.project_id
try:
mc.metrics.create(**fields)
except (osc_exc.ClientException, k_exc.HttpError) as he:
raise osc_exc.CommandError('%s\n%s' % (he.message, he.details))
else:
print('Successfully created metric')
@utils.arg('jsonbody', metavar='<JSON_BODY>',
type=jsonutils.loads,
help='The raw JSON body in single quotes. See api doc.')
def do_metric_create_raw(mc, args):
'''Create metric from raw json body.'''
try:
mc.metrics.create(**args.jsonbody)
except (osc_exc.ClientException, k_exc.HttpError) as he:
raise osc_exc.CommandError('%s\n%s' % (he.message, he.details))
else:
print('Successfully created metric')
@utils.arg('--dimensions', metavar='<KEY1=VALUE1,KEY2=VALUE2...>',
help='key value pair used to specify a metric dimension. '
'This can be specified multiple times, or once with parameters '
'separated by a comma. '
'Dimensions need quoting when they contain special chars [&,(,),{,},>,<] '
'that confuse the CLI parser.',
action='append')
@utils.arg('--offset', metavar='<OFFSET LOCATION>',
help='The offset used to paginate the return data.')
@utils.arg('--limit', metavar='<RETURN LIMIT>',
help='The amount of data to be returned up to the API maximum limit.')
@utils.arg('--tenant-id', metavar='<TENANT_ID>',
help="Retrieve data for the specified tenant/project id instead of "
"the tenant/project from the user's Keystone credentials.")
def do_metric_name_list(mc, args):
'''List names of metrics.'''
fields = {}
if args.dimensions:
fields['dimensions'] = utils.format_dimensions_query(args.dimensions)
if args.limit:
fields['limit'] = args.limit
if args.offset:
fields['offset'] = args.offset
if args.tenant_id:
fields['tenant_id'] = args.tenant_id
try:
metric_names = mc.metrics.list_names(**fields)
except (osc_exc.ClientException, k_exc.HttpError) as he:
raise osc_exc.CommandError('%s\n%s' % (he.message, he.details))
else:
if args.json:
print(utils.json_formatter(metric_names))
return
if isinstance(metric_names, list):
utils.print_list(metric_names, ['Name'], formatters={'Name': lambda x: x['name']})
@utils.arg('--name', metavar='<METRIC_NAME>',
help='Name of the metric to list.')
@utils.arg('--dimensions', metavar='<KEY1=VALUE1,KEY2=VALUE2...>',
help='key value pair used to specify a metric dimension. '
'This can be specified multiple times, or once with parameters '
'separated by a comma. '
'Dimensions need quoting when they contain special chars [&,(,),{,},>,<] '
'that confuse the CLI parser.',
action='append')
@utils.arg('--starttime', metavar='<UTC_START_TIME>',
help='measurements >= UTC time. format: 2014-01-01T00:00:00Z. OR'
' Format: -120 (previous 120 minutes).')
@utils.arg('--endtime', metavar='<UTC_END_TIME>',
help='measurements <= UTC time. format: 2014-01-01T00:00:00Z.')
@utils.arg('--offset', metavar='<OFFSET LOCATION>',
help='The offset used to paginate the return data.')
@utils.arg('--limit', metavar='<RETURN LIMIT>',
help='The amount of data to be returned up to the API maximum limit.')
@utils.arg('--tenant-id', metavar='<TENANT_ID>',
help="Retrieve data for the specified tenant/project id instead of "
"the tenant/project from the user's Keystone credentials.")
def do_metric_list(mc, args):
'''List metrics for this tenant.'''
fields = {}
if args.name:
fields['name'] = args.name
if args.dimensions:
fields['dimensions'] = utils.format_dimensions_query(args.dimensions)
if args.limit:
fields['limit'] = args.limit
if args.offset:
fields['offset'] = args.offset
if args.starttime:
_translate_starttime(args)
fields['start_time'] = args.starttime
if args.endtime:
fields['end_time'] = args.endtime
if args.tenant_id:
fields['tenant_id'] = args.tenant_id
try:
metric = mc.metrics.list(**fields)
except (osc_exc.ClientException, k_exc.HttpError) as he:
raise osc_exc.CommandError('%s\n%s' % (he.message, he.details))
else:
if args.json:
print(utils.json_formatter(metric))
return
cols = ['name', 'dimensions']
formatters = {
'name': lambda x: x['name'],
'dimensions': lambda x: utils.format_dict(x['dimensions']),
}
if isinstance(metric, list):
# print the list
utils.print_list(metric, cols, formatters=formatters)
else:
# add the dictionary to a list, so print_list works
metric_list = list()
metric_list.append(metric)
utils.print_list(
metric_list,
cols,
formatters=formatters)
@utils.arg('--metric-name', metavar='<METRIC_NAME>',
help='Name of the metric to report dimension name list.',
action='append')
@utils.arg('--offset', metavar='<OFFSET LOCATION>',
help='The offset used to paginate the return data.')
@utils.arg('--limit', metavar='<RETURN LIMIT>',
help='The amount of data to be returned up to the API maximum '
'limit.')
@utils.arg('--tenant-id', metavar='<TENANT_ID>',
help="Retrieve data for the specified tenant/project id instead of "
"the tenant/project from the user's Keystone credentials.")
def do_dimension_name_list(mc, args):
'''List names of metric dimensions.'''
fields = {}
if args.metric_name:
fields['metric_name'] = args.metric_name
if args.limit:
fields['limit'] = args.limit
if args.offset:
fields['offset'] = args.offset
if args.tenant_id:
fields['tenant_id'] = args.tenant_id
try:
dimension_names = mc.metrics.list_dimension_names(**fields)
except (osc_exc.ClientException, k_exc.HttpError) as he:
raise osc_exc.CommandError('%s\n%s' % (he.message, he.details))
if args.json:
print(utils.json_formatter(dimension_names))
return
if isinstance(dimension_names, list):
utils.print_list(dimension_names, ['Dimension Names'], formatters={
'Dimension Names': lambda x: x['dimension_name']})
@utils.arg('dimension_name', metavar='<DIMENSION_NAME>',
help='Name of the dimension to list dimension values.')
@utils.arg('--metric-name', metavar='<METRIC_NAME>',
help='Name of the metric to report dimension value list.',
action='append')
@utils.arg('--offset', metavar='<OFFSET LOCATION>',
help='The offset used to paginate the return data.')
@utils.arg('--limit', metavar='<RETURN LIMIT>',
help='The amount of data to be returned up to the API maximum '
'limit.')
@utils.arg('--tenant-id', metavar='<TENANT_ID>',
help="Retrieve data for the specified tenant/project id instead of "
"the tenant/project from the user's Keystone credentials.")
def do_dimension_value_list(mc, args):
'''List names of metric dimensions.'''
fields = {}
fields['dimension_name'] = args.dimension_name
if args.metric_name:
fields['metric_name'] = args.metric_name
if args.limit:
fields['limit'] = args.limit
if args.offset:
fields['offset'] = args.offset
if args.tenant_id:
fields['tenant_id'] = args.tenant_id
try:
dimension_values = mc.metrics.list_dimension_values(**fields)
except (osc_exc.ClientException, k_exc.HttpError) as he:
raise osc_exc.CommandError('%s\n%s' % (he.message, he.details))
if args.json:
print(utils.json_formatter(dimension_values))
return
if isinstance(dimension_values, list):
utils.print_list(dimension_values, ['Dimension Values'], formatters={
'Dimension Values': lambda x: x['dimension_value']})
def format_measure_timestamp(measurements):
# returns newline separated times for the timestamp column
return '\n'.join([str(m[0]) for m in measurements])
def format_measure_value(measurements):
# returns newline separated values for the value column
return '\n'.join(['{:12.3f}'.format(m[1]) for m in measurements])
def format_value_meta(measurements):
# returns newline separated values for the value column
measure_string_list = list()
for measure in measurements:
if len(measure) < 3:
measure_string = ""
else:
meta_string_list = []
for k, v in measure[2].items():
if isinstance(v, numbers.Number):
m_str = k + ': ' + str(v)
else:
m_str = k + ': ' + v
meta_string_list.append(m_str)
measure_string = ','.join(meta_string_list)
measure_string_list.append(measure_string)
return '\n'.join(measure_string_list)
def format_statistic_timestamp(statistics, columns, name):
# returns newline separated times for the timestamp column
time_index = 0
if statistics:
time_index = columns.index(name)
time_list = list()
for timestamp in statistics:
time_list.append(str(timestamp[time_index]))
return '\n'.join(time_list)
def format_statistic_value(statistics, columns, stat_type):
# find the index for column name
stat_index = 0
if statistics:
stat_index = columns.index(stat_type)
value_list = list()
for stat in statistics:
value_str = '{:12.3f}'.format(stat[stat_index])
value_list.append(value_str)
return '\n'.join(value_list)
def format_metric_name(metrics):
# returns newline separated metric names for the column
metric_string_list = list()
for metric in metrics:
metric_name = metric['name']
metric_dimensions = metric['dimensions']
metric_string_list.append(metric_name)
# need to line up with dimensions column
rng = len(metric_dimensions)
for i in range(rng):
if i == rng - 1:
# last one
break
metric_string_list.append(" ")
return '\n'.join(metric_string_list)
def format_metric_dimensions(metrics):
# returns newline separated dimension key values for the column
metric_string_list = list()
for metric in metrics:
metric_dimensions = metric['dimensions']
for k, v in metric_dimensions.items():
if isinstance(v, numbers.Number):
d_str = k + ': ' + str(v)
else:
d_str = k + ': ' + v
metric_string_list.append(d_str)
return '\n'.join(metric_string_list)
@utils.arg('name', metavar='<METRIC_NAME>',
help='Name of the metric to list measurements.')
@utils.arg('--dimensions', metavar='<KEY1=VALUE1,KEY2=VALUE2...>',
help='key value pair used to specify a metric dimension. '
'This can be specified multiple times, or once with parameters '
'separated by a comma. '
'Dimensions need quoting when they contain special chars [&,(,),{,},>,<] '
'that confuse the CLI parser.',
action='append')
@utils.arg('starttime', metavar='<UTC_START_TIME>',
help='measurements >= UTC time. format: 2014-01-01T00:00:00Z.'
' OR Format: -120 (previous 120 minutes).')
@utils.arg('--endtime', metavar='<UTC_END_TIME>',
help='measurements <= UTC time. format: 2014-01-01T00:00:00Z.')
@utils.arg('--offset', metavar='<OFFSET LOCATION>',
help='The offset used to paginate the return data.')
@utils.arg('--limit', metavar='<RETURN LIMIT>',
help='The amount of data to be returned up to the API maximum limit.')
@utils.arg('--merge_metrics', action='store_const',
const=True,
help='Merge multiple metrics into a single result.')
@utils.arg('--group_by', metavar='<KEY1,KEY2,...>',
help='Select which keys to use for grouping. A \'*\' groups by all keys.')
@utils.arg('--tenant-id', metavar='<TENANT_ID>',
help="Retrieve data for the specified tenant/project id instead of "
"the tenant/project from the user's Keystone credentials.")
def do_measurement_list(mc, args):
'''List measurements for the specified metric.'''
fields = {}
fields['name'] = args.name
if args.dimensions:
fields['dimensions'] = utils.format_dimensions_query(args.dimensions)
_translate_starttime(args)
fields['start_time'] = args.starttime
if args.endtime:
fields['end_time'] = args.endtime
if args.limit:
fields['limit'] = args.limit
if args.offset:
fields['offset'] = args.offset
if args.merge_metrics:
fields['merge_metrics'] = args.merge_metrics
if args.group_by:
fields['group_by'] = args.group_by
if args.tenant_id:
fields['tenant_id'] = args.tenant_id
try:
metric = mc.metrics.list_measurements(**fields)
except (osc_exc.ClientException, k_exc.HttpError) as he:
raise osc_exc.CommandError('%s\n%s' % (he.message, he.details))
else:
if args.json:
print(utils.json_formatter(metric))
return
cols = ['name', 'dimensions', 'timestamp', 'value', 'value_meta']
formatters = {
'name': lambda x: x['name'],
'dimensions': lambda x: utils.format_dict(x['dimensions']),
'timestamp': lambda x: format_measure_timestamp(x['measurements']),
'value': lambda x: format_measure_value(x['measurements']),
'value_meta': lambda x: format_value_meta(x['measurements']),
}
if isinstance(metric, list):
# print the list
utils.print_list(metric, cols, formatters=formatters)
else:
# add the dictionary to a list, so print_list works
metric_list = list()
metric_list.append(metric)
utils.print_list(
metric_list,
cols,
formatters=formatters)
@utils.arg('name', metavar='<METRIC_NAME>',
help='Name of the metric to report measurement statistics.')
@utils.arg('statistics', metavar='<STATISTICS>',
help='Statistics is one or more (separated by commas) of '
'[AVG, MIN, MAX, COUNT, SUM].')
@utils.arg('--dimensions', metavar='<KEY1=VALUE1,KEY2=VALUE2...>',
help='key value pair used to specify a metric dimension. '
'This can be specified multiple times, or once with parameters '
'separated by a comma. '
'Dimensions need quoting when they contain special chars [&,(,),{,},>,<] '
'that confuse the CLI parser.',
action='append')
@utils.arg('starttime', metavar='<UTC_START_TIME>',
help='measurements >= UTC time. format: 2014-01-01T00:00:00Z. OR'
' Format: -120 (previous 120 minutes).')
@utils.arg('--endtime', metavar='<UTC_END_TIME>',
help='measurements <= UTC time. format: 2014-01-01T00:00:00Z.')
@utils.arg('--period', metavar='<PERIOD>',
help='number of seconds per interval (default is 300)')
@utils.arg('--offset', metavar='<OFFSET LOCATION>',
help='The offset used to paginate the return data.')
@utils.arg('--limit', metavar='<RETURN LIMIT>',
help='The amount of data to be returned up to the API maximum limit.')
@utils.arg('--merge_metrics', action='store_const',
const=True,
help='Merge multiple metrics into a single result.')
@utils.arg('--group_by', metavar='<KEY1,KEY2,...>',
help='Select which keys to use for grouping. A \'*\' groups by all keys.')
@utils.arg('--tenant-id', metavar='<TENANT_ID>',
help="Retrieve data for the specified tenant/project id instead of "
"the tenant/project from the user's Keystone credentials.")
def do_metric_statistics(mc, args):
'''List measurement statistics for the specified metric.'''
statistic_types = ['AVG', 'MIN', 'MAX', 'COUNT', 'SUM']
statlist = args.statistics.split(',')
for stat in statlist:
if stat.upper() not in statistic_types:
errmsg = ('Invalid type, not one of [' +
', '.join(statistic_types) + ']')
raise osc_exc.CommandError(errmsg)
fields = {}
fields['name'] = args.name
if args.dimensions:
fields['dimensions'] = utils.format_dimensions_query(args.dimensions)
_translate_starttime(args)
fields['start_time'] = args.starttime
if args.endtime:
fields['end_time'] = args.endtime
if args.period:
fields['period'] = args.period
fields['statistics'] = args.statistics
if args.limit:
fields['limit'] = args.limit
if args.offset:
fields['offset'] = args.offset
if args.merge_metrics:
fields['merge_metrics'] = args.merge_metrics
if args.group_by:
fields['group_by'] = args.group_by
if args.tenant_id:
fields['tenant_id'] = args.tenant_id
try:
metric = mc.metrics.list_statistics(**fields)
except (osc_exc.ClientException, k_exc.HttpError) as he:
raise osc_exc.CommandError('%s\n%s' % (he.message, he.details))
else:
if args.json:
print(utils.json_formatter(metric))
return
cols = ['name', 'dimensions']
# add dynamic column names
if metric:
column_names = metric[0]['columns']
for name in column_names:
cols.append(name)
else:
# when empty set, print_list needs a col
cols.append('timestamp')
formatters = {
'name': lambda x: x['name'],
'dimensions': lambda x: utils.format_dict(x['dimensions']),
'timestamp': lambda x:
format_statistic_timestamp(x['statistics'], x['columns'],
'timestamp'),
'avg': lambda x:
format_statistic_value(x['statistics'], x['columns'], 'avg'),
'min': lambda x:
format_statistic_value(x['statistics'], x['columns'], 'min'),
'max': lambda x:
format_statistic_value(x['statistics'], x['columns'], 'max'),
'count': lambda x:
format_statistic_value(x['statistics'], x['columns'], 'count'),
'sum': lambda x:
format_statistic_value(x['statistics'], x['columns'], 'sum'),
}
if isinstance(metric, list):
# print the list
utils.print_list(metric, cols, formatters=formatters)
else:
# add the dictionary to a list, so print_list works
metric_list = list()
metric_list.append(metric)
utils.print_list(
metric_list,
cols,
formatters=formatters)
@utils.arg('name', metavar='<NOTIFICATION_NAME>',
help='Name of the notification to create.')
@utils.arg('type', metavar='<TYPE>',
help='The notification type. See monasca notification-type-list for supported types.')
@utils.arg('address', metavar='<ADDRESS>',
help='A valid EMAIL Address, URL, or SERVICE KEY.')
@utils.arg('--period', metavar='<PERIOD>', type=int, default=0,
help='A period for the notification method.')
def do_notification_create(mc, args):
'''Create notification.'''
fields = {}
fields['name'] = args.name
fields['type'] = args.type
fields['address'] = args.address
if args.period:
fields['period'] = args.period
try:
notification = mc.notifications.create(**fields)
except (osc_exc.ClientException, k_exc.HttpError) as he:
raise osc_exc.CommandError('%s\n%s' % (he.message, he.details))
else:
print(jsonutils.dumps(notification, indent=2))
@utils.arg('id', metavar='<NOTIFICATION_ID>',
help='The ID of the notification.')
def do_notification_show(mc, args):
'''Describe the notification.'''
fields = {}
fields['notification_id'] = args.id
try:
notification = mc.notifications.get(**fields)
except (osc_exc.ClientException, k_exc.HttpError) as he:
raise osc_exc.CommandError('%s\n%s' % (he.message, he.details))
else:
if args.json:
print(utils.json_formatter(notification))
return
formatters = {
'name': utils.json_formatter,
'id': utils.json_formatter,
'type': utils.json_formatter,
'address': utils.json_formatter,
'period': utils.json_formatter,
'links': utils.format_dictlist,
}
utils.print_dict(notification, formatters=formatters)
@utils.arg('--sort-by', metavar='<SORT BY FIELDS>',
help='Fields to sort by as a comma separated list. Valid values are id, '
'name, type, address, created_at, updated_at. '
'Fields may be followed by "asc" or "desc", ex "address desc", '
'to set the direction of sorting.')
@utils.arg('--offset', metavar='<OFFSET LOCATION>',
help='The offset used to paginate the return data.')
@utils.arg('--limit', metavar='<RETURN LIMIT>',
help='The amount of data to be returned up to the API maximum limit.')
def do_notification_list(mc, args):
'''List notifications for this tenant.'''
fields = {}
if args.limit:
fields['limit'] = args.limit
if args.offset:
fields['offset'] = args.offset
if args.sort_by:
sort_by = args.sort_by.split(',')
for field in sort_by:
field_values = field.lower().split()
if len(field_values) > 2:
print("Invalid sort_by value {}".format(field))
if field_values[0] not in allowed_notification_sort_by:
print("Sort-by field name {} is not in [{}]".format(field_values[0],
allowed_notification_sort_by))
return
if len(field_values) > 1 and field_values[1] not in ['asc', 'desc']:
print("Invalid value {}, must be asc or desc".format(field_values[1]))
fields['sort_by'] = args.sort_by
try:
notification = mc.notifications.list(**fields)
except osc_exc.ClientException as he:
raise osc_exc.CommandError(
'ClientException code=%s message=%s' %
(he.code, he.message))
else:
if args.json:
print(utils.json_formatter(notification))
return
cols = ['name', 'id', 'type', 'address', 'period']
formatters = {
'name': lambda x: x['name'],
'id': lambda x: x['id'],
'type': lambda x: x['type'],
'address': lambda x: x['address'],
'period': lambda x: x['period'],
}
if isinstance(notification, list):
utils.print_list(
notification,
cols,
formatters=formatters)
else:
notif_list = list()
notif_list.append(notification)
utils.print_list(notif_list, cols, formatters=formatters)
@utils.arg('id', metavar='<NOTIFICATION_ID>',
help='The ID of the notification.')
def do_notification_delete(mc, args):
'''Delete notification.'''
fields = {}
fields['notification_id'] = args.id
try:
mc.notifications.delete(**fields)
except (osc_exc.ClientException, k_exc.HttpError) as he:
raise osc_exc.CommandError('%s\n%s' % (he.message, he.details))
else:
print('Successfully deleted notification')
@utils.arg('id', metavar='<NOTIFICATION_ID>',
help='The ID of the notification.')
@utils.arg('name', metavar='<NOTIFICATION_NAME>',
help='Name of the notification.')
@utils.arg('type', metavar='<TYPE>',
help='The notification type. See monasca notification-type-list for supported types.')
@utils.arg('address', metavar='<ADDRESS>',
help='A valid EMAIL Address, URL, or SERVICE KEY.')
@utils.arg('period', metavar='<PERIOD>', type=int,
help='A period for the notification method.')
def do_notification_update(mc, args):
'''Update notification.'''
fields = {}
fields['notification_id'] = args.id
fields['name'] = args.name
fields['type'] = args.type
fields['address'] = args.address
fields['period'] = args.period
try:
notification = mc.notifications.update(**fields)
except (osc_exc.ClientException, k_exc.HttpError) as he:
raise osc_exc.CommandError('%s\n%s' % (he.message, he.details))
else:
print(jsonutils.dumps(notification, indent=2))
@utils.arg('id', metavar='<NOTIFICATION_ID>',
help='The ID of the notification.')
@utils.arg('--name', metavar='<NOTIFICATION_NAME>',
help='Name of the notification.')
@utils.arg('--type', metavar='<TYPE>',
help='The notification type. See monasca notification-type-list for supported types.')
@utils.arg('--address', metavar='<ADDRESS>',
help='A valid EMAIL Address, URL, or SERVICE KEY.')
@utils.arg('--period', metavar='<PERIOD>', type=int,
help='A period for the notification method.')
def do_notification_patch(mc, args):
'''Patch notification.'''
fields = {}
fields['notification_id'] = args.id
if args.name:
fields['name'] = args.name
if args.type:
fields['type'] = args.type
if args.address:
fields['address'] = args.address
if args.period or args.period == 0:
fields['period'] = args.period
try:
notification = mc.notifications.patch(**fields)
except (osc_exc.ClientException, k_exc.HttpError) as he:
raise osc_exc.CommandError('%s\n%s' % (he.message, he.details))
else:
print(jsonutils.dumps(notification, indent=2))
def _validate_severity(severity):
if severity.upper() not in severity_types:
errmsg = ('Invalid severity, not one of [' +
', '.join(severity_types) + ']')
print(errmsg)
return False
return True
@utils.arg('name', metavar='<ALARM_DEFINITION_NAME>',
help='Name of the alarm definition to create.')
@utils.arg('--description', metavar='<DESCRIPTION>',
help='Description of the alarm.')
@utils.arg('expression', metavar='<EXPRESSION>',
help='The alarm expression to evaluate. Quoted.')
@utils.arg('--severity', metavar='<SEVERITY>',
help='Severity is one of [LOW, MEDIUM, HIGH, CRITICAL].')
@utils.arg('--match-by', metavar='<MATCH_BY_DIMENSION_KEY1,MATCH_BY_DIMENSION_KEY2,'
'...>',
help='The metric dimensions to use to create unique alarms. '
'One or more dimension key names separated by a comma. '
'Key names need quoting when they contain special chars [&,(,),{,},>,<] '
'that confuse the CLI parser.')
@utils.arg('--alarm-actions', metavar='<NOTIFICATION-ID>',
help='The notification method to use when an alarm state is ALARM. '
'This param may be specified multiple times.',
action='append')
@utils.arg('--ok-actions', metavar='<NOTIFICATION-ID>',
help='The notification method to use when an alarm state is OK. '
'This param may be specified multiple times.',
action='append')
@utils.arg('--undetermined-actions', metavar='<NOTIFICATION-ID>',
help='The notification method to use when an alarm state is '
'UNDETERMINED. This param may be specified multiple times.',
action='append')
def do_alarm_definition_create(mc, args):
'''Create an alarm definition.'''
fields = {}
fields['name'] = args.name
if args.description:
fields['description'] = args.description
fields['expression'] = args.expression
if args.alarm_actions:
fields['alarm_actions'] = args.alarm_actions
if args.ok_actions:
fields['ok_actions'] = args.ok_actions
if args.undetermined_actions:
fields['undetermined_actions'] = args.undetermined_actions
if args.severity:
if not _validate_severity(args.severity):
return
fields['severity'] = args.severity
if args.match_by:
fields['match_by'] = args.match_by.split(',')
try:
alarm = mc.alarm_definitions.create(**fields)
except (osc_exc.ClientException, k_exc.HttpError) as he:
raise osc_exc.CommandError('%s\n%s' % (he.message, he.details))
else:
print(jsonutils.dumps(alarm, indent=2))
@utils.arg('id', metavar='<ALARM_DEFINITION_ID>',
help='The ID of the alarm definition.')
def do_alarm_definition_show(mc, args):
'''Describe the alarm definition.'''
fields = {}
fields['alarm_id'] = args.id
try:
alarm = mc.alarm_definitions.get(**fields)
except (osc_exc.ClientException, k_exc.HttpError) as he:
raise osc_exc.CommandError('%s\n%s' % (he.message, he.details))
else:
if args.json:
print(utils.json_formatter(alarm))
return
# print out detail of a single alarm
formatters = {
'name': utils.json_formatter,
'id': utils.json_formatter,
'expression': utils.json_formatter,
'expression_data': utils.format_expression_data,
'match_by': utils.json_formatter,
'actions_enabled': utils.json_formatter,
'alarm_actions': utils.json_formatter,
'ok_actions': utils.json_formatter,
'severity': utils.json_formatter,
'undetermined_actions': utils.json_formatter,
'description': utils.json_formatter,
'links': utils.format_dictlist,
}
utils.print_dict(alarm, formatters=formatters)
@utils.arg('--name', metavar='<ALARM_DEFINITION_NAME>',
help='Name of the alarm definition.')
@utils.arg('--dimensions', metavar='<KEY1=VALUE1,KEY2=VALUE2...>',
help='key value pair used to specify a metric dimension. '
'This can be specified multiple times, or once with parameters '
'separated by a comma. '
'Dimensions need quoting when they contain special chars [&,(,),{,},>,<] '
'that confuse the CLI parser.',
action='append')
@utils.arg('--severity', metavar='<SEVERITY>',
help='Severity is one of ["LOW", "MEDIUM", "HIGH", "CRITICAL"].')
@utils.arg('--sort-by', metavar='<SORT BY FIELDS>',
help='Fields to sort by as a comma separated list. Valid values are id, '
'name, severity, created_at, updated_at. '
'Fields may be followed by "asc" or "desc", ex "severity desc", '
'to set the direction of sorting.')
@utils.arg('--offset', metavar='<OFFSET LOCATION>',
help='The offset used to paginate the return data.')
@utils.arg('--limit', metavar='<RETURN LIMIT>',
help='The amount of data to be returned up to the API maximum limit.')
def do_alarm_definition_list(mc, args):
'''List alarm definitions for this tenant.'''
fields = {}
if args.name:
fields['name'] = args.name
if args.dimensions:
fields['dimensions'] = utils.format_dimensions_query(args.dimensions)
if args.severity:
if not _validate_severity(args.severity):
return
fields['severity'] = args.severity
if args.sort_by:
sort_by = args.sort_by.split(',')
for field in sort_by:
field_values = field.split()
if len(field_values) > 2:
print("Invalid sort_by value {}".format(field))
if field_values[0] not in allowed_definition_sort_by:
print("Sort-by field name {} is not in [{}]".format(field_values[0],
allowed_definition_sort_by))
return
if len(field_values) > 1 and field_values[1] not in ['asc', 'desc']:
print("Invalid value {}, must be asc or desc".format(field_values[1]))
fields['sort_by'] = args.sort_by
if args.limit:
fields['limit'] = args.limit
if args.offset:
fields['offset'] = args.offset
try:
alarm = mc.alarm_definitions.list(**fields)
except (osc_exc.ClientException, k_exc.HttpError) as he:
raise osc_exc.CommandError('%s\n%s' % (he.message, he.details))
else:
if args.json:
print(utils.json_formatter(alarm))
return
cols = ['name', 'id', 'expression', 'match_by', 'actions_enabled']
formatters = {
'name': lambda x: x['name'],
'id': lambda x: x['id'],
'expression': lambda x: x['expression'],
'match_by': lambda x: utils.format_list(x['match_by']),
'actions_enabled': lambda x: x['actions_enabled'],
}
if isinstance(alarm, list):
# print the list
utils.print_list(alarm, cols, formatters=formatters)
else:
# add the dictionary to a list, so print_list works
alarm_list = list()
alarm_list.append(alarm)
utils.print_list(alarm_list, cols, formatters=formatters)
@utils.arg('id', metavar='<ALARM_DEFINITION_ID>',
help='The ID of the alarm definition.')
def do_alarm_definition_delete(mc, args):
'''Delete the alarm definition.'''
fields = {}
fields['alarm_id'] = args.id
try:
mc.alarm_definitions.delete(**fields)
except (osc_exc.ClientException, k_exc.HttpError) as he:
raise osc_exc.CommandError('%s\n%s' % (he.message, he.details))
else:
print('Successfully deleted alarm definition')
@utils.arg('id', metavar='<ALARM_DEFINITION_ID>',
help='The ID of the alarm definition.')
@utils.arg('name', metavar='<ALARM_DEFINITION_NAME>',
help='Name of the alarm definition.')
@utils.arg('description', metavar='<DESCRIPTION>',
help='Description of the alarm.')
@utils.arg('expression', metavar='<EXPRESSION>',
help='The alarm expression to evaluate. Quoted.')
@utils.arg('alarm_actions', metavar='<ALARM-NOTIFICATION-ID1,ALARM-NOTIFICATION-ID2,...>',
help='The notification method(s) to use when an alarm state is ALARM '
'as a comma separated list.')
@utils.arg('ok_actions', metavar='<OK-NOTIFICATION-ID1,OK-NOTIFICATION-ID2,...>',
help='The notification method(s) to use when an alarm state is OK '
'as a comma separated list.')
@utils.arg('undetermined_actions',
metavar='<UNDETERMINED-NOTIFICATION-ID1,UNDETERMINED-NOTIFICATION-ID2,...>',
help='The notification method(s) to use when an alarm state is UNDETERMINED '
'as a comma separated list.')
@utils.arg('actions_enabled', metavar='<ACTIONS-ENABLED>',
help='The actions-enabled boolean is one of [true,false]')
@utils.arg('match_by', metavar='<MATCH_BY_DIMENSION_KEY1,MATCH_BY_DIMENSION_KEY2,...>',
help='The metric dimensions to use to create unique alarms. '
'One or more dimension key names separated by a comma. '
'Key names need quoting when they contain special chars [&,(,),{,},>,<] '
'that confuse the CLI parser.')
@utils.arg('severity', metavar='<SEVERITY>',
help='Severity is one of [LOW, MEDIUM, HIGH, CRITICAL].')
def do_alarm_definition_update(mc, args):
'''Update the alarm definition.'''
fields = {}
fields['alarm_id'] = args.id
fields['name'] = args.name
fields['description'] = args.description
fields['expression'] = args.expression
fields['alarm_actions'] = _arg_split_patch_update(args.alarm_actions)
fields['ok_actions'] = _arg_split_patch_update(args.ok_actions)
fields['undetermined_actions'] = _arg_split_patch_update(args.undetermined_actions)
if args.actions_enabled not in enabled_types:
errmsg = ('Invalid value, not one of [' +
', '.join(enabled_types) + ']')
print(errmsg)
return
fields['actions_enabled'] = args.actions_enabled in ['true', 'True']
fields['match_by'] = _arg_split_patch_update(args.match_by)
if not _validate_severity(args.severity):
return
fields['severity'] = args.severity
try:
alarm = mc.alarm_definitions.update(**fields)
except (osc_exc.ClientException, k_exc.HttpError) as he:
raise osc_exc.CommandError('%s\n%s' % (he.message, he.details))
else:
print(jsonutils.dumps(alarm, indent=2))
@utils.arg('id', metavar='<ALARM_DEFINITION_ID>',
help='The ID of the alarm definition.')
@utils.arg('--name', metavar='<ALARM_DEFINITION_NAME>',
help='Name of the alarm definition.')
@utils.arg('--description', metavar='<DESCRIPTION>',
help='Description of the alarm.')
@utils.arg('--expression', metavar='<EXPRESSION>',
help='The alarm expression to evaluate. Quoted.')
@utils.arg('--alarm-actions', metavar='<NOTIFICATION-ID>',
help='The notification method to use when an alarm state is ALARM. '
'This param may be specified multiple times.',
action='append')
@utils.arg('--ok-actions', metavar='<NOTIFICATION-ID>',
help='The notification method to use when an alarm state is OK. '
'This param may be specified multiple times.',
action='append')
@utils.arg('--undetermined-actions', metavar='<NOTIFICATION-ID>',
help='The notification method to use when an alarm state is '
'UNDETERMINED. This param may be specified multiple times.',
action='append')
@utils.arg('--actions-enabled', metavar='<ACTIONS-ENABLED>',
help='The actions-enabled boolean is one of [true,false].')
@utils.arg('--severity', metavar='<SEVERITY>',
help='Severity is one of [LOW, MEDIUM, HIGH, CRITICAL].')
def do_alarm_definition_patch(mc, args):
'''Patch the alarm definition.'''
fields = {}
fields['alarm_id'] = args.id
if args.name:
fields['name'] = args.name
if args.description:
fields['description'] = args.description
if args.expression:
fields['expression'] = args.expression
if args.alarm_actions:
fields['alarm_actions'] = _arg_split_patch_update(args.alarm_actions, patch=True)
if args.ok_actions:
fields['ok_actions'] = _arg_split_patch_update(args.ok_actions, patch=True)
if args.undetermined_actions:
fields['undetermined_actions'] = _arg_split_patch_update(args.undetermined_actions,
patch=True)
if args.actions_enabled:
if args.actions_enabled not in enabled_types:
errmsg = ('Invalid value, not one of [' +
', '.join(enabled_types) + ']')
print(errmsg)
return
fields['actions_enabled'] = args.actions_enabled in ['true', 'True']
if args.severity:
if not _validate_severity(args.severity):
return
fields['severity'] = args.severity
try:
alarm = mc.alarm_definitions.patch(**fields)
except (osc_exc.ClientException, k_exc.HttpError) as he:
raise osc_exc.CommandError('%s\n%s' % (he.message, he.details))
else:
print(jsonutils.dumps(alarm, indent=2))
@utils.arg('--alarm-definition-id', metavar='<ALARM_DEFINITION_ID>',
help='The ID of the alarm definition.')
@utils.arg('--metric-name', metavar='<METRIC_NAME>',
help='Name of the metric.')
@utils.arg('--metric-dimensions', metavar='<KEY1=VALUE1,KEY2,KEY3=VALUE2...>',
help='key value pair used to specify a metric dimension or '
'just key to select all values of that dimension.'
'This can be specified multiple times, or once with parameters '
'separated by a comma. '
'Dimensions need quoting when they contain special chars [&,(,),{,},>,<] '
'that confuse the CLI parser.',
action='append')
@utils.arg('--state', metavar='<ALARM_STATE>',
help='ALARM_STATE is one of [UNDETERMINED, OK, ALARM].')
@utils.arg('--severity', metavar='<SEVERITY>',
help='Severity is one of ["LOW", "MEDIUM", "HIGH", "CRITICAL"].')
@utils.arg('--state-updated-start-time', metavar='<UTC_STATE_UPDATED_START>',
help='Return all alarms whose state was updated on or after the time specified.')
@utils.arg('--lifecycle-state', metavar='<LIFECYCLE_STATE>',
help='The lifecycle state of the alarm.')
@utils.arg('--link', metavar='<LINK>',
help='The link to external data associated with the alarm.')
@utils.arg('--sort-by', metavar='<SORT BY FIELDS>',
help='Fields to sort by as a comma separated list. Valid values are alarm_id, '
'alarm_definition_id, state, severity, lifecycle_state, link, '
'state_updated_timestamp, updated_timestamp, created_timestamp. '
'Fields may be followed by "asc" or "desc", ex "severity desc", '
'to set the direction of sorting.')
@utils.arg('--offset', metavar='<OFFSET LOCATION>',
help='The offset used to paginate the return data.')
@utils.arg('--limit', metavar='<RETURN LIMIT>',
help='The amount of data to be returned up to the API maximum limit.')
def do_alarm_list(mc, args):
'''List alarms for this tenant.'''
fields = {}
if args.alarm_definition_id:
fields['alarm_definition_id'] = args.alarm_definition_id
if args.metric_name:
fields['metric_name'] = args.metric_name
if args.metric_dimensions:
fields['metric_dimensions'] = utils.format_dimensions_query(args.metric_dimensions)
if args.state:
if args.state.upper() not in state_types:
errmsg = ('Invalid state, not one of [' +
', '.join(state_types) + ']')
print(errmsg)
return
fields['state'] = args.state
if args.severity:
if not _validate_severity(args.severity):
return
fields['severity'] = args.severity
if args.state_updated_start_time:
fields['state_updated_start_time'] = args.state_updated_start_time
if args.lifecycle_state:
fields['lifecycle_state'] = args.lifecycle_state
if args.link:
fields['link'] = args.link
if args.limit:
fields['limit'] = args.limit
if args.offset:
fields['offset'] = args.offset
if args.sort_by:
sort_by = args.sort_by.split(',')
for field in sort_by:
field_values = field.lower().split()
if len(field_values) > 2:
print("Invalid sort_by value {}".format(field))
if field_values[0] not in allowed_alarm_sort_by:
print("Sort-by field name {} is not in [{}]".format(field_values[0],
allowed_alarm_sort_by))
return
if len(field_values) > 1 and field_values[1] not in ['asc', 'desc']:
print("Invalid value {}, must be asc or desc".format(field_values[1]))
fields['sort_by'] = args.sort_by
try:
alarm = mc.alarms.list(**fields)
except (osc_exc.ClientException, k_exc.HttpError) as he:
raise osc_exc.CommandError('%s\n%s' % (he.message, he.details))
else:
if args.json:
print(utils.json_formatter(alarm))
return
cols = ['id', 'alarm_definition_id', 'alarm_definition_name', 'metric_name',
'metric_dimensions', 'severity', 'state', 'lifecycle_state', 'link',
'state_updated_timestamp', 'updated_timestamp', "created_timestamp"]
formatters = {
'id': lambda x: x['id'],
'alarm_definition_id': lambda x: x['alarm_definition']['id'],
'alarm_definition_name': lambda x: x['alarm_definition']['name'],
'metric_name': lambda x: format_metric_name(x['metrics']),
'metric_dimensions': lambda x: format_metric_dimensions(x['metrics']),
'severity': lambda x: x['alarm_definition']['severity'],
'state': lambda x: x['state'],
'lifecycle_state': lambda x: x['lifecycle_state'],
'link': lambda x: x['link'],
'state_updated_timestamp': lambda x: x['state_updated_timestamp'],
'updated_timestamp': lambda x: x['updated_timestamp'],
'created_timestamp': lambda x: x['created_timestamp'],
}
if isinstance(alarm, list):
# print the list
utils.print_list(alarm, cols, formatters=formatters)
else:
# add the dictionary to a list, so print_list works
alarm_list = list()
alarm_list.append(alarm)
utils.print_list(alarm_list, cols, formatters=formatters)
@utils.arg('id', metavar='<ALARM_ID>',
help='The ID of the alarm.')
def do_alarm_show(mc, args):
'''Describe the alarm.'''
fields = {}
fields['alarm_id'] = args.id
try:
alarm = mc.alarms.get(**fields)
except (osc_exc.ClientException, k_exc.HttpError) as he:
raise osc_exc.CommandError('%s\n%s' % (he.message, he.details))
else:
if args.json:
print(utils.json_formatter(alarm))
return
# print out detail of a single alarm
formatters = {
'id': utils.json_formatter,
'alarm_definition': utils.json_formatter,
'metrics': utils.json_formatter,
'state': utils.json_formatter,
'links': utils.format_dictlist,
}
utils.print_dict(alarm, formatters=formatters)
@utils.arg('id', metavar='<ALARM_ID>',
help='The ID of the alarm.')
@utils.arg('state', metavar='<ALARM_STATE>',
help='ALARM_STATE is one of [UNDETERMINED, OK, ALARM].')
@utils.arg('lifecycle_state', metavar='<LIFECYCLE_STATE>',
help='The lifecycle state of the alarm.')
@utils.arg('link', metavar='<LINK>',
help='A link to an external resource with information about the alarm.')
def do_alarm_update(mc, args):
'''Update the alarm state.'''
fields = {}
fields['alarm_id'] = args.id
if args.state.upper() not in state_types:
errmsg = ('Invalid state, not one of [' +
', '.join(state_types) + ']')
print(errmsg)
return
fields['state'] = args.state
fields['lifecycle_state'] = args.lifecycle_state
fields['link'] = args.link
try:
alarm = mc.alarms.update(**fields)
except (osc_exc.ClientException, k_exc.HttpError) as he:
raise osc_exc.CommandError('%s\n%s' % (he.message, he.details))
else:
print(jsonutils.dumps(alarm, indent=2))
@utils.arg('id', metavar='<ALARM_ID>',
help='The ID of the alarm.')
@utils.arg('--state', metavar='<ALARM_STATE>',
help='ALARM_STATE is one of [UNDETERMINED, OK, ALARM].')
@utils.arg('--lifecycle-state', metavar='<LIFECYCLE_STATE>',
help='The lifecycle state of the alarm.')
@utils.arg('--link', metavar='<LINK>',
help='A link to an external resource with information about the alarm.')
def do_alarm_patch(mc, args):
'''Patch the alarm state.'''
fields = {}
fields['alarm_id'] = args.id
if args.state:
if args.state.upper() not in state_types:
errmsg = ('Invalid state, not one of [' +
', '.join(state_types) + ']')
print(errmsg)
return
fields['state'] = args.state
if args.lifecycle_state:
fields['lifecycle_state'] = args.lifecycle_state
if args.link:
fields['link'] = args.link
try:
alarm = mc.alarms.patch(**fields)
except (osc_exc.ClientException, k_exc.HttpError) as he:
raise osc_exc.CommandError('%s\n%s' % (he.message, he.details))
else:
print(jsonutils.dumps(alarm, indent=2))
@utils.arg('id', metavar='<ALARM_ID>',
help='The ID of the alarm.')
def do_alarm_delete(mc, args):
'''Delete the alarm.'''
fields = {}
fields['alarm_id'] = args.id
try:
mc.alarms.delete(**fields)
except (osc_exc.ClientException, k_exc.HttpError) as he:
raise osc_exc.CommandError('%s\n%s' % (he.message, he.details))
else:
print('Successfully deleted alarm')
def output_alarm_history(args, alarm_history):
if args.json:
print(utils.json_formatter(alarm_history))
return
# format output
cols = ['alarm_id', 'new_state', 'old_state', 'reason',
'reason_data', 'metric_name', 'metric_dimensions', 'timestamp']
formatters = {
'alarm_id': lambda x: x['alarm_id'],
'new_state': lambda x: x['new_state'],
'old_state': lambda x: x['old_state'],
'reason': lambda x: x['reason'],
'reason_data': lambda x: x['reason_data'],
'metric_name': lambda x: format_metric_name(x['metrics']),
'metric_dimensions': lambda x: format_metric_dimensions(x['metrics']),
'timestamp': lambda x: x['timestamp'],
}
if isinstance(alarm_history, list):
# print the list
utils.print_list(alarm_history, cols, formatters=formatters)
else:
# add the dictionary to a list, so print_list works
alarm_list = list()
alarm_list.append(alarm_history)
utils.print_list(alarm_list, cols, formatters=formatters)
@utils.arg('--alarm-definition-id', metavar='<ALARM_DEFINITION_ID>',
help='The ID of the alarm definition.')
@utils.arg('--metric-name', metavar='<METRIC_NAME>',
help='Name of the metric.')
@utils.arg('--metric-dimensions', metavar='<KEY1=VALUE1,KEY2,KEY3=VALUE2...>',
help='key value pair used to specify a metric dimension or '
'just key to select all values of that dimension.'
'This can be specified multiple times, or once with parameters '
'separated by a comma. '
'Dimensions need quoting when they contain special chars [&,(,),{,},>,<] '
'that confuse the CLI parser.',
action='append')
@utils.arg('--state', metavar='<ALARM_STATE>',
help='ALARM_STATE is one of [UNDETERMINED, OK, ALARM].')
@utils.arg('--severity', metavar='<SEVERITY>',
help='Severity is one of ["LOW", "MEDIUM", "HIGH", "CRITICAL"].')
@utils.arg('--state-updated-start-time', metavar='<UTC_STATE_UPDATED_START>',
help='Return all alarms whose state was updated on or after the time specified.')
@utils.arg('--lifecycle-state', metavar='<LIFECYCLE_STATE>',
help='The lifecycle state of the alarm.')
@utils.arg('--link', metavar='<LINK>',
help='The link to external data associated with the alarm.')
@utils.arg('--group-by', metavar='<GROUP_BY>',
help='Comma separated list of one or more fields to group the results by. '
'Group by is one or more of [alarm_definition_id, name, state, link, '
'lifecycle_state, metric_name, dimension_name, dimension_value].')
@utils.arg('--offset', metavar='<OFFSET LOCATION>',
help='The offset used to paginate the return data.')
@utils.arg('--limit', metavar='<RETURN LIMIT>',
help='The amount of data to be returned up to the API maximum limit.')
def do_alarm_count(mc, args):
'''Count alarms.'''
fields = {}
if args.alarm_definition_id:
fields['alarm_definition_id'] = args.alarm_definition_id
if args.metric_name:
fields['metric_name'] = args.metric_name
if args.metric_dimensions:
fields['metric_dimensions'] = utils.format_dimensions_query(args.metric_dimensions)
if args.state:
if args.state.upper() not in state_types:
errmsg = ('Invalid state, not one of [' +
', '.join(state_types) + ']')
print(errmsg)
return
fields['state'] = args.state
if args.severity:
if not _validate_severity(args.severity):
return
fields['severity'] = args.severity
if args.state_updated_start_time:
fields['state_updated_start_time'] = args.state_updated_start_time
if args.lifecycle_state:
fields['lifecycle_state'] = args.lifecycle_state
if args.link:
fields['link'] = args.link
if args.group_by:
group_by = args.group_by.split(',')
if not set(group_by).issubset(set(group_by_types)):
errmsg = ('Invalid group-by, one or more values not in [' +
','.join(group_by_types) + ']')
print(errmsg)
return
fields['group_by'] = args.group_by
if args.limit:
fields['limit'] = args.limit
if args.offset:
fields['offset'] = args.offset
try:
counts = mc.alarms.count(**fields)
except (osc_exc.ClientException, k_exc.HttpError) as he:
raise osc_exc.CommandError('%s\n%s' % (he.message, he.details))
else:
if args.json:
print(utils.json_formatter(counts))
return
cols = counts['columns']
utils.print_list(counts['counts'], [i for i in range(len(cols))],
field_labels=cols)
@utils.arg('id', metavar='<ALARM_ID>',
help='The ID of the alarm.')
@utils.arg('--offset', metavar='<OFFSET LOCATION>',
help='The offset used to paginate the return data.')
@utils.arg('--limit', metavar='<RETURN LIMIT>',
help='The amount of data to be returned up to the API maximum limit.')
def do_alarm_history(mc, args):
'''Alarm state transition history.'''
fields = {}
fields['alarm_id'] = args.id
if args.limit:
fields['limit'] = args.limit
if args.offset:
fields['offset'] = args.offset
try:
alarm = mc.alarms.history(**fields)
except (osc_exc.ClientException, k_exc.HttpError) as he:
raise osc_exc.CommandError('%s\n%s' % (he.message, he.details))
else:
output_alarm_history(args, alarm)
@utils.arg('--dimensions', metavar='<KEY1=VALUE1,KEY2=VALUE2...>',
help='key value pair used to specify a metric dimension. '
'This can be specified multiple times, or once with parameters '
'separated by a comma. '
'Dimensions need quoting when they contain special chars [&,(,),{,},>,<] '
'that confuse the CLI parser.',
action='append')
@utils.arg('--starttime', metavar='<UTC_START_TIME>',
help='measurements >= UTC time. format: 2014-01-01T00:00:00Z. OR'
' format: -120 (previous 120 minutes).')
@utils.arg('--endtime', metavar='<UTC_END_TIME>',
help='measurements <= UTC time. format: 2014-01-01T00:00:00Z.')
@utils.arg('--offset', metavar='<OFFSET LOCATION>',
help='The offset used to paginate the return data.')
@utils.arg('--limit', metavar='<RETURN LIMIT>',
help='The amount of data to be returned up to the API maximum limit.')
def do_alarm_history_list(mc, args):
'''List alarms state history.'''
fields = {}
if args.dimensions:
fields['dimensions'] = utils.format_parameters(args.dimensions)
if args.starttime:
_translate_starttime(args)
fields['start_time'] = args.starttime
if args.endtime:
fields['end_time'] = args.endtime
if args.limit:
fields['limit'] = args.limit
if args.offset:
fields['offset'] = args.offset
try:
alarm = mc.alarms.history_list(**fields)
except (osc_exc.ClientException, k_exc.HttpError) as he:
raise osc_exc.CommandError('%s\n%s' % (he.message, he.details))
else:
output_alarm_history(args, alarm)
def do_notification_type_list(mc, args):
'''List notification types supported by monasca.'''
try:
notification_types = mc.notificationtypes.list()
except (osc_exc.ClientException, k_exc.HttpError) as he:
raise osc_exc.CommandError('%s\n%s' % (he.message, he.details))
else:
if args.json:
print(utils.json_formatter(notification_types))
return
else:
formatters = {'types': lambda x: x["type"]}
# utils.print_list(notification_types['types'], ["types"], formatters=formatters)
utils.print_list(notification_types, ["types"], formatters=formatters)
def _translate_starttime(args):
if args.starttime[0] == '-':
deltaT = time.time() + (int(args.starttime) * 60)
utc = str(datetime.datetime.utcfromtimestamp(deltaT))
utc = utc.replace(" ", "T")[:-7] + 'Z'
args.starttime = utc
def _arg_split_patch_update(arg, patch=False):
if patch:
arg = ','.join(arg)
if not arg or arg == "[]":
arg_split = []
else:
arg_split = arg.split(',')
return arg_split
|