diff --git a/docs/8.0/ayanova/docs/ops-jobs.md b/docs/8.0/ayanova/docs/ops-jobs.md index d1f87a1a..dff983c4 100644 --- a/docs/8.0/ayanova/docs/ops-jobs.md +++ b/docs/8.0/ayanova/docs/ops-jobs.md @@ -1,3 +1,65 @@ -# OPS-JOBS +# Server job queue log -![THIS PAGE UNDER CONSTRUCTION](img/underconstruction.svg) +This form is used to view a history of, and troubleshoot server jobs, primarily for technical support purposes if required. + +A server job is a task run by the server in response to a User request for a long running operation or as part of an automated recurring process initiated by the server itself and usually related to "housekeeping" tasks that keep the server running in good order. + +For example both the automated daily backup and rendering a report from a User request are common types of server jobs. + +## Authorization Roles required + +This form is available to User's 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 Job Queue + +The Job Queue form is accessed in the following ways: + +- From the `Server operations` navigation pane `Job Queue` item to open this form + +## Job Queue data table + +The Job Queue [data table](ay-start-form-data-tables.md) is a log of the last 14 days of customer notification email deliveries both failed and successful and access to common data table [menu options](ay-start-form-data-tables.md#common-menu-options). + +### 14 days + +AyaNova automatically deletes Job Queue entries older than 14 days. + +### Job Queue data table columns + +#### Time stamp + +The date and time the Job queue entry was logged. + +#### Status + +Information reported by the job. Each job is unique and reports different information depending on the job's task. + +#### Id + +If a Job has a unique identifier it's listed here. This can be used in conjunction with the server log for troubleshooting some issues. + +### Menu options + +In addition to the [common edit form menu options](ay-start-edit-forms.md#common-edit-form-menu-options) the Job Queue form also has these options: + +#### Copy + +This option copies the job queue log in .json format. + +#### Submit test job + +This option triggers a test job to diagnose if the server is processing jobs as it should. + +The test job goes through the normal job process and for it's test task it counts down 30 seconds before completing the job. + +Any errors will be reported back in the Job Queue log. If the Job completes normally it indicates that the job processor is still in operation at the server. diff --git a/docs/8.0/ayanova/docs/ops-metrics.md b/docs/8.0/ayanova/docs/ops-metrics.md index 1914020a..c4d8010b 100644 --- a/docs/8.0/ayanova/docs/ops-metrics.md +++ b/docs/8.0/ayanova/docs/ops-metrics.md @@ -1,18 +1,109 @@ -# Metrics +# Server Metrics -![THIS PAGE UNDER CONSTRUCTION](img/underconstruction.svg) +AyaNova 8+ automatically tracks server metrics for ongoing server maintenance, monitoring and technical support troubleshooting. -AyaNova 8+ automatically tracks server metrics for ongoing server maintenance, monitoring and troubleshooting. +Server Metrics are information gathered automatically as periodic snapshots during server operation that can be used to assess the health of an AyaNova server and help to determine if resources are adequate for the load that is placed on the AyaNova server by the users. -Metrics are statistical and other information gathered automatically during server operation that can be used to assess the health of an AyaNova server. This information is typically useful to the Operations staff who are responsible for maintaining the AyaNova server in good working condition. -When the AyaNova server is booted it starts gathering snapshots of statistical data during regular intervals that can be viewed to observe the current state of the server and some historical data from the point it was last rebooted. +The memory and cpu statistics are gathered _only_ for the AyaNova server process, they do not necessarily reflect the overall server's available memory or cpu usage as that information is not reliably available to AyaNova. -- link to chart control in common controls doc -- What each stat means and how it's to be interpreted -- Frequency of stat gathering - - every 5 minutes for memory and cpu metrics - - every 12 hours for disk space db total size -- Auto deleted after 365 days -- Used to provide trend monitoring over time so can know if need to upgrade the server it's hosted on or to anticipate running out of disk space, overwhelmed cpu pegging at 100% etc etc +This means that these metrics should be used in _conjuntion_ with the server operating system tools for monitoring overall server health and resource usage. + +Data is displayed in various [charts](ay-start-common-controls.md#chart). + +## 365 days + +Metrics snapshots for the last 365 days are stored in the database and entries older than 365 days are automatically deleted. + +## Authorization Roles required + +This form is available to User's 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 Server Metrics + +The Server Metrics form is accessed in the following ways: + +- From the `Server operations` navigation pane `Server Metrics` item to open this form + +## Server Metrics form + +The Server Metrics form is a series of graphs in separate tabs and a time span selection controlling the time period displayed in the graphs. + +#### Time range selector + +At the top of the form is a time period selector controlling what period is graphed. To the right is a refresh button to re-fetch the data from the server. + +A new database won't have a full range of data for all the time periods selectable so if you select a year but the current database has only been in use for a month you will only see a time range of what is available in the graphs on the time axis. + +### CPU / MEMORY tab + +These statistics are gathered every 5 minutes. + +#### Memory + +The memory values here should be interpreted as they change over time rather than their specific values at any given point in time for resource allocation purposes. + +The top graph shows memory usage over time for three categories: + +##### Allocated + +A number that is the best available approximation of the number of bytes currently allocated in managed memory. + +##### Working set + +The amount of physical memory, in bytes, allocated for the AyaNova server and associated processes. + +##### Private bytes + +The amount of memory, in bytes, allocated for the AyaNova server and associated processes that cannot be shared with other processes. + +#### CPU % + +This is the percentage of CPU load being used by the AyaNova server program _only_. This is not the overall server's CPU load as you would see in Windows Task manager or Linux Top utility for example. + +This chart is useful for interpreting over time any changes in CPU load for the AyaNova server process only. + +### DATABASE tab + +These statistics are gathered every 12 hours. + +##### Database size + +This is the AyaNova database size as reported by the Postgres database server. + +##### Top tables + +This graph shows the distribution of data by table stored in the AyaNova database. For newer databases the search key table used by the search system in AyaNova will usually take up the greatest amount of space but over time it will dwindle relative to other tables as fewer unique search terms are added to it. + +### File storage tab + +These statistics are gathered every 12 hours. + +#### Storage statistics + +##### Attachments + +This is the amount of disk space taken by [Attachments](adm-attachments.md) that Users have [Attached](ay-start-form-attachments.md) to various objects in AyaNova in the [User files folder](ops-config-folder-user-files.md). + +##### Backups + +Amount of disk space taken by [Backups](ops-form-backup.md) in the [Backups folder](ops-config-folder-backup-files.md) + +##### Available space + +Overall amount of available space on the drive AyaNova was started from. + +#### Attachment count + +This is the _count_ of [Attachments](adm-attachments.md) that Users have [Attached](ay-start-form-attachments.md) to various objects in AyaNova in the [User files folder](ops-config-folder-user-files.md).