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
|
# Copyright (c) 2007, 2016, Oracle and/or its affiliates. All rights reserved.
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License as
# published by the Free Software Foundation; version 2 of the
# License.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
# 02110-1301 USA
"""
How to handle MySQL logs
*************************
Among other things this module needs to establish:
1. Which of the logs (if any) are enabled.
2. Whether the output of the enabled logs are stored in a table or in a log file.
Determining the state of the logs
-----------------------------------
There are two possible scenarios:
the server is down:
In this case all logs are assumed to be **disabled** since the server won't
be logging anything unless it's running.
the server is up:
Starting with MySQL Server 5.1.29 the relevant server variables changed.
This derives in two new scenarios:
server version < 5.1.29:
:general query log:
The state of this log is reflected in the server variable ``log``
which will be set to ``'OFF'`` if the log is disabled or to either
``'ON'`` or to ``'1'`` or to a file path if the log is enabled.
:slow query log:
Its state is reflected in the server variable ``log_slow_queries``
which will be set to ``'OFF'`` if the log is disabled or to
``'ON'`` or to ``'1'`` if the log is enabled.
:error log:
Its state is reflected in the server variable ``log_error``
which will be set to ``''`` (the empty string) if the log is disabled
or to the path to the error log file if the log is enabled.
.. note::
The error logs are not going to be written to the error log file
if the server was started with the ``--console`` command line
option on Windows, even if ``log_error`` has a path set up. In
this case error logs are written to stderr.
It seems that there's no way to query the server to determine if
this ``--console`` option is in place.
.. note::
The ``log_slow_queries`` and ``log`` variable were removed in MySQL
Server 5.6.
server version >= 5.1.29:
:general query log:
If enabled the ``general_log`` variable will be set to ``'ON'`` or
to ``'1'``. Otherwise it will be set to ``'OFF'`` or to ``'0'``.
:slow query log:
If enabled the ``slow_query_log`` variable will be set to ``'ON'`` or
to ``'1'``. Otherwise it will be set to ``'OFF'`` or to ``'0'``.
:error log:
Its state is reflected in the server variable ``log_error`` as
explained for server version < 5.1.29.
.. note::
For MySQL Server versions >= 5.1.6, if the variable ``log_output``
contains the value ``'NONE'``, the general query log and the slow
query log will not record any new log entry.
The general log can also be disabled by setting to ``'1'`` the session
variable ``sql_log_off``.
Determining where the logs are being written
---------------------------------------------
Starting from MySQL Server 5.1.6 there's the possibility of sending the logs
from the general query log or from the slow query log to a server table instead
of to a log file. This is controlled by the value of the variable ``log_output``
which can be a combination of the values ``'FILE'`` (log into log files),
``'TABLE'`` (log into a server table) or ``'NONE'`` (don't log). If given, ``'NONE'``
takes precedence over the other values.
.. warning::
For MySQL Server versions older than 5.1.29 there's no reliable way to know
where the general and slow query logs are being written (if they are logged
to a file). Their default values are ``$datadir + $hostname + '.log'`` and
``$datadir + $hostname + '-slow.log'``, respectively. This can be changed
in the command line or in the configuration file and the real paths will not
be exposed in any server variable.
Starting from MySQL Server 5.1.29 the paths to the general and slow query log
files are stored in the ``general_query_log_file`` and in the``slow_query_log_file``
variables, respectively. *The server creates the file in the data directory unless
an absolute path name is given to specify a different directory.*
Use cases for the server logs
---------------------------------
1. The server is running. All logs are enabled and WB can precisely determine their
sources. Every log is shown in its corresponding tab.
2. The ``log_output`` server variable contains both ``'FILE'`` and ``'TABLE'``.
WB will select on a per log basis which source should be chosen. Will select
table logs if the server is local or if the server is remote and any of these
happen:
* Cannot reliably determine the paths to the log file.
* The user running WB has no read permissions on the log file.
* The log file does not exist.
* The user explicitly requested to read from log table.
3. ``log_output`` contains ``'NONE'``. Nonetheless WB will check for log sources
and will show them, alerting the user about log not being updated because of
that. *What to do if there are log files and log tables available in this case?*
4. The server is logging to files and WB can precisely determine their paths but
the log file is missing in the file system. The situation will be reported to
the user (advising him to ``FLUSH LOGS`` or restart the server and start querying)
The log will not be shown as long as this situation persists.
5. The server is logging to tables and the connection to the server is lost. If the
server is also logging to files, and a log file exists in the file system, the
log file will be shown and the user will be warned about this change.
6. The server is logging to files and WB cannot precisely determine the path to the
log file (i.e. server version < 5.1.29). WB will try to get the path from these
sources in this order:
1. The server's configuration file.
2. The default path assumed by the server when no log path is specified.
If no such file is found in the file system the log will not be shown.
7. The user changed the source of a log or the path to a log file while WB was
showing the previous source/path. WB will switch to the new source/path and will
inform the user of the change.
8. [Postponed] The user clicks on a *Add new log* button. A dialog will be shown in
which the user will select the type of log to be added (error, general or slow),
the log source (a database table or a log file) and the name of the log table/file.
A new tab showing the user selected log will be shown and will persist during the
session or until the user clicks on the tab's *Close* button.
"""
import grt
from mforms import newBox, newLabel, newTreeView, newTabView, newButton
import mforms
from wb_admin_utils import not_running_warning_label, make_panel_header, show_error_page, remove_error_page_if_exists
from wb_log_reader import GeneralQueryLogReader, SlowQueryLogReader, GeneralLogFileReader, SlowLogFileReader, ErrorLogFileReader
import wb_admin_config_file_be
from wb_common import LogFileAccessError, ServerIOError, OperationCancelledError, InvalidPasswordError, log_error_decorator
from workbench.utils import WorkerThreadHelper
from workbench.log import log_error, log_debug
class LogView(mforms.Box):
'''
Main front end view class for displaying log entries.
Each page in the Tab View is an instance of this class.
'''
def __init__(self, owner, BackendLogReaderClass, *args):
'''
The arguments following BackendLogReaderClass will be passed to
BackendLogReaderClass to instantiate it in order to get a log
reader object.
'''
super(LogView, self).__init__(False)
self.set_managed()
self.set_release_on_add()
self.owner = owner
self.BackendLogReaderClass = BackendLogReaderClass
self.args = args
self.log_reader = None
self.error_box = None
self.tree = None
self.bbox = None
self.warning_box = None
self.update_ui()
self.worker = None
@log_error_decorator
def _show_error(self, error):
if self.error_box:
self.remove(self.error_box)
self.error_box = None
self.error_box = newBox(True)
self.error_box.set_spacing(8)
error_label = newLabel(str(error))
self.error_box.add(error_label, False, False)
try_again_button = newButton()
try_again_button.set_text('Try again')
self.error_box.add(try_again_button, False, False)
try_again_button.add_clicked_callback(self.try_again)
self.add(self.error_box, False, True)
def try_again(self):
self.update_ui()
self.refresh()
def create_filter_box(self):
pass
def update_ui(self):
if self.error_box:
self.remove(self.error_box)
self.error_box = None
if self.tree:
self.remove(self.tree)
self.tree = None
if self.bbox:
self.remove(self.bbox)
self.bbox = None
if self.warning_box:
self.remove(self.warning_box)
self.warning_box = None
self.set_padding(8)
self.set_spacing(8)
filter_box = self.create_filter_box()
if filter_box:
self.add(filter_box, False, False)
try:
self.log_reader = self.BackendLogReaderClass(*self.args)
except Exception, error:
import traceback
log_error("Exception creating log reader: %s\n%s\n" % (error, traceback.format_exc()))
self._show_error("Error creating log reader: %s\n" % error)
return
if self.log_reader.partial_support:
self.warning_box = newBox(True)
self.warning_box.set_spacing(8)
warning_label = newLabel(self.log_reader.partial_support)
self.warning_box.add(warning_label, False, False)
self.add(self.warning_box, False, True)
self.tree = newTreeView(mforms.TreeFlatList)
self.tree.set_selection_mode(mforms.TreeSelectMultiple)
for colspec in self.log_reader.column_specs:
self.tree.add_column(mforms.StringColumnType,
colspec[0], # column header
colspec[1], # column width
False)
self.tree.end_columns()
self.add(self.tree, True, True)
table = mforms.newTable()
table.set_row_spacing(4)
table.set_column_spacing(4)
table.set_column_count(4)
table.set_row_count(2)
table.add(newLabel("Log File Location:"), 0, 1, 0, 1, mforms.HFillFlag)
if self.log_reader.log_file:
if self.log_reader.log_file.path == "stderr":
self.query = """<QueryList><Query Id = "0" Path = "Application">
<Select Path = "Application">*[System[Provider[@Name = 'MySQL'] and TimeCreated[timediff(@SystemTime) <= 604800000]]]</Select>
</Query></QueryList>"""
grt.setEventlogCallback(self.printResults)
label = newLabel("Windows Event viewer")
else:
label = newLabel(self.log_reader.log_file.path)
else:
label = newLabel("TABLE")
label.set_style(mforms.BoldStyle)
table.add(label, 1, 2, 0, 1, mforms.HFillFlag|mforms.HExpandFlag)
table.add(newLabel("Log File Size:"), 2, 3, 0, 1, mforms.HFillFlag)
self.size_label = newLabel("retrieving..." if self.log_reader.log_file else "-")
self.size_label.set_style(mforms.BoldStyle)
table.add(self.size_label, 3, 4, 0, 1, mforms.HFillFlag|mforms.HExpandFlag)
table.add(newLabel("Showing:"), 0, 1, 1, 2, mforms.HFillFlag)
self.range_label = newLabel("retrieving data...")
self.range_label.set_style(mforms.BoldStyle)
table.add(self.range_label, 1, 2, 1, 2, mforms.HFillFlag)
self.add(table, False, True)
self.bbox = newBox(True)
self.bbox.set_spacing(8)
self.add_end(self.bbox, False, True)
self._menu = mforms.newContextMenu()
self._menu.add_item_with_title("Copy", self.copy_record, "copy_record")
self._menu.add_item_with_title("Copy Details", self.copy_details, "copy_details")
self.tree.set_context_menu(self._menu)
self.bbox.add(newLabel(""), True, True)
self.bof_button = newButton()
self.bof_button.set_text("Oldest")
self.bbox.add(self.bof_button, False, True)
self.bof_button.add_clicked_callback(self.go_bof)
self.back_button = newButton()
self.back_button.set_text("< Previous Page")
self.bbox.add(self.back_button, False, True)
self.back_button.add_clicked_callback(self.go_back)
self.next_button = newButton()
self.next_button.set_text("Next Page >")
self.bbox.add(self.next_button, False, True)
self.next_button.add_clicked_callback(self.go_next)
self.eof_button = newButton()
self.eof_button.set_text("Most Recent")
self.bbox.add(self.eof_button, False, True)
self.eof_button.add_clicked_callback(self.go_eof)
self.refresh_button = newButton()
self.refresh_button.set_text("Refresh")
self.bbox.add(self.refresh_button, False, True)
self.refresh_button.add_clicked_callback(self.refresh)
if self.log_reader.log_file and self.log_reader.log_file.path == "stderr":
self.actual_position = 0
grt.getEventLogEntry(0, self.query)
def printResults(self, text, args):
self.actual_position = self.actual_position + 1
row = self.tree.add_node()
self.size_label.set_text(str(self.actual_position))
for idx, key in enumerate(self.log_reader.column_keys):
row.set_string(idx, args[key])
def read_data_worker(self, out):
out(self.log_reader.current())
def handle_worker_data(self, data):
if isinstance(data, Exception):
mforms.Utilities.show_error("Error Reading Log File",
"%s" % data, "OK", "", "")
self.worker = None
return
self.refresh(data)
self.worker = None
def refresh(self, records=None):
if self.log_reader.log_file.path == "stderr":
grt.getEventLogEntry(self.actual_position, self.query)
self.bof_button.set_enabled(False)
self.back_button.set_enabled(False)
self.eof_button.set_enabled(False)
self.next_button.set_enabled(False)
self.range_label.set_text('Records read: %d' % self.actual_position)
return
if self.log_reader:
try:
self.log_reader.refresh()
if records is None:
if not self.worker:
self.bof_button.set_enabled(False)
self.back_button.set_enabled(False)
self.eof_button.set_enabled(False)
self.next_button.set_enabled(False)
self.refresh_button.set_enabled(False)
# this will create a thread which will read the log data and once it finishes,
# self.refresh will be called with the data
self.worker = WorkerThreadHelper(self.read_data_worker, self.handle_worker_data)
self.worker.start(1)
return
self.tree.clear()
for rec in records:
row = self.tree.add_node()
for idx, col in enumerate(rec):
row.set_string(idx, col.strip())
self.range_label.set_text(self.log_reader.range_text())
self.size_label.set_text(self.log_reader.size_text())
self.bof_button.set_enabled(self.log_reader.has_previous())
self.back_button.set_enabled(self.log_reader.has_previous())
self.eof_button.set_enabled(self.log_reader.has_next())
self.next_button.set_enabled(self.log_reader.has_next())
self.refresh_button.set_enabled(True)
except (ServerIOError, RuntimeError, LogFileAccessError, OperationCancelledError, InvalidPasswordError, IOError, ValueError), error:
self._show_error(error)
def copy_details(self):
selection = self.tree.get_selection()
text = []
for node in selection:
text.append(node.get_string(self.log_reader.detail_column))
if text:
mforms.Utilities.set_clipboard_text("\n".join(text))
def copy_record(self):
selection = self.tree.get_selection()
text = [", ".join([r[0] for r in self.log_reader.column_specs])]
for node in selection:
record = []
for i in range(len(self.log_reader.column_specs)):
record.append(node.get_string(i))
text.append(", ".join(record))
if text:
mforms.Utilities.set_clipboard_text("\n".join(text))
def go_bof(self):
try:
self.refresh(self.log_reader.first())
except (ServerIOError, RuntimeError, LogFileAccessError, OperationCancelledError, InvalidPasswordError, IOError, ValueError), error:
self._show_error(error)
def go_eof(self):
try:
self.refresh(self.log_reader.last())
except (ServerIOError, RuntimeError, LogFileAccessError, OperationCancelledError, InvalidPasswordError, IOError, ValueError), error:
self._show_error(error)
def go_back(self):
try:
records = self.log_reader.previous() if self.log_reader.has_previous() else None
self.refresh(records)
except (ServerIOError, RuntimeError, LogFileAccessError, OperationCancelledError, InvalidPasswordError, IOError, ValueError), error:
self._show_error(error)
def go_next(self):
try:
records = self.log_reader.next() if self.log_reader.has_next() else None
self.refresh(records)
except (ServerIOError, RuntimeError, LogFileAccessError, OperationCancelledError, InvalidPasswordError, IOError, ValueError), error:
self._show_error(error)
class LogViewGeneric(LogView):
def __init__(self, owner, BackendLogReaderClass, *args):
self.filter_list = {}
self.filter_box = mforms.newBox(True)
self.filter_text = ""
super(LogViewGeneric, self).__init__(owner, BackendLogReaderClass, *args)
def add_filter_option(self, text):
filter = mforms.newRadioButton(1)
filter.set_text(text)
filter.add_clicked_callback(self.filter_handler)
self.filter_list[text] = filter
self.filter_box.add(filter, False, False)
def create_filter_box(self):
self.add_filter_option("All")
self.add_filter_option("InnoDB")
# so that it shows up in 'development' and 'Commercial'
if not grt.root.wb.info.edition == "Community":
self.add_filter_option("Firewall")
return self.filter_box
def filter_handler(self):
for text, filter in self.filter_list.iteritems():
if filter.get_active():
self.filter_text = text
self.refresh(None)
def refresh(self, records=None):
filtered_records = None
if records:
filtered_records = []
for record in records:
text = record[3]
if self.filter_text == "All" or text.lower().find(self.filter_text.lower()) >= 0:
filtered_records.append(record)
super(LogViewGeneric, self).refresh(filtered_records)
class WbAdminLogs(mforms.Box):
ui_created = False
@classmethod
def wba_register(cls, admin_context):
admin_context.register_page(cls, "wba_instance", "Server Logs", True)
@classmethod
def identifier(cls):
return "admin_server_logs"
def __init__(self, ctrl_be, server_profile, main_view):
super(WbAdminLogs, self).__init__(False)
self.set_managed()
self.ctrl_be = ctrl_be
self.server_profile = server_profile
self.main_view = main_view
self.disable_log_refresh = False
def create_ui(self):
self.set_padding(12)
self.set_spacing(8)
self.heading = make_panel_header("title_logs.png", self.server_profile.name, "Server Logs")
self.add(self.heading, False, True)
self.warning = not_running_warning_label()
self.add(self.warning, False, True)
self.warning.show(False)
self.tabView = newTabView(False)
self.add(self.tabView, True, True)
self.general_log_tab = None
self.slow_log_tab = None
self.general_file_log_tab = None
self.slow_file_log_tab = None
self.error_file_log_tab = None
def get_log_destination(self):
dest = {}
if self.ctrl_be.is_sql_connected(): # If server is up, query the destination from there
if not self.ctrl_be.target_version.is_supported_mysql_version_at_least(5,1,6): # Logging to TABLE was introduced in v5.1.6
try:
result = self.ctrl_be.exec_query("SHOW VARIABLES LIKE 'log'")
if not result.nextRow():
return dest
except:
return dest
self.server_profile.log_output = 'FILE' if result.stringByName("Value")=='ON' else 'NONE'
log_debug('%s: log_output = %s\n' % (self.__class__.__name__, self.server_profile.log_output) )
else:
try:
result = self.ctrl_be.exec_query("SHOW VARIABLES LIKE 'log_output'")
if not result.nextRow():
return dest
except:
return dest
self.server_profile.log_output = result.stringByName("Value")
if 'FILE' in self.server_profile.log_output and 'TABLE' in self.server_profile.log_output:
def open_remote_file(path):
import wb_admin_ssh, wb_server_control
ssh = wb_admin_ssh.WbAdminSSH()
ssh.wrapped_connect(self.server_profile, wb_server_control.PasswordHandler(self.server_profile))
sftp = ssh.client.open_sftp()
if not ssh.is_connected():
raise IOError, ''
sftp.open(path)
# Can't read logs from files if admin is disabled:
if not self.server_profile.admin_enabled:
dest['general_log'] = 'TABLE'
dest['slow_log'] = 'TABLE'
log_debug('%s: log_output = %s\n' % (self.__class__.__name__, dest) )
return dest
# Try to prioritize the files if they are readable
if not getattr(self, 'stored_general_log_source_choice', None):
if self.server_profile.general_log_file_path:
try:
open(self.server_profile.general_log_file_path) if self.server_profile.is_local else open_remote_file(self.server_profile.general_log_file_path)
dest['general_log'] = 'FILE'
except:
dest['general_log'] = 'TABLE'
else:
dest['general_log'] = 'TABLE'
self.stored_general_log_source_choice = dest['general_log']
else:
dest['general_log'] = self.stored_general_log_source_choice
if not getattr(self, 'stored_slow_log_source_choice', None):
if self.server_profile.slow_log_file_path:
try:
open(self.server_profile.slow_log_file_path) if self.server_profile.is_local else open_remote_file(self.server_profile.slow_log_file_path)
dest['slow_log'] = 'FILE'
except:
dest['slow_log'] = 'TABLE'
else:
dest['slow_log'] = 'TABLE'
self.stored_slow_log_source_choice = dest['slow_log']
else:
dest['slow_log'] = self.stored_slow_log_source_choice
log_debug('%s: log_output = %s\n' % (self.__class__.__name__, dest) )
return dest
def show_message_panel(self, msg):
self.warning.set_text(msg)
self.warning.show(True)
self.tabView.show(False)
def _remove_tabs(self, *source):
if 'TABLE' in source:
source = list(source) + ['general_tab', 'slow_tab']
if 'FILE' in source:
source = list(source) + ['general_file_tab', 'slow_file_tab']
if 'general_tab' in source and self.general_log_tab:
self.tabView.remove_page(self.general_log_tab)
self.general_log_tab = None
if 'slow_tab' in source and self.slow_log_tab:
self.tabView.remove_page(self.slow_log_tab)
self.slow_log_tab= None
if 'general_file_tab' in source and self.general_file_log_tab:
self.tabView.remove_page(self.general_file_log_tab)
self.general_file_log_tab = None
if 'slow_file_tab' in source and self.slow_file_log_tab:
self.tabView.remove_page(self.slow_file_log_tab)
self.slow_file_log_tab = None
if 'error_file_tab' in source and self.error_file_log_tab:
self.tabView.remove_page(self.error_file_log_tab)
self.error_file_log_tab = None
def _add_tabs(self, *source):
if 'TABLE' in source:
source = list(source) + ['general_tab', 'slow_tab']
if 'FILE' in source:
source = list(source) + ['general_file_tab', 'slow_file_tab']
if 'error_file_tab' in source and self.server_profile.error_log_file_path and not self.error_file_log_tab:
try:
self.error_file_log_tab = LogViewGeneric(self, ErrorLogFileReader, self.ctrl_be, self.server_profile.error_log_file_path)
self.tabView.add_page(self.error_file_log_tab, "Error Log File")
except IOError:
self.show_message_panel('There was a problem reading %s. Please verify that you have read permissions on that file' % self.server_profile.error_log_file_path)
self.error_file_log_tab = None
if 'general_file_tab' in source and self.server_profile.general_log_enabled and self.server_profile.general_log_file_path and not self.general_file_log_tab:
try:
self.general_file_log_tab = LogView(self, GeneralLogFileReader, self.ctrl_be, self.server_profile.general_log_file_path)
self.tabView.add_page(self.general_file_log_tab, "General Log File")
except IOError:
self.show_message_panel('There was a problem reading %s.\nPlease verify that you have read permissions on that file' % self.server_profile.general_log_file_path)
self.general_file_log_tab = None
if 'slow_file_tab' in source and self.server_profile.slow_log_enabled and self.server_profile.slow_log_file_path and not self.slow_file_log_tab:
try:
self.slow_file_log_tab = LogView(self, SlowLogFileReader, self.ctrl_be, self.server_profile.slow_log_file_path)
self.tabView.add_page(self.slow_file_log_tab, "Slow Log File")
except IOError:
self.show_message_panel('There was a problem reading %s. Please verify that you have read permissions on that file' % self.server_profile.slow_log_file_path)
self.slow_file_log_tab = None
if 'general_tab' in source and self.server_profile.general_log_enabled and not self.general_log_tab:
self.general_log_tab = LogView(self, GeneralQueryLogReader, self.ctrl_be)
self.tabView.add_page(self.general_log_tab, 'General Log Table')
if 'slow_tab' in source and self.server_profile.slow_log_enabled and not self.slow_log_tab:
self.slow_log_tab = LogView(self, SlowQueryLogReader, self.ctrl_be)
self.tabView.add_page(self.slow_log_tab, 'Slow Query Log Table')
def update_ui(self):
dest = self.get_log_destination()
self._add_tabs('error_file_tab')
if not self.server_profile.log_output:
self.server_profile.log_output = 'TABLE,FILE'
if 'NONE' in self.server_profile.log_output:
self._remove_tabs('TABLE', 'FILE')
elif self.server_profile.log_output == 'FILE':
self._remove_tabs('TABLE')
self._add_tabs('FILE')
elif self.server_profile.log_output == 'TABLE':
self._remove_tabs('FILE')
self._add_tabs('TABLE')
elif self.server_profile.log_output == 'TABLE,FILE' or self.server_profile.log_output == 'FILE,TABLE':
tabs = set(['general_tab', 'slow_tab', 'general_file_tab', 'slow_file_tab'])
to_be_added = []
if not self.ctrl_be.is_sql_connected():
to_be_added = ['general_file_tab', 'slow_file_tab']
else:
to_be_added.append('general_file_tab' if dest['general_log'] == 'FILE' else 'general_tab')
to_be_added.append('slow_file_tab' if dest['slow_log'] == 'FILE' else 'slow_tab')
self._remove_tabs( *tuple(tabs - set(to_be_added)) ) # Remove the ones that aren't added
self._add_tabs( *tuple(to_be_added) )
else:
msg = """We have detected a problem in your current Log Destination.
It is set to %s. Please refer to the documentation for further information:
http://dev.mysql.com/doc/refman/5.1/en/log-destinations.html""" % self.server_profile.log_output
self.show_message_panel(msg)
return
self.warning.show(False)
self.tabView.show(True)
def page_activated(self):
if not self.server_profile.config_file_path:
show_error_page(self, "Location of MySQL configuration file (ie: my.cnf) not specified")
return
else:
remove_error_page_if_exists(self)
if not self.ui_created:
self.detect_paths()
self.create_ui()
self.ui_created = True
self.update_ui()
try:
self.refresh()
except Exception, e:
r = mforms.Utilities.show_warning("Log Refresh", "An error occurred while displaying MySQL server logs: %s" % e, "Ignore", "Cancel", "")
if r == mforms.ResultCancel:
self.disable_log_refresh = True
def detect_paths(self):
# Retrieve from server the log file paths if exist
status = self.ctrl_be.is_server_running(verbose=0)
if status in ['stopped', 'unknown'] and not all(
[ self.server_profile.general_log_file_path, # only proceed to parse the config file if
self.server_profile.slow_log_file_path, # any of these is missing
self.server_profile.error_log_file_path,
self.server_profile.log_output ] ):
cfg_be = wb_admin_config_file_be.WbAdminConfigFileBE(self.server_profile, self.ctrl_be)
cfg_be.open_configuration_file(self.server_profile.config_file_path, warn_missing=False)
options = dict(cfg_be.get_options(self.server_profile.config_file_section))
if not self.server_profile.log_output and options.has_key('log-output'):
self.server_profile.log_ouput = options['log-output']
if not self.server_profile.general_log_file_path:
path = options['general_log_file'] if options.has_key('general_log_file') else (
options['log'] if options.has_key('log') else '') # the 'log' option is deprecated but still allowed
if path:
self.server_profile.general_log_file_path = path.strip('"')
if not self.server_profile.slow_log_file_path:
path = options['slow_query_log_file'] if options.has_key('slow_query_log_file') else (
options['log-slow-queries'] if options.has_key('log-slow-queries') else '') # the 'log-slow-queries' option is deprecated but still allowed
if path:
self.server_profile.slow_log_file_path = path.strip('"')
if not self.server_profile.error_log_file_path and options.has_key('log-error'):
self.server_profile.error_log_file_path = options['log-error'].strip('"')
def refresh(self):
if self.disable_log_refresh:
return
if self.ctrl_be.is_sql_connected():
if self.general_log_tab:
self.general_log_tab.refresh()
if self.slow_log_tab:
self.slow_log_tab.refresh()
if self.general_file_log_tab:
self.general_file_log_tab.refresh()
if self.slow_file_log_tab:
self.slow_file_log_tab.refresh()
if self.error_file_log_tab:
self.error_file_log_tab.refresh()
def do_refresh(self):
pass
|