Jump to content
adrian

Tracy Debugger

Recommended Posts

It's 4 decimals here:

timer('timer A');
$view->package = getPackages(1, 'random')->first();
bd(timer('timer A'));

Result:

"timer A : 0.0047" (16)

I can't use "t" because it's my translate function's name - maybe also a similar name collision is present there?

Btw, in the post above where "timer" was introduced, the bd('first') should be bd(t('first')) if I see it right.

  • Like 1

Share this post


Link to post
Share on other sites
It's 4 decimals here:

Thanks @tpr for the confirmation of decimal places.

I can't use "t" because it's my translate function's name - maybe also a similar name collision is present there?

So am I right in assuming that you unchecked "t" from the Enabled Shortcut Methods setting and it worked as expected?

Of course I could add a TD::t() option, but I feel like I might have already gone overboard here :)

Btw, in the post above where "timer" was introduced, the bd('first') should be bd(t('first')) if I see it right.

Thanks - corrected now!

Share this post


Link to post
Share on other sites

So am I right in assuming that you unchecked "t" from the Enabled Shortcut Methods setting and it worked as expected?

No, everything is checked there. No error was shown because of "!function_exists('t')" in the module.

  • Like 1

Share this post


Link to post
Share on other sites

No, everything is checked there. No error was shown because of "!function_exists('t')" in the module.

Right - it comes down to when your version is initially defined vs the one in this module. When I tested re-defining one of these shortcut methods, it was in a template file, which is after this module, which is why I added the option to disable these as needed.

Share this post


Link to post
Share on other sites

New "Method Info" panel to give a quick rundown of each method and their available aliases/shortcuts:

post-985-0-49902900-1455484178_thumb.png

  • Like 1

Share this post


Link to post
Share on other sites

Of course I could add a TD::t() option, but I feel like I might have already gone overboard here :)

Yeah. Saving a few keystrokes is almost never a worthy trade to code clarity :D

Share this post


Link to post
Share on other sites
t();
sleep(1);
bd(t());

$timer = Debug::timer();
sleep(1);
bd(Debug::timer($timer));

result:

1.0
in ...\site\modules\TracyDebugger\TracyDebugger.module:286
"1.0000" (6)
in ...\site\modules\TracyDebugger\TracyDebugger.module:286

Share this post


Link to post
Share on other sites

Very nice module! For some reason I get an empty list for Database Queries. Is that part supposed to contain something? Or should I enable it somehow?

Share this post


Link to post
Share on other sites

@matjazp - can you please see what happens if you specify different sleep intervals. I am occasionally getting 1.0 etc, but changing the sleep value usually results in something with 4 decimal places.

@Ipa - I expect you might have debug mode turned off. That feature currently needs it turned on, although I'll see if it makes sense (or is possible) to get that to work without it on.

On another note, the current version has a new debug mode badge which I think is a very useful reminder:

post-985-0-90390300-1455555359_thumb.png

Also, I have dealt with the issue of incorrect location reporting when calling the TD:: or shortcut/alias methods, so location reporting is now on by default. I think it's a handy addition. For those of you who are updating, you'll need to set this manually, so check the "Show Location" checkboxes in the module config settings.

post-985-0-58464700-1455556190_thumb.png

This means that there is really no reason to ever call the native Tracy methods, so I have removed that info from the first post and the Github ReadMe.

  • Like 2

Share this post


Link to post
Share on other sites

The difference is because you are returning float using round function, while PW timer is returning string using number_format ...

Share this post


Link to post
Share on other sites

The difference is because you are returning float using round function, while PW timer is returning string using number_format ...

I understand that round() converts a number to a float before rounding, but I don't understand how you are getting a rounded result of: 1.0 for the Tracy timer - what actual value would ever get rounded to 1.0 - it should remove the decimal place completely and leave just: 1 - shouldn't it?

I feel like I am missing the problem here somehow - sorry for being dumb. Do you have any suggestions on how to fix what you are seeing? 

Share this post


Link to post
Share on other sites

A quick update - I have added a row of buttons to various parts of the PW admin at the bottom of the PW panel.

The big news though is that I found out the FireLog() actually works with Chrome too. You just need this browser extension:

https://github.com/MattSkala/chrome-firelogger

https://chrome.google.com/webstore/detail/firelogger-for-chrome/hmagilfopmdjkeomnjpchokglfdfjfeh

This is awesome for debugging AJAX calls.

  • Like 1

