Xׯd , d Z ddlZddlmZmZmZmZmZ ddlZddlm Z m
Z
m Z m Z m
Z
ddlZddlmZmZmZmZmZmZ ddlmZ ddlmZmZ ddlm Z m Z m Z m Z m Z G d d
ej! Z" G d d e" Z# G d
de Z$ G d de Z%dS )a
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.
N)newBoxnewLabel newTreeView
newTabView newButton)GeneralQueryLogReaderSlowQueryLogReaderGeneralLogFileReaderSlowLogFileReaderErrorLogFileReader)LogFileAccessError
ServerIOErrorOperationCancelledErrorInvalidPasswordErrorlog_error_decorator
to_unicode)WorkerThreadHelper) log_error log_debug)WbAdminTabBaseWbAdminValidationConfigFileWbAdminValidationConnectionWbAdminValidationBase WbAdminValidationRemoteAccessc e Zd ZdZ fdZed Zd Zd Zd Z d Z
d Z d Z d
Z
dd Zd
Zd Zd Zd Zd Zd Z xZS )LogViewz|
Main front end view class for displaying log entries.
Each page in the Tab View is an instance of this class.
c N t t | d | | || _ || _ || _ d| _ d| _ d| _
d| _ d| _ |
d| _ dS )z
The arguments following BackendLogReaderClass will be passed to
BackendLogReaderClass to instantiate it in order to get a log
reader object.
FN)superr __init__ set_managedset_release_on_addownerBackendLogReaderClassargs
log_reader error_boxtreebbox warning_box update_uiworkerselfr" r# r$ __class__s ..\modules\wb_admin_logs.pyr zLogView.__init__ s gt %%e,,, !!!
%:" c | j r!| | j d | _ t d | _ | j d t t | }| j |dd t }| d | j |dd | | j
| | j dd d S )NT Fz Try again) r& remover set_spacingr straddr set_textadd_clicked_callback try_again)r- error error_labeltry_again_buttons r/ _show_errorzLogView._show_error s > " KK ' ' ' !DN ""1%%% s5zz** ;t444$;;!!+... +UD999--dn=== -----r0 c V | | d S N)r* refreshr- s r/ r9 zLogView.try_again s# r0 c d S r? rA s r/ create_filter_boxzLogView.create_filter_box r0 c X | j r!| | j d | _ | j r!| | j d | _ | j r!| | j d | _ | j r!| | j d | _ | d | d | }|r@| r| | | |dd | j
| j | _ n\# t $ rO}dd l}t d|d| d | d|z Y d }~d S d }~ww xY w| j j rt' d | _ | j d t) | j j }| j |dd | | j dd t+ t, j | _ | j t, j | j j D ]5}| j t, j |d |d d 6| j | | j dd t- j }| d | d |! d |" d
| t) d ddddt, j# | j j$ rd| j j$ j% d k r0d
| _& tO j( | j) t) d }n.t) | j j$ j% }nt) d }|* t, j+ | |dd
ddt, j, t, j# z t, j- z | t) d d
dddt, j, t, j# z t) | j j$ rdnd | _. | j. * t, j+ | | j. dd ddt, j, t, j# z t, j- z | t) d dddd
t, j, t, j# z t) d | _/ | j/ * t, j+ | | j/ dd
dd
t, j, t, j# z | |dd t' d | _ | j d | 0 | j dd t- j1 | _2 | j2 3 d| j4 dd | j2 3 d| j5 dd | j 6 | j2 | j t) d dd to | _8 | j8 9 d | j | j8 dd | j8 : | j; to | _< | j< 9 d | j | j< dd | j< : | j= to | _> | j> 9 d | j | j> dd | j> : | j? to | _@ | j@ 9 d | j | j@ dd | j@ : | jA to | _B | jB 9 d | j | jB dd | jB : | jC | j j$ r8| j j$ j% d k r%d| _D tO jE d| j& d S d S d S ) Nr2 FTr z Exception creating log reader:
z Error creating log reader: %s
zLog File Location:stderra zWindows Event viewerTABLEzLog File Size: z
retrieving...-zShowing:zretrieving data...zCopy Rowz Copy Recordz Copy Details Oldestz< Previous Pagez Next Page >z Most RecentRefresh)Fr& r3 r' r( r) set_paddingr4 rD
get_parentr6 r# r$ r% Exception tracebackr
format_excr= partial_supportr r r mforms TreeFlatListset_selection_modeTreeSelectMultiple column_specs
add_columnStringColumnType end_columnsnewTableset_row_spacingset_column_spacingset_column_count
set_row_count HFillFlaglog_filepathquerygrtsetEventlogCallback printResults set_style BoldStyle VFillFlag HExpandFlag
size_label range_labeladd_endnewContextMenu_menuadd_item_with_title copy_record copy_detailsset_context_menur
bof_buttonr7 r8 go_bof back_buttongo_back next_buttongo_next
eof_buttongo_eofrefresh_buttonr@ actual_positiongetEventLogEntry)r-
filter_boxr: rU
warning_labelcolspectablelabels r/ r* zLogView.update_ui s > " KK ' ' ' !DN 9 KK " " " DI 9 KK " " " DI $ KK( ) ) ) #D ++--
.$$&&
( J''' HHZ - - - 8d 8$) DDOO I555)J^J^J`J`J`J`a b b b > F G G G FFFFF ? * 4 %d||D ( ( + + + $T_%D E EM t < < < HHT%ud 3 3 3 344 $$V%>???3 ( (G I !8!(!(!&
(
(
(
(
D$'''!!
a
###
q!!!
A
(/00!Q1f>NOOO ? #
&',88 8
'(9::: !788 !9!>?? W%%E
()))
%Aq!V%5f6F%FvGY%YZZZ
(+,,aAq&:J6K[:[\\\"do6N#W??TWXX !!&"2333
$/1aAv/?@P/PQWQc/cddd
(:&&1aF4DVEU4UVVV#$899 ""6#3444
$"Aq!Q0@AQ0QRRR t$$$4LL a TYt,,,*,,
&&z43C]Tabbb
&&~t7H.Zhiii ""4:...
hrllD$///#++ ***
doud333 ,,T[999$;; !!"3444
d&t444 --dl;;;$;; !!-000
d&t444 --dl;;;#++ ///
doud333 ,,T[999 'kk $$Y///
d)5$777 00 >>> ? # 0(@(E(Q(Q#$D DJ / / / / / 0 0(Q(Qs "D7 7
FAF Fc $ | j dz | _ | j }| j t | j t
| j j D ]!\ }}| ||| "d S )NrH )
r r' add_noderp r7 r5 enumerater% column_keys
set_string)r- textr$ rowidxkeys r/ rk zLogView.printResultsm s # 3a 7 i "" T%9!:!:;;;!$/"=>> + +HC NN3S * * * * + +r0 c J || j d S r? )r% current)r- outs r/ read_data_workerzLogView.read_data_workert s& DO # # % %&&&&&r0 c t |t r/t j dd|z ddd d | _ d S | | d | _ d S )NzError Reading Log Filez%sOKrO )
isinstancerT rX Utilities
show_errorr+ update)r- datas r/ handle_worker_datazLogView.handle_worker_dataw sk dI & & ' '(@(,t T2r
C
C
C DK F D r0 c | j r| j | j s| j d | j d | j d | j d | j d t | j
| j | _ | j d d S d S d S )NFrH )
r% r@ r+ ry set_enabledr{ r r} r r r r startrA s r/ r@ zLogView.refresh s ? % O # # % % %;
%++E222 ,,U333++E222 ,,U333#//666 11FH_ ` ` !!!$$$$$ % %
%
%r0 Nc | j r| j j r| j j j dk rt j | j | j | j d | j d | j
d | j d | j
d| j z d S | j |D ]X}| j }t# | D ]-\ }}| || .Y| j
| j | j
| j | j | j | j | j | j | j | j
| j | j d d S # t4 t6 t8 t: t< t> t@ f$ r }| ! | Y d }~d S d }~ww xY wd S )NrK FzRecords read: %dT)"r% rf rg ri r r rh ry r r{ r r} rq r7 r' clearr r r strip
range_textrp size_text has_previoushas_nextr r RuntimeErrorr
r r IOError
ValueErrorr= )r- recordsrecr r colr: s r/ r zLogView.update s ? ('
DO,D,IX,U,U$T%94:FFF++E222 ,,U333++E222 ,,U333 ))*z'LogView.copy_record.. s FFFA1Q4FFFr0 rG ) r' r r r% r\ rangelenr r rX r r )r- r r r recordis r/ rv zLogView.copy_record s I++-- FF )EFFFGGH + +DF3t ;<<==
2
2
dooa 0 01111 KK &)) * * * * A / / $ @ @ @ @ @ A Ar0 c | | j d S # t t t
t t t t f$ r }|
| Y d }~d S d }~ww xY wr? ) r r% firstr r r
r r r r r= r- r: s r/ rz zLogView.go_bof s $ KK--// 0 0 0 0 0 |-?AXZnpw zD E $ $ $ U # # # # # # # # # $ ,0 /A? A::A?c | | j d S # t t t
t t t t f$ r }|
| Y d }~d S d }~ww xY wr? ) r r% lastr r r
r r r r r= r s r/ r zLogView.go_eof s $ KK,,.. / / / / / |-?AXZnpw zD E $ $ $ U # # # # # # # # # $r c > | j r| j nd }| | d S # t t
t t t t t f$ r }| | Y d }~d S d }~ww xY wr? ) r% r previousr r r r
r r r r r= r- r r: s r/ r| zLogView.go_back s $48O4P4P4R4R\do..000X\G KK |-?AXZnpw zD E $ $ $ U # # # # # # # # # $s A A
/B <BB c 4 | j rt | j nd }| | d S # t t
t t t t t f$ r }| | Y d }~d S d }~ww xY wr? ) r% r nextr r r r
r r r r r= r s r/ r~ zLogView.go_next s $/3/G/G/I/ISd4?+++tG KK |-?AXZnpw zD E $ $ $ U # # # # # # # # # $s AA /B7BBr? )__name__
__module__ __qualname____doc__r r r= r9 rD r* rk r r r@ r rw rv rz r r| r~
__classcell__r. s @r/ r r s?
0 . . .
{0 {0 {0z+ + +' ' ' % % % ( ( ( (4A A A A A A$ $ $ $ $ $ $ $ $$ $ $ $ $ $ $r0 r c < e Zd Z fdZd Zd Zd Zd fd Z xZS )LogViewGenericc i | _ t j d | _ d| _ t t | j ||g|R d S )NTrO ) filter_listrX r r filter_textr r r r, s r/ r zLogViewGeneric.__init__ sR --- ,nd##,U4IQDQQQQQQr0 c t j d }| | | | j || j |< | j |dd d S )NrH FT)rX newRadioButtonr7 r8 filter_handlerr r r6 r- r filters r/ add_filter_optionz LogViewGeneric.add_filter_option sh &q)) ##D$7888!' FE400000r0 c | d | d t j j j j dk s| d | j S )NAllInnoDB CommunityFirewall)r ri rootwbinfoeditionr rA s r/ rD z LogViewGeneric.create_filter_box s[ u%%% x(((x{ ';66 " ": . . . r0 c | j D ] \ }}| r|| _ !| d S r? )r items
get_activer r@ r s r/ r z LogViewGeneric.filter_handler sR , 2 2 4 4 ( (LD& ""
(#' r0 Nc \ d }|r~g }|D ]y}t |d }| j dk sB| | j dk r| | zt t | | d S )NrM r r )r r lowerfindr r r r )r- r filtered_recordsr r r. s r/ r zLogViewGeneric.update s 4 ! !
4
4!&),,#u,,
0A0A$BRBXBXBZBZ0[0[_`0`0`$++F333
nd##**+;<<<<.open_remote_fileN s 0000 )"&,"2"="="?"?C / /0CEVEfEfgkgzE{E{ | | | " 0 0A 5 5 # # #'4 ( ) ) ) %&G N N N#(55)s BB B98B9 general_logslow_log stored_general_log_source_choice stored_slow_log_source_choice)r is_sql_connectedtarget_version#is_supported_mysql_version_at_least
exec_querynextRow stringByNamer r r r. r
admin_enabledgetattrgeneral_log_file_pathis_localr$ r) slow_log_file_pathr* )r- destresultr& s ` r/ get_log_destinationz WbAdminLogs.get_log_destination8 s < ( ( * * C V<.RRSTUVWXYY B
V !\ 4 45P Q QF!>>++ $ # $ KKK:@:M:Mg:V:VX\:\:\bh"-T^5L5L5LdN`NkNkNklnnnn !\ 4 45W X XF!>>++ $ # $ KKK060C0CG0L0L"-T / :::w$J\Jg?g?g ) ) ) ) ) -; $.5]++2Z(!T^=T=T=TVZVZVZ"[]]] # #4)KTRR T -C : >RVRdRm !nT%7%M N N N tD tD EI EW Em tn tn6<] 3 3 >6=] 3 3 329D /@D]@S==.2.S]+"4)H$OO N -@ 7 ;OSOaOj !hT%7%J K K K qA qA BF BT Bg qh qh39Z 0 0 ;3:Z 0 0 0/6D ,=A*=M::+/+MZ(T^5L5L5LdddSUUU s0 /A1 1A7
/C> >D ?G G'%?I% %I.c | j | | j d | j d d S )NTF)warningr7 showr )r- msgs r/ show_message_panelz WbAdminLogs.show_message_panel sJ c""" $ % r0 c X d|v rt | ddgz }d|v rt | ddgz }d|v r-| j r&| j | j d | _ d|v r-| j r&| j | j d | _ d|v r-| j r&| j | j d | _ d|v r-| j r&| j | j d | _ d|v r/| j r*| j | j d | _ d S d S d S )NrL general_tabslow_tabr general_file_tab
slow_file_taberror_file_tab)listr r remove_pager r r r r- sources r/ _remove_tabszWbAdminLogs._remove_tabs s[ f &\\]J$??F V &\\%7 $IIF F " "t'; " L $ $T%9 : : :#'D D$5 L $ $T%6 7 7 7 #D ' 'D,E ' L $ $T%> ? ? ?(,D % f $ $)? $ L $ $T%; < < <%)D " v % %$*A % L $ $T%< = = =&*D # # # & % % %r0 c d|v rt | ddgz }d|v rt | ddgz }d|v r| j j r| j s t | t
| j | j j | _ | j | j d n9# t $ r, |
d | j j z d | _ Y nw xY wd|v r| j j r| j j r| j
s t | t | j | j j | _
| j | j
d
n9# t $ r, |
d | j j z d | _
Y nw xY wd|v r| j j r| j j r| j s t | t& | j | j j | _ | j | j d n9# t $ r, |
d | j j z d | _ Y nw xY wd|v rS| j j rG| j s@t | t* | j | _ | j | j d
d|v rU| j j rK| j sFt | t. | j | _ | j | j d d S d S d S d S )NrL r? r@ r rA rB rC zError Log FilezYThere was a problem reading %s. Please verify that you have read permissions on that filezGeneral Log FilezYThere was a problem reading %s.
Please verify that you have read permissions on that filez
Slow Log FilezGeneral Log TablezSlow Query Log Table)rD r error_log_file_pathr r r r r add_pager r= general_log_enabledr3 r r r
slow_log_enabledr5 r r r r r r rF s r/ _add_tabszWbAdminLogs._add_tabs s f &\\]J$??F V &\\%7 $IIF v % %$*<*P %Y]Yp %
/*8?QSWS_aeas bH +I +I' %%d&=?OPPPP
/
/
/'' )D GK GY Gm )m n n n*.'''
/ ' 'D,>,R 'W[WiW ' IM Ib '
1,3D:NPTP\^b^p _G -H -H) %%d&?ASTTTT
1
1
1'' )E HL HZ Hp )p q q q,0)))
1
f $ $);)L $QUQcQv $ @D @V $
.)07H$,X\XjX})~)~& %%d& >3E43E4A G' '3H H c | }| d | j j s d| j _ d| j j v r| dd nL| j j dk r,| d | d n| j j dk r+| d | d n| j j dk s| j j dk rt g d }g }| j sdd g}nF| |d
dk rdnd | |d dk rd nd
| j t |t | z
| j t | | j
d | d S # t $ rN}t j dd|z ddd }|t j k r
d| _ Y d }~d S Y d }~d S d }~ww xY w)NrC r r rL r r )r? r@ rA rB rA rB r' r? r( r@ Tz Log Refreshz8An error occurred while displaying MySQL server logs: %sIgnoreCancelrO )r8 rN r r rH setr r+ r tupler r; r@ rT rX r show_warning ResultCancelr
)r- r6 tabs to_be_addeder s r/ r* zWbAdminLogs.update_ui s '')) '(((!, 9,8D ) T'2 2 2 gv . . . .
*f
4
4 g & & & NN6 " " " "
*g
5
5 f % % % NN7 # # # #
*l
:
:d>P>[_k>k>kWWWXXD K<0022
b 1? C ""m9LPV9V9V#5#5\ijjj""d:6F&6P6P??V`aaa D dS-=-=&= > > @ @ DNU; / / 1 1 $ 0 LLNNNNN 0 0 0 --m=wz{={ ~F HP RT U UAF'''+/((((((( (''''' 0s G% %
H=/=H88H=c p | j d }|dv rt | j j | j j | j j | j j g sUt j | j | j }|
| j j d t |
| j j }| j j sd|v r|d | j _ | j j s;d|v r|d n
d|v r|d nd }|r | d
| j _ | j j s;d |v r|d n
d |v r|d nd }|r | d
| j _ | j j s/d
|v r-|d
d
| j _ d S d S d S d S d S )Nr )verbose)stoppedunknownF) warn_missingz
log-outputgeneral_log_filelogrO "slow_query_log_filezlog-slow-queriesz log-error)r is_server_runningallr r3 r5 rJ r wb_admin_config_file_beWbAdminConfigFileBEopen_configuration_fileconfig_file_pathdict get_optionsconfig_file_section log_ouputr )r- statuscfg_beoptionsrg s r/ r zWbAdminLogs.detect_paths s ///:: + + +C$:$7$8$/254 54 + -@ASUYUabbF * *4+=+N]b * c c c6--d.@.TUUVVG%0
E\W5L5L/6|/D",%;
O6HG6S6Sw 122).')9)9wu~~r O?Czz#D&<%8
L9NRY9Y9Yw 4556HG6S6Sw 122Y[ L<@JJsOOD&9%9
YkW>T>T9@9M9S9STW9X9X"6665 , + + +2
Y
Y>T>Tr0 c | j rd S | j r@| j r| j | j r| j | j r| j | j r| j | j r| j d S d S r? ) r
r r+ r r@ r r r r rA s r/ r@ zWbAdminLogs.refresh s # F < ( ( * * ,#
/$,,...
,!))+++ $ 0 % - - / / / ! - " * * , , , " . # + + - - - - - . .r0 c d S r? rC rA s r/
do_refreshzWbAdminLogs.do_refresh rE r0 N)r r r
ui_created classmethodr r r r r r8 r= rH rN r* r r@ rq rC r0 r/ r r
s JY Y [Y # # [#' ' '
[ [ [
F F FP! ! !
+ + +.&M &M &MP%0 %0 %0N Y Y Y@
.
.
.
r0 r )&r ri rX r r r r r
wb_log_readerr r r
r r rd wb_commonr
r r r r r workbench.utilsr
workbench.logr r wb_admin_utilsr r r r r Boxr r r r rC r0 r/ rz s_ ,V Vp
G G G G G G G G G G G G G G
A A A A A A A A A A A A A A H H H H H H H H H H H H H H H H . . . . . . . . . . . . . . Z Z Z Z Z Z Z Z Z Z Z Z Z ZW$ W$ W$ W$ W$fj W$ W$ W$t'= '= '= '= '=W '= '= '=T
o
o
o
o
o%:
o
o
oN
N
N
N
N
. N
N
N
N
N
r0