{"id":189778,"date":"2019-07-31T10:09:05","date_gmt":"2019-07-31T10:09:05","guid":{"rendered":"https:\/\/webkul.com\/blog\/?p=189778"},"modified":"2025-11-18T04:49:31","modified_gmt":"2025-11-18T04:49:31","slug":"profiler-in-magento-2","status":"publish","type":"post","link":"https:\/\/webkul.com\/blog\/profiler-in-magento-2\/","title":{"rendered":"Profiler in Magento 2"},"content":{"rendered":"\n

How to Debug in Magento 2 using Profiler <\/strong>– In this article, we will learn about the role of Profiler in Magento 2 & debugging.<\/p>\n\n\n\n

Whether you are improving your store\u2019s efficiency yourself or working with professional Magento 2 Speed Optimization Services<\/a><\/strong>, profiling plays a crucial role in identifying bottlenecks.<\/p>\n\n\n\n

In Magento 2, We can use a built-in profiler Magento to perform tasks such as debugging performance.<\/p>\n\n\n\n

It can tell us in intricate detail which blocks of code are used in the loading of a slow page, and how long it takes each block to complete its task.<\/p>\n\n\n\n

You can check the overview in the video below \u2014<\/p>\n\n\n\n

WI_B6Hy8f9s<\/div><\/div><\/div><\/div>\n\n\n\n


The nature of profiling depends on the analytical tools we use. Currently, Magento supports multiple formats like HTML<\/strong>, CSV<\/strong> or Firebug<\/strong>.<\/p>\n\n\n\n

Enable the Profiler in Magento 2:<\/strong><\/h3>\n\n\n\n

There are two ways to enable the Profiler in Magento 2:

1. By Using .htaccess file:<\/strong> We can enable the profiler by adding following statement in .htaccess file:<\/p>\n\n\n\n

SetEnv MAGE_PROFILER <type><\/pre>\n\n\n\n
 <\/strong>where, <<\/strong>type> can be “csvfile”<\/em> or “firebug”<\/em> or “html”<\/em>. 
 In case of “csvfile”, you can find the report in var\/log\/<\/em> dir.<\/p>\n\n\n\n
2. By using CLI:<\/strong> You can run following command to enable the profiler:<\/p>\n\n\n\n
php bin\/magento dev:profiler:enable <type><\/pre>\n\n\n\n
where, <type> can be “html” <\/em>or “csvfile”<\/em> or “flagfile”<\/em>.
In case of “flagfile”, a flagfile named as profiler.flag will be created inside var\/ <\/em>directory.<\/p>\n\n\n\n
Note:<\/strong> If you will not mention any <type> while executing the command, then it will enable the “html”<\/em> type profiler by default.<\/p>\n\n\n\n
If you have enabled the “html”<\/em> type profiler. Then it always display the result on footer section of web page, you can see in the following image:<\/p>\n\n\n\n
\"profiler-1\"<\/figure>\n\n\n\n
Disable the Profiler in Magento 2:<\/strong><\/h3>\n\n\n\n
1. By Using .htaccess file:<\/strong> Remove the following statement from .htaccess file:<\/p>\n\n\n\n
SetEnv MAGE_PROFILER <type><\/pre>\n\n\n\n
2. By Using CLI:<\/strong> You can run following command to disable the profiler and remove the flagfile:<\/p>\n\n\n\n
 php bin\/magento dev:profiler:disable


Adding Custom Profiler in specific code:<\/strong>
Sometimes, we need to measure the performance of custom code\/script, then in that case we can use custom profiler.

To add custom profiler in custom code, Magento provides \\Magento\\Framework\\Profiler class which have two methods: start() and stop().

start():<\/strong> In this method, we pass the custom profiler name as parameter, which will measure the performance of the code for example execution time etc.

stop():<\/strong> In this method, we pass the custom profiler name as parameter which have to be stopped.<\/pre>\n\n\n\n
\\Magento\\Framework\\Profiler::start('custom-profiler-name');\n\/***\n* write your code here for which custom profiler will calculate the execution time or measure the performance of code\n**\/\n\\Magento\\Framework\\Profiler::stop('custom-profiler-name');<\/pre>\n\n\n\n
We can add a custom profiler as following example:<\/p>\n\n\n\n
\/**Custom Profiler starts here**\/\n\\Magento\\Framework\\Profiler::start('custom-profiler-name');\n\n\/**custom script statements**\/\n$resultPage = $this->resultPageFactory->create();\n$resultPage->getConfig()->getTitle()->set(__(\"Example\"));\n\n\\Magento\\Framework\\Profiler::stop('custom-profiler-name');\n\/**Custom Profiler ends here**\/<\/pre>\n\n\n\n
If you have enabled the “html”<\/em> type profiler then you can see your custom profiler<\/strong> as following image:<\/p>\n\n\n\n
\"customprofiler\"<\/figure>\n\n\n\n
In html output profiler, the columns are as follows:<\/p>\n\n\n\n
Timer Id: <\/strong>This gives the name of the block of code being executed.

Time:<\/strong> The time it took to complete in seconds.<\/p>\n\n\n\n
Avg: <\/strong>The average time it took to complete in seconds.

Cnt:<\/strong> Short for Count<\/em>. This represents the number of times this individual block ran to generate the output required.<\/p>\n\n\n\n
RealMem: <\/strong>The actual amount of memory used to perform the operation.<\/p>\n\n\n\n
Emalloc:<\/strong> The amount of memory PHP assigns to a single Magento operation, represented in bytes.

Hope this will help you to analyze the performance of the code. 
Thanks \ud83d\ude42<\/p>\n\n\n\n
Previous Blog:<\/strong> How To Implement Custom Attribute Filter In Custom Product Collection Page In Magento 2<\/a>

Next Blog:<\/strong> Creating POST Method Controller in Magento 2.3<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"
How to Debug in Magento 2 using Profiler – In this article, we will learn about the role of Profiler in Magento 2 & debugging. Whether you are improving your store\u2019s efficiency yourself or working with professional Magento 2 Speed Optimization Services, profiling plays a crucial role in identifying bottlenecks. In Magento 2, We can […]<\/a><\/p>\n","protected":false},"author":444,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[8,9121,13],"tags":[2070,4173,2057,4246],"class_list":["post-189778","post","type-post","status-publish","format-standard","hentry","category-magento","category-magento-2","category-php","tag-magento2","tag-performance","tag-php","tag-profiler"],"yoast_head":"\nProfiler in Magento 2 - Webkul Blog<\/title>\n<meta name=\"description\" content=\"Profiler in Magento 2\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/webkul.com\/blog\/profiler-in-magento-2\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Profiler in Magento 2 - Webkul Blog\" \/>\n<meta property=\"og:description\" content=\"Profiler in Magento 2\" \/>\n<meta property=\"og:url\" content=\"https:\/\/webkul.com\/blog\/profiler-in-magento-2\/\" \/>\n<meta property=\"og:site_name\" content=\"Webkul Blog\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/webkul\/\" \/>\n<meta property=\"article:published_time\" content=\"2019-07-31T10:09:05+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2025-11-18T04:49:31+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2019\/07\/profiler-1.png\" \/>\n<meta name=\"author\" content=\"Rajesh Pathak\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:creator\" content=\"@webkul\" \/>\n<meta name=\"twitter:site\" content=\"@webkul\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Rajesh Pathak\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"3 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\/\/webkul.com\/blog\/profiler-in-magento-2\/#article\",\"isPartOf\":{\"@id\":\"https:\/\/webkul.com\/blog\/profiler-in-magento-2\/\"},\"author\":{\"name\":\"Rajesh Pathak\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/person\/d896112f48e09d54b07c2b61352aa96b\"},\"headline\":\"Profiler in Magento 2\",\"datePublished\":\"2019-07-31T10:09:05+00:00\",\"dateModified\":\"2025-11-18T04:49:31+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\/\/webkul.com\/blog\/profiler-in-magento-2\/\"},\"wordCount\":459,\"commentCount\":0,\"publisher\":{\"@id\":\"https:\/\/webkul.com\/blog\/#organization\"},\"image\":{\"@id\":\"https:\/\/webkul.com\/blog\/profiler-in-magento-2\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2019\/07\/profiler-1.png\",\"keywords\":[\"Magento2\",\"performance\",\"PHP\",\"profiler\"],\"articleSection\":[\"magento\",\"Magento 2\",\"php\"],\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\/\/webkul.com\/blog\/profiler-in-magento-2\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/webkul.com\/blog\/profiler-in-magento-2\/\",\"url\":\"https:\/\/webkul.com\/blog\/profiler-in-magento-2\/\",\"name\":\"Profiler in Magento 2 - Webkul Blog\",\"isPartOf\":{\"@id\":\"https:\/\/webkul.com\/blog\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/webkul.com\/blog\/profiler-in-magento-2\/#primaryimage\"},\"image\":{\"@id\":\"https:\/\/webkul.com\/blog\/profiler-in-magento-2\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2019\/07\/profiler-1.png\",\"datePublished\":\"2019-07-31T10:09:05+00:00\",\"dateModified\":\"2025-11-18T04:49:31+00:00\",\"description\":\"Profiler in Magento 2\",\"breadcrumb\":{\"@id\":\"https:\/\/webkul.com\/blog\/profiler-in-magento-2\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/webkul.com\/blog\/profiler-in-magento-2\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/webkul.com\/blog\/profiler-in-magento-2\/#primaryimage\",\"url\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2019\/07\/31091113\/profiler-1.png\",\"contentUrl\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2019\/07\/31091113\/profiler-1.png\",\"width\":1295,\"height\":665,\"caption\":\"profiler-1\"},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/webkul.com\/blog\/profiler-in-magento-2\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/webkul.com\/blog\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Profiler in Magento 2\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/webkul.com\/blog\/#website\",\"url\":\"https:\/\/webkul.com\/blog\/\",\"name\":\"Webkul Blog\",\"description\":\"\",\"publisher\":{\"@id\":\"https:\/\/webkul.com\/blog\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/webkul.com\/blog\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/webkul.com\/blog\/#organization\",\"name\":\"WebKul Software Private Limited\",\"url\":\"https:\/\/webkul.com\/blog\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png\",\"contentUrl\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png\",\"width\":380,\"height\":380,\"caption\":\"WebKul Software Private Limited\"},\"image\":{\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/\"},\"sameAs\":[\"https:\/\/www.facebook.com\/webkul\/\",\"https:\/\/x.com\/webkul\",\"https:\/\/www.instagram.com\/webkul\/\",\"https:\/\/www.linkedin.com\/company\/webkul\",\"https:\/\/www.youtube.com\/user\/webkul\/\"]},{\"@type\":\"Person\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/person\/d896112f48e09d54b07c2b61352aa96b\",\"name\":\"Rajesh Pathak\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/75e8d1cd06e1cb22acade1a768946b2ef8a0157cf66440e8739aa42c1d51e049?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Fmike.png&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/75e8d1cd06e1cb22acade1a768946b2ef8a0157cf66440e8739aa42c1d51e049?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Fmike.png&r=g\",\"caption\":\"Rajesh Pathak\"},\"url\":\"https:\/\/webkul.com\/blog\/author\/rajesh-pathak672\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Profiler in Magento 2 - Webkul Blog","description":"Profiler in Magento 2","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/webkul.com\/blog\/profiler-in-magento-2\/","og_locale":"en_US","og_type":"article","og_title":"Profiler in Magento 2 - Webkul Blog","og_description":"Profiler in Magento 2","og_url":"https:\/\/webkul.com\/blog\/profiler-in-magento-2\/","og_site_name":"Webkul Blog","article_publisher":"https:\/\/www.facebook.com\/webkul\/","article_published_time":"2019-07-31T10:09:05+00:00","article_modified_time":"2025-11-18T04:49:31+00:00","og_image":[{"url":"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2019\/07\/profiler-1.png","type":"","width":"","height":""}],"author":"Rajesh Pathak","twitter_card":"summary_large_image","twitter_creator":"@webkul","twitter_site":"@webkul","twitter_misc":{"Written by":"Rajesh Pathak","Est. reading time":"3 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/webkul.com\/blog\/profiler-in-magento-2\/#article","isPartOf":{"@id":"https:\/\/webkul.com\/blog\/profiler-in-magento-2\/"},"author":{"name":"Rajesh Pathak","@id":"https:\/\/webkul.com\/blog\/#\/schema\/person\/d896112f48e09d54b07c2b61352aa96b"},"headline":"Profiler in Magento 2","datePublished":"2019-07-31T10:09:05+00:00","dateModified":"2025-11-18T04:49:31+00:00","mainEntityOfPage":{"@id":"https:\/\/webkul.com\/blog\/profiler-in-magento-2\/"},"wordCount":459,"commentCount":0,"publisher":{"@id":"https:\/\/webkul.com\/blog\/#organization"},"image":{"@id":"https:\/\/webkul.com\/blog\/profiler-in-magento-2\/#primaryimage"},"thumbnailUrl":"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2019\/07\/profiler-1.png","keywords":["Magento2","performance","PHP","profiler"],"articleSection":["magento","Magento 2","php"],"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/webkul.com\/blog\/profiler-in-magento-2\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/webkul.com\/blog\/profiler-in-magento-2\/","url":"https:\/\/webkul.com\/blog\/profiler-in-magento-2\/","name":"Profiler in Magento 2 - Webkul Blog","isPartOf":{"@id":"https:\/\/webkul.com\/blog\/#website"},"primaryImageOfPage":{"@id":"https:\/\/webkul.com\/blog\/profiler-in-magento-2\/#primaryimage"},"image":{"@id":"https:\/\/webkul.com\/blog\/profiler-in-magento-2\/#primaryimage"},"thumbnailUrl":"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2019\/07\/profiler-1.png","datePublished":"2019-07-31T10:09:05+00:00","dateModified":"2025-11-18T04:49:31+00:00","description":"Profiler in Magento 2","breadcrumb":{"@id":"https:\/\/webkul.com\/blog\/profiler-in-magento-2\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/webkul.com\/blog\/profiler-in-magento-2\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/webkul.com\/blog\/profiler-in-magento-2\/#primaryimage","url":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2019\/07\/31091113\/profiler-1.png","contentUrl":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2019\/07\/31091113\/profiler-1.png","width":1295,"height":665,"caption":"profiler-1"},{"@type":"BreadcrumbList","@id":"https:\/\/webkul.com\/blog\/profiler-in-magento-2\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/webkul.com\/blog\/"},{"@type":"ListItem","position":2,"name":"Profiler in Magento 2"}]},{"@type":"WebSite","@id":"https:\/\/webkul.com\/blog\/#website","url":"https:\/\/webkul.com\/blog\/","name":"Webkul Blog","description":"","publisher":{"@id":"https:\/\/webkul.com\/blog\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/webkul.com\/blog\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/webkul.com\/blog\/#organization","name":"WebKul Software Private Limited","url":"https:\/\/webkul.com\/blog\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/","url":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png","contentUrl":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png","width":380,"height":380,"caption":"WebKul Software Private Limited"},"image":{"@id":"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.facebook.com\/webkul\/","https:\/\/x.com\/webkul","https:\/\/www.instagram.com\/webkul\/","https:\/\/www.linkedin.com\/company\/webkul","https:\/\/www.youtube.com\/user\/webkul\/"]},{"@type":"Person","@id":"https:\/\/webkul.com\/blog\/#\/schema\/person\/d896112f48e09d54b07c2b61352aa96b","name":"Rajesh Pathak","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/webkul.com\/blog\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/75e8d1cd06e1cb22acade1a768946b2ef8a0157cf66440e8739aa42c1d51e049?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Fmike.png&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/75e8d1cd06e1cb22acade1a768946b2ef8a0157cf66440e8739aa42c1d51e049?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Fmike.png&r=g","caption":"Rajesh Pathak"},"url":"https:\/\/webkul.com\/blog\/author\/rajesh-pathak672\/"}]}},"amp_enabled":true,"_links":{"self":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts\/189778","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/users\/444"}],"replies":[{"embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/comments?post=189778"}],"version-history":[{"count":29,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts\/189778\/revisions"}],"predecessor-version":[{"id":513597,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts\/189778\/revisions\/513597"}],"wp:attachment":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/media?parent=189778"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/categories?post=189778"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/tags?post=189778"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}