Share this post


Link to post
Share on other sites

Maybe:

$roundedTime = number_format(Debugger::timer($name),4);

How about displaying a list of local variables, without PW variables, something like get_defined_vars() but without fuel, wire, classLoader, hooks, config etc.

  • Like 1

Share this post


Link to post
Share on other sites

This looks awesome @adrian, thanks!

I've just a quick glance, could this do breakpoints and step-throughs as well or its more of a logger?

  • Like 1

Share this post


Link to post
Share on other sites

@adrian

First of all, thank you for this wonderful module! I have just found the time to check it out and have a few questions:
 
1)
Is it normal that I have this strange looking layout on the public frontend? (see attached image) It would be nice to have a bar that is only one row tall.
post-4029-0-75411800-1455661528_thumb.pn
 
2)
Show Debug Bar option: a select or two checkboxes please :)
  • Show on public frontend only
  • Show on admin only
  • Show on both
  • Do not show
Currently I am only using it on the public frontend so it is just an obstacle on the admin.
 
3)
email option:
Quote: "Receive emails when an error occurs in production mode." you wrote in the forum, which is a much better description than the one you actually used in the module: "This email address will receive notification of errors."
 
thanks again!
  • Like 1

Share this post


Link to post
Share on other sites

Maybe:

$roundedTime = number_format(Debugger::timer($name),4);

Sorry, I still really don't get the point. Using number_format to round a value with less than 4 decimal places ends up displaying blank/non significant zeros, eg:

echo number_format(0.12, 4)

results in: 0.1200

Why do you want to display the extra zeros? I still don't see why "round" isn't working for you.

How about displaying a list of local variables, without PW variables, something like get_defined_vars() but without fuel, wire, classLoader, hooks, config etc.

I think this is a very useful addition - stay tuned - hopefully coming soon!

This looks awesome @adrian, thanks!

I've just a quick glance, could this do breakpoints and step-throughs as well or its more of a logger?

It doesn't allow for breakpoints and step-throughs. Its features are:

Logging

  • dump() to DOM
  • barDump() to the debugger bar
  • log() to file
  • fireLog() to the console (both Chrome and Firefox)
  • objects and arrays are presented in a fully expandable tree interface

Error reporting

  • Visualization of errors, exceptions, warning, notices etc with a full expandable and linked Call stack, which I find incredibly helpful in isolating the source of the error.
  • Can be to DOM or debugger bar
  • Automatic emailing of errors in production mode

Timing

  • Total execution time
  • Logging of custom calls for sections of code

System Info 

  • Details on php and apache versions
  • Max memory allocation for the page
  • Number of includes files, classes and traits

ProcessWire Information

  • Access to all the info from the Debug Mode Tools on the front-end via the PW panel in the debugger bar
  • Extra sections to the PW panel with details of the current page, its template, the fields of this template
  • Debug Mode indicator - nice reminder/warning in case you forget to turn it off once the site is live
  • Links to various context relevant places in the admin, as well as general admin links

Hope that helps to answer your question. I am looking for feature suggestions, like @matjazp's idea for showing all available variables. I will probably also add functions and classes too. I am also looking to include some other Tracy plugins, like performance monitoring panels.

@adrian

First of all, thank you for this wonderful module! I have just found the time to check it out and have a few questions:

1)

Is it normal that I have this strange looking layout on the public frontend? (see attached image) It would be nice to have a bar that is only one row tall.

attachicon.giftracy-height-2016-02-16.png

2)

Show Debug Bar option: a select or two checkboxes please :)

  • Show on public frontend only
  • Show on admin only
  • Show on both
  • Do not show
Currently I am only using it on the public frontend so it is just an obstacle on the admin.

3)

email option:

Quote: "Receive emails when an error occurs in production mode." you wrote in the forum, which is a much better description than the one you actually used in the module: "This email address will receive notification of errors."

thanks again!

I haven't seen that issue with the bar taking up more than one line. I have tested in Chrome, Firefox, and Safari. What browser are you using? Can you show me the dom of the bar so I can see what might be causing that?

I have added the option to disable the bar on the backend. I went with just two checkboxes, one for the frontend, and one for the backend. I think this works well and I agree, the module is often not needed in the backend, although I am really enjoying using it for module development - it's so nice to be able to dump variables to the debugger bar, or console when it would otherwise be impossible to get them to display without logging to a log file.

I have changed the description for the email address - thanks for picking that up.

