From bcad11d6dbb9e096dd66e079cee8674499847c7a Mon Sep 17 00:00:00 2001 From: John Cardinal Date: Thu, 22 Sep 2022 16:49:47 +0000 Subject: [PATCH] --- devdocs/todo.txt | 4 +- docs/8.0/ayanova/docs/ops-profile.md | 81 ---------------------------- docs/8.0/ayanova/mkdocs.yml | 3 +- 3 files changed, 4 insertions(+), 84 deletions(-) delete mode 100644 docs/8.0/ayanova/docs/ops-profile.md diff --git a/devdocs/todo.txt b/devdocs/todo.txt index a125f84b..9d6a85e3 100644 --- a/devdocs/todo.txt +++ b/devdocs/todo.txt @@ -1376,4 +1376,6 @@ AyaAnova with active trial license now does fast track license check to accomoda docs additions Removed optins of seedlevel from eval page at client, now defaults to small only Fixed issue with some metrics timeline charts -Changed 12 hour metrics to 24 hour metrics \ No newline at end of file +Changed 12 hour metrics to 24 hour metrics +removed profiler from client and docs, kept at server just in case +changed metrics default timeframe from last 6 hours to last 7 days as it makes the daily stats graphs look broken if people don't understand how they work \ No newline at end of file diff --git a/docs/8.0/ayanova/docs/ops-profile.md b/docs/8.0/ayanova/docs/ops-profile.md deleted file mode 100644 index 644d0191..00000000 --- a/docs/8.0/ayanova/docs/ops-profile.md +++ /dev/null @@ -1,81 +0,0 @@ -# Profiler - -The Profiler form shows the internal performance of the AyaNova server API routes and database calls to help with technical support troubleshooting. - -Should any particular operation in AyaNova be excessively slow, this tool can help AyaNova technical support diagnose the source of the issue. - -The information displayed on this form comes from a 3rd party tool and all text displayed is in the English language only. - -## 30 minutes - -The profiler tracks the most recent 30 minutes of activity only. - -## Authorization Roles required - -Many roles can *select* this object on other records where approriate. Editing or viewing this object in detail is only available to Users with the following [roles](ay-biz-admin-roles.md): - -Full access - -- System operations - -Read only access - -- Business administration -- Business administration - restricted -- System operations - restricted - -## How to access the Profiler - -The Profiler form is accessed in the following ways: - -- From the `Server operations` [navigation drawer](ay-start-form-overview.md#navigation-drawer) `Profiler` item to open this form - -## Profiler form - -The Profiler form shows a table of the last 30 minutes of requests made to the server. - -Each request can be clicked on to show an overview of the timing of each step of the operation from initial request to response. - -### Main table columns - -#### Name - -This is the name of the AyaNova api route that is serving the incoming request. - -#### Server - -This will always be the local server - -#### Started - -This is the moment in time that the api request was received in UTC time zone. - -#### Total duration - -Shows the total time in milliseconds from the moment the request was received until the response was sent back to fulfil the request. - -#### Request start - -Unused. - -#### Response start - -Unused. - -#### DOM Complete - -Unused. - -### Details form - -Clicking on an API call listed in the Name column will open the details form showing the steps taken to process the request and the timing of each step. - -This information is provided for technical support troubleshooting purposes only and we won't document it all here but essentially it shows the time taken by each step of the process to fulfil the request including database queries and AyaNova support will be looking for unusually slow steps in consultation with the AyaNova development department to diagnose the source of these unexpected problems. - -## Troubleshooting process - -If an operation in AyaNova is found to be unacceptably slow, technical support may request that you repeat the operation and then immediately go to this form to find the slow api method, click on it's Name and capture a screen shot of the details form for this request to send back to support to help determine the exact step where it slows down. - -This provides technical support in consultation with AyaNova development department with a direction of inquiry and helps to eliminate a number of potential issues quickly to get to the actual issue at hand. - -If appropriate, providing AyaNova technical support with a temporary read-only `Operations - restricted` role login account will enable them to examine the server logs and this form directly without the need to expose any other company business data. diff --git a/docs/8.0/ayanova/mkdocs.yml b/docs/8.0/ayanova/mkdocs.yml index 53ee0c8d..8be89e0a 100644 --- a/docs/8.0/ayanova/mkdocs.yml +++ b/docs/8.0/ayanova/mkdocs.yml @@ -159,8 +159,7 @@ nav: - 'Backup': 'ops-form-backup.md' - 'Job queue': 'ops-jobs.md' - 'Server log': 'ops-log.md' - - 'Server metrics': 'ops-metrics.md' - - 'Profile': 'ops-profile.md' + - 'Server metrics': 'ops-metrics.md' - 'Notification settings': 'ops-notification-system.md' - 'Customer notification log': 'ops-customer-notify-log.md' - 'User notification log': 'ops-notify-log.md'