EXT: Developer Log - SVN
Contents
1. be stripped and replaced by an error message see screenshot below A word of caution if you store a lot of stuff in the dataVar and also if you call the deviog very frequently you may end up with a very large tx_devlog table in your database Check it out regularly and don t hesitate to use the clean up features described below as well as the configuration options outlined above Furthermore if the extra data is too large see Configuration above it will be stripped This is done to avoid crashing the database when actually writing the log entry to it It is replaced by a message as in the following screenshot Developer Log Select Log all entries rs Refresh LOG ENTRIES Log period 26 03 09 15 24 0 min Auto refresh Expand all extra data Search log data Search Clear search Clear all filters Entries 0 30 Date 2 Severity 2 Extension Message Called from 2 Page 2 User 2 Extra data test 26 03 09 15 24 46 test No extra data index php line 200 7 cobweb 26 03 09 15 24 46 Li test Object dump index php line 199 m cobweb The extra data was not an array It was not stored 26 03 09 15 24 46 fil test Big array Gump index php line 198 F cobweb The extra data exceeded the maximum size It was not stored More about severity levels It may not always be easy to choose a severity level The descriptions below go into a bit more detail and will hopefully2. older than a given period of time Alternately you can simply decide to trash them all When the clean up is done you get informed on how many entries were deleted Clean up y CLEAR LOG Use any of the clean up options below to clear your developer log There are currently 363 log entries in the Developer Log Delete all log entries for extension Clear Log Delete all log entries that are older than 1hour yj Clear Log Pressing the button below will actually delete ALL log entries Make sure that this is really what you want to do Clear All Entries 11 TY P03 v EXT Developer Log devlog To Do list To Do list Here are some of the ideas I have in mind Feel free to suggest more Or even better contact me to participate see Participating above Change module initialisation to use the framework introduced in TYPO3 4 1 Adda TYPO3 4 2 style doc header e Use PHP 5 feature in microtime to get more reliable values into the crmsec field 12 TY PO 3 v EXT Developer Log devlog Changelog Changelog DevLog was released at version 2 0 0 to show that it was taking over from cc_devlog Since no changelog was kept by Ren Fritz it starts with the first release of deviog Version Changes 2 9 2 Added security fix against potential XSS attacks 2 9 0 Added option for optimizing devlog table Switched default database engine of devlog table to InnoDB 2 8 0 Added option for limiting the
3. options e Clear up logs selectively Credits Obviously credits are due to Ren Fritz who developed the original cc_devlog extension I dearly wanted to just contribute or take over the development but given the apparent impossibility of getting ownership of the extension key I finally decided to fork it Many people contributed some code and ideas to this new version see Changelog Some of the icons used in this extension come from the Silk Icons library http www famfamfam com lab icon silk a beautiful set of icons developed under the Creative Commons license by Mark James of Birmingham UK Screenshot Here is a view of what you get in the backend module Developer Log Select Log all entries A 9 Aito retveshs Show Log Z a Refresh Expand all extra data LOG ENTRIES Log period 13 02 09 10 25 16 days 22 02 09 22 26 7 days Search log data Search Clear search Clear all filters Entries 0 30 30 60 60 90 90 120 120 150 150 180 180 210 210 240 240 270 270 300 300 330 330 360 360 390 390 420 420 450 450 480 480 510 510 540 540 570 570 600 600 630 630 660 660 690 690 720 720 750 750 780 780 810 810 840 840 870 870 900 900 930 22 02 09 22 26 45 va sv User setup class tx_sv_authbase php line 161 Eg 22 02 09 22 20 35 n sv User setup class tx_sv_authbase php line 161 fl 22 02 09 22 20 25 we sv User setup class tx_sv_authbase php line 161 E 22 02 09 22 19 49 va sv User setup class
4. size of the extra data Added options categorisation visible only with TYPO3 4 3 Caught condition of unitialised DB object Caught error when extra data is not an array 2 7 0 Improved view of single records in Web gt List view thanks to Fabien Udriot Added button for clearing all filters Added warning in BE module about filtered keys Added CSH to single records view and BE module thanks to Steffen Muller Changed BE module table layout Changed order of records in Web gt List view to have most recent on top thanks to Steffen Muller 2 6 0 Added option for limiting the size of the log table Added option for minimum level of severity for logging Added option for filtering extension keys Added option for configuring autorefresh frequency Optimized hook usage by making it a pseudo singleton 2 5 0 Added page and user filter Restored link to page feature was broken Corrected behaviour of log run browser Added handling of GLOBALS TYPO3_CONF_VARS SC_OPTIONS GLOBAL debugData pid Partial refactoring 2 4 0 Added log search feature 2 3 3 Simplified handling of extra data 2 3 2 Caught error when extension is not configured 2 3 1 Corrected HTML markup error in BE module 2 3 0 Automatically retrieve and store devLog call location thanks to Kasper Ligaard 2 2 0 Added various selection options for cleaning up log entries Removed htmlspecialchars call on log message suggested by Ing
5. tx_sv_authbase php line 161 Eg 22 02 09 22 18 08 av sv User setup class tx_sv_authbase php line 161 22 02 09 22 18 08 x fimidap init LDAP servers no responded class tx_fimidap_sv1 php line 96 Eg 22 02 09 22 18 08 x fimidap LDAPconnectionOpen LDAP socket connection failed class tx_fimldap_sv1 php line 579 22 02 09 22 18 08 i fimidap init LDAP configuration found class tx_fimldap_sv1 php line 78 29 22 02 09 22 18 08 a fimidap init PHP LDAP extension installed class tx_fimidap_sv1 php line 64 SSeS ESON EERIE ane at Questions and support If you have any questions about this extension please ask them in the TYPO3 English mailing list typo3 english so that others can benefit from the answers Please use the bug tracker on forge typo3 org to report problem or suggest features http forge typo3 org projects extension devlog issues Keeping the developer happy If you like this extension do not hesitate to rate it Go the Extension Repository search for this extension click on its title to go to the details view then click on the Ratings tab and vote you need to be logged in Every new vote keeps the developer ticking So just do it TY PO 3 v EXT Developer Log devlog Introduction Participating The devlog is an interesting tool for all TYPO3 developers and as such I am very open to collaborating with others to continue improving this extension If you are interested go to forge typo3 org and app
6. 51 19 days 22 02 09 22 26 7 days Search log data password Search Clear search Clear all filters Entries 0 30 30 60 60 90 90 120 Dae a 22 02 09 22 26 45 of sv User setup ee ND be_users pid 0 AND be_users cisable 0 AND lbe_users deleted 0 AND be_users starttime lt 1235338005 ND be_users endtime 0 OR lbe_users endtime gt 1235338005 22 02 09 22 20 35 vV sv User setup Gnas br av_authbas php a Additionally when viewing a single log run you get a log run browser 1 to move to the latest next previous or oldest log run available Developer Log Select Log 13 02 09 20 55 17 days b Refresh B Expand all extra data LOG ENTRIES Log period 13 02 09 20 55 17 days lt lt oldest lt previous EJ next gt latest gt gt 13 02 09 20 55 57 _fimlidap init PHP LDAP extension installed class tx_fimidap_sv1 php line 64 13 02 09 20 55 57 G fimidap init LDAP configuration found class tx_fimidap_sv1 php line 78 13 02 09 20 55 57 x fimidap LDAPconnectionOpen LDAP socket connection failed class tx_fimidap_sv1 php line 579 13 02 09 20 55 57 x fimidap init LDAP servers no responded class tx_fimidap_sv1 php line 96 gt lt lt oldest lt previous next gt latest gt gt 10 TYPO3 v EXT Developer Log devlog User manual Cleaning up This screen allows to delete log entries which can quickly accumulate You can choose to clear entries for a given extension or if they are
7. 80 480 510 510 540 540 570 570 600 600 630 630 660 660 690 690 720 720 750 780 780 810 810 840 840 870 Date C Severity Extension Message Called from Page User Extra data 4 11 02 09 12 51 19 ox fim_alfresco Successful publish operation class tx_fimalfresco_damconnector php line 394 Fmedia eh fe 11 02 09 12 51 19 aaf fim_alfresco SQL for update class tx_fimalfresco_damconnector php line 337 PDmedia cobweb gt 11 02 09 12 51 19 Warning fim_alfresco Information for update class tx_fimalfresco_damconnector php line 336 Dmedia I E Error rS o 0 34 11 02 09 12 51 19 ia fim_alfresco Categories class tx_fimalfresco_damconnector php line 330 media Pacobweb 1 94 2 44 3 33 11 02 09 12 51 19 ti fim_alfresco FE groups class tx_fimalfresco_damconnector php line 575 Dmedia 11 02 09 12 51 19 fim_alfresco LDAP groups class tx_fimalfresco_damconnector php line 543 Fmedia r ERN 11 02 09 12 51 19 i fim_alfresco Public document received class tx_fimalfresco_Gamconnector php line 536 Byredia fcobweb 11 02 09 12 51 19 A fimidap LDAPconnectionOpen LDAP bind succeded class tx_fimidap_sv1 php line 568 Dmedia dhaobweb Ea m TYPO3 Y EXT Developer Log devlog User manual In the results of a search the keywords are highlighted making them easier to spot Developer Log Select Log allentries 8 O auto refresh Show tog E8 Eg Refresh O Expand all extra data LOG ENTRIES Log period 11 02 09 12
8. 9 VIEWING the lOG CNIS c ccscececieneceeesestenctenaveeneene 10 CICANING UP sscriesesizsnetcenetasssdeccsecstndaatzsade otadezassaessde 12 TO DO JiSt ccsseseeceeeeeeeeeeeeeeeenaeaseceeeeeeeeeeeasenenannaeans 13 Changelog 1 scscceeeeeeeeeeeeenenseeeseeeeeeeeeeeeeeenanaaenes 14 TYPO3 v EXT Developer Log devlog Introduction Introduction Developer log This should be implemented around the source code both frontend and backend logging everything from the flow through an application messages results from comparisons to fatal errors The result is meant to make sense to developers during development or debugging of a site quoted by Ren Fritz source unknown TYPO3 provides a functionality for logging information for the purposes of development and debugging via the static method t3lib div devLog However this method does not do anything by itself It simply provides a hook for registering whatever logging method you wish The Developer Log provides such a method Information is stored in a database table and can be browsed using a backend module This extension provides the following features e Log entries are logged in log sessions one log session per script run That makes it easy to separate log runs e Frontend logging includes the page id e Backend module can be opened in a separate window and set to refresh automatically Show log runs latest entries or all entries with filtering searching and paginating
9. TYPO3 v EXT Developer Log devlog EXT Developer Log EXT Developer Log Extension Key devlog Language en Keywords forAdmins forDevelopers forIntermediates Copyright 2000 2008 Francois Suter lt typo3 cobweb ch gt This document is published under the Open Content License available from http www opencontent org opl shtml The content of this document is related to TYPO3 a GNU GPL CMS Framework available from www typo3 org TYPO3 v EXT Developer Log devlog Table of Contents EXT Developer LOG lt isinsasawavmnnndussnnennsavanadacnat 1 Introduction sssssssssnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnna 3 Credits ernia AEO 3 Sereen Shot secaii ec couveruanieundeccinsequnpedaceeetaaverunendunace cnt 3 QUESTIONS and SUPPOME saved ciessateicadenecetecnedesusesecsaaasas 3 Keeping the developer happy seeeteeeeeeeeeeeee 3 Participating issiria ots 4 Trnstallation scscccceceeeeeeeeeeeeeeeeeseeeeeeeeeeeeeeeeneeaaeneees 5 Switching from CC CeOVIOG sccicisiecscicits ccenestecsdiazececrans 5 COMPQURAUI OM sessiun duiiin easain igana 5 EXT Developer Log Developer Manual sssssssssssnnsnnnnnnnnnnnnnnnnnnnnnnnnnnnnna 6 Using the logging Method vswsseeissciicstreweriwsednneceind 6 Extra INFOMMAU OM ossessi nonnen aenean aias 7 User Manual sssssssssssssnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnn nnmnnn 8 Viewing a singl CNIY cccccccssseteececeneecenssennesecneensens 8 The BE modulEissnessa riesaa
10. anual below e Minimum level for logging log entries come with a severity that can have the following values 1 for ok 0 for an information 1 for a notice 2 for a warning and 3 for an error With this setting you can define from which level you want to start logging entries All entries with a severity below that setting will be ignored e Excluding keys every log entry normally comes with a key This is generally an extension key or some other key in the case of Core scripts often the name of the calling class This parameter allows you to define a list comma separated of keys that you don t want to log This will help keep your log table smaller A typical example could be realurl t3lib userAuth as both scripts output a lot of log messages e Highlight style when a search is performed the search for string is highlighted in the BE module You can customise this highlighting style with this configuration option Make sure to use only valid CSS properties as the value of this option is included as is inside a style attribute e Autorefresh frequency it is possible to tell the BE module to refresh itself automatically This setting makes it possible to define at which frequency in seconds e Path to Prototype for TYPO3 4 0 or less the path to the Prototype script as described above e Automatic clean up if this is activated the backend module will automatically delete any log entries that are in excess o
11. d in other contexts in particular the BE There s a way to pass a page id to the devlog but you need to set it yourself in the global variable TYPO3_ CONF _VARS SC_OPTIONS GLOBAL debugData pid If defined this variable will be taken into account by the devlog since version 2 5 0 TYPO3 Y EXT Developer Log devlog User manual User manual Log records can be viewed individually as described below While this can sometimes be useful it is generally more convenient to use the BE module provided by the extension Viewing a single entry Log records are stored in the page where the call happened or at the root of the TYPO3 installation if the call didn t happen within the context of a page Those records can be seen in the Web gt List view Records are ordered with the most recent on op pr Developer Log 26 Message Ref w init PHP LDAP extension installed 2 T E w init LDAP configuration found 2 T H w LDAPconnectionOpen LDAP socket connect 2 T E w LDAPconnectionOpen LDAP bind succeded 2 T yx w LDAPconnectionClose LDAP connection cl 2 B T qs ww init LDAP connection successed 2 8 T E getUser Login data 2 T ys w LDAPconnectionOpen LDAP socket connect 2 B T E w LDAPconnectionOpen LDAP bind succeded 2 B T Hs E faetUser Username not found in LDAP 2 AA m rH Clicking on the Edit icon will open a read only view of the record displaying all relevant i
12. f the maximum number of log runs defined above This is convenient to make sure that your log table does not get out of hand No clean up takes place if the maximum number of log runs is 0 Note the new parameter Maximum number of rows is much more convenient for limiting the size of the database table as it happens at the time of logging and not when the BE module is accessed You should use this new parameter The automatic clean up feature will probably be dropped in the future TYPO3 v EXT Developer Log devlog Developer manual Developer manual Using the logging method To log something simply call t3lib div devLog This method takes the following parameters Parameter Information msg The message that you want to write to the log extKey The key of the extension writing to the log severity Indication of the severity of the message The following values are expected e 1 for ok status 0 for a purely informational message e 1 fora notice e 2 for a warning e 3 for a fatal error This parameter is optional and defaults to 0 dataVar This is an array that can contain any data you wish and that you find useful for information or debugging purposes It is serialised before being stored in the database In the backend module it is unserialised and displayed as with t3lib div debug This parameter is optional and defaults to false If something else than an array is passed to this parameter it will
13. l entries on a single screen This parameter defines the number of log entries to display per page e Maximum number of rows this parameter will put an absolute limit on the number of log entries that are stored in the database When that limit is reached 10 of the oldest entries are deleted to make room for new ones If you don t want any limit set this parameter to zero e Optimize devlog table the database table may see a lot of operations both inserts and deletes After a time some overhead accumulates By selecting this option an optimization is run every time entries are deleted as per the maximum number of rows option above Note however that this operation uses the OPTIMIZE SQL statement which is proprietary of MySQL and and is not compatible with DBAL If you use another database than MySQL you should not activate this option e Maximum size of extra data as is described in Developer manual below any amount of additional information can be stored in a log entry as a PHP array passed to the variable dataVar This so called extra data could become quite large in some situations Writing a very large amount of data to the database may actually crash it To prevent this from happening this setting will limit the size of the extra data once serialised The default value is 1 million characters Any data above this limit will be stripped and replaced by an informational message see screenshot in Developer m
14. low itself offers several more options If some extension keys are filtered automatically see Configuration a reminder is displayed 1 When viewing all entries you get a lot of options First of all you can search the message and the extra data 2 Search words are always used with SQL wildcards at the beginning and at the end When you re done with the search click on the Clear search button Results are paginated 25 entries a page by default see Configuration and you can navigate through them using the page browser 3 What s more various filters 4 are available to select entries based on severity or extension key Filters and search get combined You can also clear all filters 5 By clicking on the date of a log entry 6 you can set a filter to display only the log run this entry belongs to You can also click on the icon to get a view of the deserialised extra data 8 This is displayed inline using JavaScript When the log entry is related to a page you can click on that page 7 and you will be taken to the corresponding Web gt Page view Developer Log Select Log all entries iE O Auto refresh Show Log B i Refresh B Expand all extra data LOG ENTRIES Log period 11 02 09 12 51 19 days 11 02 09 12 51 19 days Search log data A Search Clear search Clear all fiters El Entrigg_0 30 30 60 60 90 90 120 120 150 150 180 180 210 210 240 240 270 270 300 300 330 330 360 360 390 390 420 420 450 450 4
15. ly to become a project member I ll get in touch with you TY PO 3 v EXT Developer Log devlog Installation Installation If you run TYPO3 4 1 or more just download the extension from the TER install it and get rolling If you run TYPO3 4 0 or less you will need to place the Prototype library yourself somewhere on the server and configure the path to it in the extension s configuration You have to give the full path starting from your site root Note that this is necessary only if you want to use the feature for viewing the extra data see User Manual below but it s a useful one Read the paragraph below if you are already using cc_devlog Switching from cc_devlog If you are already using cc_devlog and want to switch to devlog without losing your existing logs you can simply go to your favorite database administration tool and manually rename table tx_ccdevlog to tx_devlog BEFORE installing devlog Obviously you should then remove cc_devlog Configuration A number of parameters can be configured for this extension in the Extension Manager They are described below Maximum number of log runs the backend module always displays a list of log runs to select from As this can get quite long over time this parameter makes it possible to cap the number of log runs displayed If set to 0 all log runs are displayed e Number of entries per page when viewing all log entries a pagination system is activated to avoid displaying al
16. make the choice easier e OK 1 These events indicate that everything went fine no error occurred at least up to that point where the event was created No action needs to be taken Info 0 These events are purely informational They are normally used for debugging purposes only and require no special action e Notice 1 Abnormal condition but not blocking Notices are meant to raise attention Processes have been completed but things are not running as smoothly as they could and the condition should be investigated e Warning 2 These events are used to notify significant problems Processes have been completed but parts of TY PO 3 v EXT Developer Log devlog Developer manual them may be missing wrong or corrupted Warnings should not be ignored and action should definitely be taken Error 3 These events signal that something went fatally wrong Processes were not completed and action is definitely needed Alternately this level may be used to point to a failed event but in a process where failure can be expected e g a login attempt with the wrong password Extra information The devlog extension stores information beyond the parameters passed to the t3lib div devLog method Some of it is automatically retrieved like the id of the currently logged in BE user if any If the devlog call is made in the FE context the page id will also automatically be retrieved from STSFE gt id This variable is not define
17. ned in a new window 4 Developy Log A go Sele tog arenes OE sees or Tt latest log run latest 25 entries LoG ENTR 2test 50 entries latest 100 entries Log period FU Fi iii 02 09 22 26 7 days 22 02 09 22 20 7 days 22 02 09 22 19 7 days p5 Expand all extra data Search log 13 02 09 20 55 16 days Search Clear search Clear ali fiters Entries 0 f 13 02 09 10 25 17 days 150 180 180 210 210 240 240 270 270 300 300 330 330 360 360 390 390 420 420 450 450 480 480 510 510 540 540 570 570 600 600 630 630 660 660 690 690 720 720 750 7 13 02 09 10 25 17 days 870 900 900 930 11 02 09 12 51 19 days 11 02 09 12 51 19 days 22 02 09 11 02 09 12 51 9 daya 11 02 jays 22 02 09 4 11 02 09 12 51 ua days User setup class tx_sv_authbase php line 161 Date 11 02 09 12 51 19 days Bale Message Called from Page User Extra data f User setup class tx_sv_authbase php line 161 22 02 09 j 11 02 09 12 51 19 days User setup class tx_sv_authbase php line 161 E 11 02 09 12 51 19 days 22 02 09 7 11 02 09 12 51 19 days User setup class tx_sv_authbase php line 161 Eg 22 02 09 22 18 08 g sv User setup class tx_sv_authbase php line 161 E 22 02 09 22 18 08 x fimidap init LDAP servers no responded class tx_fimidap_svi php line 96 gt 22 02 09 22 18 08 fimidap LDAPconnectionOpen LDAP socket connection failed class tx_fimldap_svi php line 579 The log view be
18. nformation Developer Log 956998 User setup Run date and time 22 26 22 02 2009 Extension Called from a lt jass tx_sv_authbase php Calling line AND be_users pid 0 AND be_users cisable 0 AND be_users deleted 0 AND be_users starttime lt 1235338005 AND be_users endtime 0 OR be_users endtime gt 1235338005 The BE module The backend module provides a way to visualise all the entries generated by calls to t3lib div devLog ina central place regardless of which page the log entries are related to Furthermore it provides a tool to clean up those entries The function menu 1 gives access to those two main views TYPO3 v EXT Developer Log devlog User manual Developer Log Select Log all entries 2 J Auto refresh Refresh Expand all extra data Viewing the log entries This screen can be used to filter and browse through the log entries Many functions are available First of all you can choose which entries you want to display 1 This can be either the latest log run or any of the older ones but also all entries or some of the latest 25 50 or 100 Checking the Expand all extra data box 3 will force the module to automatically display all the extra data rather than having to expand them one by one The screen to automatically refresh itself 2 which it then does at an interval of 2 seconds In conjunction with this autorefresh feature the screen can be ope
19. o Renner 2 1 0 Added a log run browser in single log run view thanks to Rupert Germann Added a checkbox to automatically expand all extra data thanks to Rupert Germann Added extension configuration options 13 TYPO3 W EXT Developer Log devlog Changelog Version Changes 2 0 0 Increased size of database field for extra data Added the possibility of viewing the deserialised extra data Added the possibility of viewing all entries and paginating through them Added filters on status and extension keys Added display of the crdate column thanks to Stefano Cecere Cleaned up part of the code Totally revamped manual Last version of cc_devlog by Ren Fritz 14
Download Pdf Manuals
Related Search