I have also added options to disable the Methods Info panel and the DebugMode Indicator - users upgrading will need to revisit your config settings to enable these.

  • Like 2

Share this post


Link to post
Share on other sites

Sorry, I still really don't get the point. Using number_format to round a value with less than 4 decimal places ends up displaying blank/non significant zeros, eg: echo number_format(0.12,4) results in: 0.1200

Yes, of course :-) I was just commenting the difference between results from Tracy and PW timers and not "requesting" to be the same. Sorry for not making that clear. I was thinking like this: if you have multiple timers, than it might be visually better to see them aligned ...

Share this post


Link to post
Share on other sites

I upgraded to the latest version and I get 

in_array() expects parameter 2 to be array, integer given

TracyDebugger.module, line 154. No access to admin.

I commented lines in ready() so that admin worked again, then updated module settings.

Share this post


Link to post
Share on other sites

I upgraded to the latest version and I get 

TracyDebugger.module, line 154. No access to admin.

I commented lines in ready() so that admin worked again, then updated module settings.

Sorry about that - it was due to the change in that setting from being a single checkbox to an array with two options. The error should go away after saving the config settings again, but to ease the update, I have added a check that will prevent the error.

Share this post


Link to post
Share on other sites
Thank you adrian!

How should I update the module? I simply downloaded it from GitHub (about 10 minutes ago ), replaced the entire directory but it only works if I'm logged in (superuser), otherwise I get this:



Fatal error: Access to undeclared static property: Tracy\Debugger::$showBar in .../site/assets/cache/FileCompiler/site/modules/TracyDebugger/TracyDebugger.module on line 160


I re-saved the config settings a few times and I also used "Modules > Refresh", but these actions did not help.

  • Like 1

Share this post


Link to post
Share on other sites
Thank you adrian!
 
How should I update the module? I simply downloaded it from GitHub (about 10 minutes ago ), replaced the entire directory but it only works if I'm logged in (superuser), otherwise I get this:
Fatal error: Access to undeclared static property: Tracy\Debugger::$showBar in .../site/assets/cache/FileCompiler/site/modules/TracyDebugger/TracyDebugger.module on line 160
I re-saved the config settings a few times and I also used "Modules > Refresh", but these actions did not help.

Sorry - I didn't check non-superusers after the recent change to the Show Debugger Bar settings. The latest version (just committed) should fix that new error!

PS, I'll be adding this to the modules directory in the next couple of days, so updates will be easy via the PW Upgrade module (http://modules.processwire.com/modules/process-wire-upgrade/).

  • Like 1

Share this post


Link to post
Share on other sites

Yesterday I had a "Bad gateway" error, perhaps nginx-related, but the new version seems to fixed this too.

Unrelated: if you uninstall a module, then settings are gone, right? If so, I could think of a file-based settings file which you could edit by hand, to set you own (custom) defaults which would survive uninstalls. Is it a bad idea, or perhaps there's already something like this?

Share this post


Link to post
Share on other sites
Unrelated: if you uninstall a module, then settings are gone, right? If so, I could think of a file-based settings file which you could edit by hand, to set you own (custom) defaults which would survive uninstalls. Is it a bad idea, or perhaps there's already something like this?

Take a look at: https://processwire.com/talk/topic/8410-module-toolkit/ - among other things, it lets you export a module along with all its settings and install again, already configured. It is still alpha/early beta for some features, but I do hope to get it finalized soon.

Back to Tracy:

I have a question for you guys. With Tracy Debugger, PW's debug mode doesn't really change error reporting anymore. It is controlled by this module and is currently restricted to superusers. So I am thinking of the need to sometimes debug when logged in as a non-superuser/guest. So should I make the module work for non-superusers when PW's debug mode is on? Or maybe a separate setting altogether than turns it on for non-superusers? Or should there be a separate config setting for enabling certain users or roles to have Tracy enabled for? Would really appreciate your thoughts on this - thanks!

Share this post


Link to post
Share on other sites

I have a question for you guys. With Tracy Debugger, PW's debug mode doesn't really change error reporting anymore. It is controlled by this module and is currently restricted to superusers. So I am thinking of the need to sometimes debug when logged in as a non-superuser/guest. So should I make the module work for non-superusers when PW's debug mode is on? Or maybe a separate setting altogether than turns it on for non-superusers? Or should there be a separate config setting for enabling certain users or roles to have Tracy enabled for? Would really appreciate your thoughts on this - thanks!

