docs: add frappe recorder docs

frappe_docs/www/docs/_sidebar.json

@@ -127,6 +127,10 @@
 				"title": "Debugging",
 				"route": "/docs/user/en/debugging"
 			},
+			{
+				"title": "Profiling",
+				"route": "/docs/user/en/profiling"
+			},
 			{
 				"title": "Contribution Guidelines",
 				"route": "https://github.com/frappe/erpnext/wiki/Contribution-Guidelines"

frappe_docs/www/docs/user/en/debugging.md

@@ -108,59 +108,6 @@ Out[1]: <erpnext.projects.doctype.task.task.Task at 0x10825d710>
 
 > Learn more about the Python API [here](/docs/user/en/api/python).
 
-### Profiling
-
-Bench's `execute` command runs a dotted path to method and it also supports
-profiling.
-
-```sh
-▶ bench --site [sitename] --profile execute erpnext.projects.doctype.task.task.set_tasks_as_overdue
-```
-
-You should be able to run most commands you can run via console with `execute` now, including *db* methods.
-
-```sh
-▶ bench --site [sitename] execute frappe.db.get_database_size
-6784
-```
-
-### Monitoring
-
-Monitor logs request and job metadata. To enable this feature set `monitor: 1` in `site_config.json` or `common_site_config.json`.
-
-Collected data is buffered in redis cache and periodically moved to `monitor.json.log` file in `logs` directory with a scheduled job `frappe.monitor.flush`.
-
-```JSON
-{
-    "duration": 807142,
-    "request": {
-        "ip": "127.0.0.1",
-        "method": "GET",
-        "path": "/api/method/frappe.realtime.get_user_info",
-        "response_length": 9687,
-        "status_code": 500
-    },
-    "site": "frappe.local",
-    "timestamp": "2020-03-05 09:37:17.397884",
-    "transaction_type": "request",
-    "uuid": "83be6a4c-27a1-497a-9ce6-c815bca4e420"
-}
-```
-
-```JSON
-{
-    "duration": 1364,
-    "job": {
-        "method": "frappe.ping",
-        "scheduled": false,
-        "wait": 90204
-    },
-    "site": "frappe.local",
-    "timestamp": "2020-03-05 09:37:40.124682",
-    "transaction_type": "job",
-    "uuid": "8225ab76-8bee-462c-b9fc-a556406b1ee7"
-}
-```
 
 ## Client
 

frappe_docs/www/docs/user/en/profiling.md

@@ -0,0 +1,104 @@
+---
+add_breadcrumbs: 1
+title: Profiling
+metatags:
+ description: >
+  Learn about performance profiling techniques while developing Frappe apps.
+---
+
+# Profiling
+
+## Recorder - SQL profiler
+
+Frappe Recorder is a profiling tool built into the Frappe framework designed to capture all requests, SQL queries executed along with stack traces.
+
+Example use case: You've noticed that a certain doctype is taking too much time to save and you believe that SQL queries might be a bottleneck. In such a case starting recorder and then submitting your document will give you complete capture of all the queries that took place.
+
+1. Open Recorder from Awesomebar and click on "Start recording".
+2. Perform the actions you want to profile (preferably in another tab.)
+3. Once you've captured enough information, go to the recorder again and stop recording.
+
+You will now see a list of all the requests that were made. You can sort them by various columns to identify problematic requests.
+
+![Frappe recorder list view](/docs/assets/img/recorder-list-view.png)
+
+Click on a row to open the request for extra information. Following information is available in capture:
+
+1. path - requested path e.g. `/app`
+2. cmd - dotted path to the method
+3. time - time at which request was created
+4. duration - duration for completing the request (see implementation note below)
+5. number of queries - Number of SQL queries executed for fulfilling the request.
+6. Time in queries - Time taken in SQL queries.
+7. Request headers - HTTP headers received with the request.
+8. Form Dict - form data received with the request.
+9. SQL queries - table of all SQL queries that ran.
+
+![Frappe recorder request view](/docs/assets/img/recorder-request-view.png)
+
+SQL Queries table can be sorted and grouped for duplicates to find the relevant queries. To know more about a particular query click on row to expand additional information. This includes the duration of the query, stack trace and SQL's `EXPLAIN` output for that query.
+
+> Implementation note: Recorder adds sizable overhead for capturing the details, hence overall duration is not representative of real-world performance. Query time however is very close to real-world performance.
+
+
+### Exporting Frappe Recorder captures
+
+You can export recorder captures and import them on another site for further analysis.
+
+1. Go to recorder page. Once you've recorded click on Menu (three dots) > Export Data.
+2. This will download a JSON file containing captured data. To view this on another site drag and drop the JSON file on the recorder page.
+
+
+## Profiling functions using bench
+
+Bench's `execute` command runs a dotted path to method and it also supports
+profiling.
+
+```sh
+▶ bench --site [sitename] --profile execute erpnext.projects.doctype.task.task.set_tasks_as_overdue
+```
+
+You should be able to run most commands you can run via console with `execute` now, including *db* methods.
+
+```sh
+▶ bench --site [sitename] execute frappe.db.get_database_size
+6784
+```
+
+## Monitoring
+
+Monitor logs request and job metadata. To enable this feature set `"monitor": 1` in your site config.
+
+Collected data is buffered in redis cache and periodically moved to `monitor.json.log` file in `logs` directory with a scheduled job `frappe.monitor.flush`.
+
+```JSON
+{
+    "duration": 807142,
+    "request": {
+        "ip": "127.0.0.1",
+        "method": "GET",
+        "path": "/api/method/frappe.realtime.get_user_info",
+        "response_length": 9687,
+        "status_code": 500
+    },
+    "site": "frappe.local",
+    "timestamp": "2020-03-05 09:37:17.397884",
+    "transaction_type": "request",
+    "uuid": "83be6a4c-27a1-497a-9ce6-c815bca4e420"
+}
+```
+
+```JSON
+{
+    "duration": 1364,
+    "job": {
+        "method": "frappe.ping",
+        "scheduled": false,
+        "wait": 90204
+    },
+    "site": "frappe.local",
+    "timestamp": "2020-03-05 09:37:40.124682",
+    "transaction_type": "job",
+    "uuid": "8225ab76-8bee-462c-b9fc-a556406b1ee7"
+}
+```