"PW's debug mode doesn't really change error reporting anymore". Can you please explain it a bit more? I do not quite get this.
 
About "superuser only mode": the module should also support non-superuser debugging too. What happens when we want to debug while logged in as another user+role? Why should we miss Tracy in this case? :) The more control we have in this area is the better, I suppose.

Share this post


Link to post
Share on other sites
1)

Is it normal that I have this strange looking layout on the public frontend? (see attached image) It would be nice to have a bar that is only one row tall.

attachicon.giftracy-height-2016-02-16.png

I haven't seen that issue with the bar taking up more than one line. I have tested in Chrome, Firefox, and Safari. What browser are you using? Can you show me the dom of the bar so I can see what might be causing that?

I should have checked "my" css before asking this question, sorry for this. I use a "framework" called Responsee 3 which happens to change the display property of <img> to "block". Changing it back to "inline" or "inline-block" fixes is the issue.

I do not know if you want deal with this issue or not, but you might be able to address this by targeting Tracy's <img> tags to set "inline" or "inline-block" !important on them, just in case... As far as I can see, Tracy itself uses a lot of !important rules as well. Maybe the developers of Tracy should apply this, and it is out of the scope of your module.

EDIT: "inline" or "inline-block"

Edited by szabesz

Share this post


Link to post
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.


  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By eelkenet
      Hi! I've created a small Inputfield module called InputfieldFloatRange which allows you to use an HTML5 <input type="range" ../> slider as an InputField. I needed something like this for a project where the client needs to be able to tweak this value more based on 'a feeling' than just entering a boring old number. Maybe more people can use this so I'm hereby releasing it into the wild. 
      EDIT: You can now install it directly from the Modules directory: http://modules.processwire.com/modules/inputfield-float-range/
       
      What is it?
      The missing range slider Inputfield for Processwire. 
      What does it do?
      This module extends InputfieldFloat and allows you to use HTML5 range sliders for number fields in your templates.
      It includes a visible and editable value field, to override/tweak the value if required.  
      Features
      Min/max values Precision (number of decimals) Optional step value (Read more) Optional manual override of the selected value (will still adhere to the rules above) Configurable rounding of manually entered values (floor, round, ceil, disable) Usage
      Clone / zip repo Install FieldtypeFloatRange, this automatically installs the Inputfield Create new field of type `Float (range)` or convert an existing `Float`, `Integer` or `Text` field. To render the field's value simply echo `$page->field` Demo
      A field with Min=0, Max=1, Step=0.2, Precision=2

      Field with settings Min=0, Max=200, Step=0.25, Precision=2

       
      Todo
      Make the display-field's size configurable (will use the Input Size field setting)  Hopefully become redundant  
      Changelog
      004 (current version)
      - Make rounding of manually entered values configurable (floor, round, ceil or disable)
      - Fix small JS bug when the value-display field was not displayed
      - Update README
      003
      - Code cleanup, add some ModuleInfo data & LICENSE
      - Submit to PW Modules directory (http://modules.processwire.com/modules/inputfield-float-range/)
      002
      - Fix issue where setting the step value to an empty value created problem with validation
      - Make the display-field optional
      001
      - Initial release
       
      Thanks!
       
       
    • By Gadgetto
      Status update links (inside this thread) for SnipWire development will be always posted here:
      2019-10-18
      2019-08-08
      2019-06-15
      2019-06-02
      2019-05-25
      If you are interested, you can test the current state of development:
      https://github.com/gadgetto/SnipWire
      Please note that the software is not yet intended for use in a production system (alpha version).
      If you like, you can also submit feature requests and suggestions for improvement. I also accept pull requests.
      ---- INITIAL POST FROM 2019-05-25 ----
      I wanted to let you know that I am currently working on a new ProcessWire module that fully integrates the Snipcart Shopping Cart System into ProcessWire. (this is a customer project, so I had to postpone the development of my other module GroupMailer).
      The new module SnipWire offers full integration of the Snipcart Shopping Cart System into ProcessWire.
      Here are some highlights:
      simple setup with (optional) pre-installed templates, product fields, sample products (quasi a complete shop system to get started immediately) store dashboard with all data from the snipcart system (no change to the snipcart dashboard itself required) Integrated REST API for controlling and querying snipcart data webhooks to trigger events from Snipcart (new order, new customer, etc.) multi currency support self-defined/configurable tax rates etc. Development is already well advanced and I plan to release the module in the next 2-3 months.
      I'm not sure yet if this will be a "Pro" module or if it will be made available for free.
      I would be grateful for suggestions and hints!
      (please have a look at the screenshots to get an idea what I'm talking about)
       




    • By Robin S
      Another little admin helper module...
      Template Field Widths
      Adds a "Field widths" field to Edit Template that allows you to quickly set the widths of inputfields in the template.

      Why?
      When setting up a new template or trying out different field layouts I find it a bit slow and tedious to have to open each field individually in a modal just to set the width. This module speeds up the process.
      Installation
      Install the Template Field Widths module.
      Config options
      You can set the default presentation of the "Field widths" field to collapsed or open. Field widths entered into the Template Field Widths inputfield are only applied if the Edit Template form is submitted with the Template Field Widths inputfield in an opened state. "Collapsed" is the recommended setting if you think you might also use core inputs for setting field widths in a template context. You can choose Name or Label as the primary identifier shown for the field. The unchosen alternative will become the title attribute shown on hover. You can choose to show the original field width next to the template context field width.  
      https://github.com/Toutouwai/TemplateFieldWidths
      https://modules.processwire.com/modules/template-field-widths/
    • By adrian
      This module allows you to automatically rename file (including image) uploads according to a configurable format
      This module lets you define as many rules as you need to determine how uploaded files will be named and you can have different rules for different pages, templates, fields, and file extensions, or one rule for all uploads. Renaming works for files uploaded via the admin interface and also via the API, including images added from remote URLs.   Github: https://github.com/adrianbj/CustomUploadNames
      Modules Directory: http://modules.processwire.com/modules/process-custom-upload-names/
      Renaming Rules
      The module config allows you to set an unlimited number of Rename Rules. You can define rules to specific fields, templates, pages, and file extensions. If a rule option is left blank, the rule with be applied to all fields/templates/pages/extensions. Leave Filename Format blank to prevent renaming for a specific field/template/page combo, overriding a more general rule. Rules are processed in order, so put more specific rules before more general ones. You can drag to change the order of rules as needed. The following variables can be used in the filename format: $page, $template, $field, and $file. For some of these (eg. $field->description), if they haven't been filled out and saved prior to uploading the image, renaming won't occur on upload, but will happen on page save (could be an issue if image has already been inserted into RTE/HTML field before page save). Some examples: $page->title mysite-{$template->name}-images $field->label $file->description {$page->name}-{$file->filesize}-kb prefix-[Y-m-d_H-i-s]-suffix (anything inside square brackets is is considered to be a PHP date format for the current date/time) randstring[n] (where n is the number of characters you want in the string) ### (custom number mask, eg. 001 if more than one image with same name on a page. This is an enhanced version of the automatic addition of numbers if required) If 'Rename on Save' is checked files will be renamed again each time a page is saved (admin or front-end via API). WARNING: this setting will break any direct links to the old filename, which is particularly relevant for images inserted into RTE/HTML fields. The Filename Format can be defined using plain text and PW $page variable, for example: mysite-{$page->path} You can preserve the uploaded filename for certain rules. This will allow you to set a general renaming rule for your entire site, but then add a rule for a specific page/template/field that does not rename the uploaded file. Just simply build the rule, but leave the Filename Format field empty. You can specify an optional character limit (to nearest whole word) for the length of the filename - useful if you are using $page->path, $path->name etc and have very long page names - eg. news articles, publication titles etc. NOTE - if you are using ProcessWire's webp features, be sure to use the useSrcExt because if you have jpg and png files on the same page and your rename rules result in the same name, you need to maintain the src extension so they are kept as separate files.
      $config->webpOptions = array(     'useSrcExt' => false, // Use source file extension in webp filename? (file.jpg.webp rather than file.webp) ); Acknowledgments
      The module config settings make use of code from Pete's EmailToPage module and the renaming function is based on this code from Ryan: http://processwire.com/talk/topic/3299-ability-to-define-convention-for-image-and-file-upload-names/?p=32623 (also see this post for his thoughts on file renaming and why it is the lazy way out - worth a read before deciding to use this module). 
       
       
      NOTE:
      This should not be needed on most sites, but I work with lots of sites that host PDFs and photos/vectors that are available for download and I have always renamed the files on upload because clients will often upload files with horrible meaningless filenames like:
      Final ReportV6 web version for John Feb 23.PDF

×
×
  • Create New...