Free cookie consent management tool by TermsFeed Monitor View [Appian Designer]
Monitor View

Overview

This page covers all of the features of the Monitor view in Appian Designer.

To access this view, click Monitor in the navigation pane at the environment level or in an application.

When you access this view at the environment level, it contains information about deployments in the current environment. When you access the view from within an application, it contains information about deployments in the individual application.

Purpose

The Monitor view helps you keep an eye on health and activity indicators for your applications.

Elements

The Monitor view consists of a header bar, navigation pane, and the following tabs:

Health Dashboard

The Health Dashboard tab provides an at-a-glance overview of the health of your environment or application. It includes both runtime and design-time information, and surfaces related metrics and key performance indicators.

The dashboard is composed of three sections.

Note:  Only objects for which a developer has at least Viewer permissions are reflected in the dashboard's various summary cards and displayed in its Appian Design Guidance grid. The only exception to this is the Process Activity section, which displays processes that a developer has Initiator or higher permissions to.

The annotated screenshot above and descriptions below define the metrics and information displayed on the Health Dashboard tab.

  1. Process Activity: Provides a summary of the contents visible on the Process Activity tab. This card includes a breakdown of all process instances by status. It also displays the number of processes with unresolved errors and the number of processes that have completed within the last 24 hours. Clicking this card navigates you to the Process Activity tab.
  2. Process Model Metrics: Provides a summary of the contents visible on the Process Model Metrics tab. This card displays the number of process models with low, medium, and high memory usage. It also displays the number of process models whose instances have completed less than 10% of the time. Clicking this card navigates you to the Process Model Metrics tab.
  3. Record Response Times: Provides a summary of the contents visible on the Record Response Times tab. This card displays the number of record UIs (record lists and views) with low, medium, or high response times. Clicking this card navigates you to the Record Response Times tab.
  4. Record Sync Status: Provides a summary of the contents visible on the Record Sync Status tab. This card displays the total number of synced record types and the number of record types whose latest sync status was Completed, Failed, or Warning (which represents the Approaching Limit status). Clicking this card navigates you to the Record Sync Status tab.
  5. Security Warnings: Displays the number of objects with at least one security warning. Clicking this card opens the Security Summary, where you can edit object security in bulk. This card is only visible from within an application.
  6. Test Health: Displays two separate test health metrics. On the left it shows the percentage of expression rules with at least one test case. On the right it shows the number of expression rules that have all of their test cases passing out of the total number of expression rules with test cases. Clicking this card opens the Manage Test Cases dialog, which allows you to run test cases in bulk and identify expression rules that are missing test cases. This card is only visible from within an application.
  7. Unreferenced objects: Displays the number of unreferenced objects. Clicking this card navigates you to the Unreferenced Objects tab of the Build view. This card is only visible from within an application.
  8. Appian Design Guidance: Displays a grid of all of the objects that have at least one warning or recommendation, whether active or dismissed. By default the grid only shows objects with warnings or active recommendations, and displays objects which contain warnings first. Each row in the grid displays:
    • Name: The name of the object and its type. Clicking the hyperlinked name opens the object in a new tab.
    • Warnings and Recommendations: The list of warnings and recommendations that have been triggered for the object. By default only warnings and active recommendations – those that have not yet been resolved or explicitly dismissed – are displayed in the grid. To view dismissed recommendations, select the Display dismissed recommendations filter checkbox.
    • Last Modified: The timestamp that the object was last modified on, and the user who modified it.
  9. Appian design guidance grid filters. These include:
    • Object Name search: Filters objects in the grid by search term. The entered term is searched against all of the object names available in the grid.
    • Object Types dropdown: Displays objects in the grid of the selected type(s). Note that only object types that can have warnings or recommendations are listed in this dropdown.
    • Packages dropdown: Only displays objects in the grid that are in a selected package. This filter is only available when viewing the Health Dashboard within an application.
    • All Warnings dropdown: Displays objects in the grid that have the selected warning(s).
    • All Recommendations dropdown: Displays objects in the grid that have the selected recommendation(s).
    • Last Modified user picker: Displays objects in the grid that were last modified by the specified user or users.
    • Include dismissed recommendations checkbox: Displays all dismissed recommendations for the objects in the grid.

Note:  Process models must be published in order for their design guidance to appear on the Health Dashboard.

Process Activity

The Process Activity tab shows a list of all process instances related to your environment or application that are currently on the system. By default, the processes list displays only processes that have started in the last 7 days and have not been archived. See Process Activity filters to change the status and time range.

Note:  Developers must have at least Initiator permissions to processes in order to see them on this monitoring tab.

The annotated screenshot and descriptions below define the features and metrics displayed on the Process Activity tab.

  1. Selection Checkbox: Allows a developer to perform various process options on the selected process instance.
  2. Status Icon: A quick visual indicator for each process. Possible statuses include:
    • running_blue.png Active
    • active with error process Active with Error(s)
    • iconIndicatorStatusOk.png Completed
    • iconIndicatorProgressPaused.png Paused
    • iconIndicatorStatusError.png Paused by Exception
    • iconIndicatorStatusNotDone.png Canceled
    • /iconIndicatorProcessArchived Archived

    Note:  Currently, archived processes are available under the Process Activity tab for all new Appian Cloud sites in Appian 21.1 or later versions and will be enabled on existing Appian Cloud sites via a phased approach.

  3. Process Name: The name of the process. Hyperlinked to open the process in the Process Modeler.
  4. Process Model: The version of the process model executed by the process instance. Hyperlinked to open the related process model version in the Process Modeler.
  5. Errors: Unresolved errors associated with the process. Hyperlinked to open a Process Errors dialog that displays the process' error message and its details.

    process_error_dialog.png

  6. Started By: The initiator of the process. Hyperlinked to open a user profile dialog.
  7. Active Tasks: The number of active tasks within a process. This column will only have a non-zero value for processes that have an Active, Paused, or Paused by Exception status.
  8. Start Time: The date and time when the process was started.
  9. End Time: The date and time when the process was completed or canceled.
  10. Show process details: Checkbox which displays three additional columns in the list:
    • Process ID: The ID of the process.
    • Engine: The execution engine the process is currently running on.
    • Memory (AMU): The amount of memory that the process is consuming. Process memory is expressed in AMUs. This process memory calculation runs in the background and is not reflected in real-time. Any process instance marked as "N/A" represents a calculation that has not yet occurred. See Process Model Metrics to learn more about monitoring the memory usage and performance of your processes.

Process error warnings

/monitoring process activity unresolved errors

A banner above the processes list notifies developers about all of the unresolved errors which have occurred in the last 24 hours. Clicking on View all process errors opens a dialog (see image below) which provides detailed information about each process error and gives developers the ability to filter errors.

images:resolved_errors_all_errors_dialog.png

By default, the process errors list in the dialog only displays the unresolved errors that require attention. Resolved errors (including their resolution datetime and the user who resolved them) can be viewed by clicking the Show resolved errors checkbox in the dialog's upper right-hand corner.

Search and filters

The left-hand pane of the Process Activity tab contains search and filter options.

Developers can filter listed processes in the following ways:

  1. Search: Displays processes that meet the entered search term. By default, entered terms are searched against process names. Developers can also change the search option to ID, which will run the entered term against process IDs.
  2. Processes with Errors: Only displays processes with at least one unresolved error. Note that only processes with Active or Paused by Exception statuses can have errors.
  3. Process Status: Displays processes with the selected statuses. By default, the process list displays only processes that have not been archived.
  4. Started By: Displays processes started by the one or more selected users.
  5. Process Model: Displays processes from the one or more selected process models.
  6. Time Range: Displays processes started within the specified time range. Options include:
    • All processes
    • Processes started within the last 24 hours
    • Processes started within the last 7 days (default)
    • Processes completed in the last 24 hours
    • Processes completed in the last 7 days
    • A custom time range. When Custom is selected, developers can choose to filter by process start and/or end time.

Options

When a process is selected, options will appear in the toolbar above the processes list. Multiple processes can be selected at once in order to perform operations in bulk, but note that not all options support bulk operations.

/process options

The following options are available in the toolbar:

  • Security (Single-Choice) Allows a process administrator to adjust the security of an individual process. For more information, see process security.
  • Resume (Multiple) Allows process administrators to resume paused processes.
  • Pause (Multiple) Allows process administrators to pause active processes.
  • Cancel (Multiple) Allows process administrators to cancel active processes.
  • Delete (Multiple) Allows process administrators to delete selected processes.
    • This will also delete any synchronous subprocesses and pending tasks in the selected processes.
    • When a non-adminstrator selects all processes and they have permission to delete at least one of the selected processes, the delete button will still be active. However, non-administrators will not be able to delete all processes.
  • History (Single-Choice) Allows users with at least viewer access, to view the history of a process. For more information, see process security.

Performing bulk operations on processes

In addition to being able to select and perform operations on multiple processes on a single page, developers can select and perform operations on processes across multiple pages. To do so, select all processes on the current page (A). A grey banner will then appear (B) directly below the toolbar with the option to select all processes that match the current filter criteria, for up to 10,000 processes.

/monitoring process activity bulk operation select

Customizable report

In addition to the search and filter options provided on the left-hand pane of the Process Activity tab, there is a link to the customizable report. Clicking this link opens the All Processes process report in a new tab. Changes to the All Processes report do not affect the Process Activity tab in Appian Designer and vice versa. This report does not allow you to view process errors.

See also

Process Model Metrics

The Process Model Metrics tab shows metrics related to the memory usage of process models on the system. Only process models with process instances on the system are shown in this report. By default, process models are sorted by those consuming the most to least total memory.

Process memory is expressed in AMUs. This process memory calculation runs in the background and is not real-time.

Note:  Developers are only able to view metrics on this tab for process models that they have at least Viewer permissions to.

The annotated screenshot and descriptions below define the features and metrics displayed on the Process Model Metrics tab.

  1. Refresh button: Refreshes the status of the Process Model Metrics tab.
  2. Select Another Environment button: Allows you to view how your process models are performing in another environment. Clicking this button opens a dialog that displays a list of the connected environments that have been configured in your DevOps Infrastructure in the Admin Console. Select a different environment to view the process model metrics of that environment directly in your current tab.

    Note:  Developers must have at least Viewer permissions to process models in the current environment in order to view their process model metrics from another environment.

  3. Process Model: The name of the process model. Click the linked name to open the process model in the Process Modeler. Note that any instances on the system whose process models have been deleted will be aggregated into one row and displayed with a process model name of [deleted].
  4. Status Icon: A quick visual indicator of each process model's memory usage based on the current total calculated AMU of all active instances of that model (see #5 below). Possible statuses include:

    Icon Size Status
    green_checkmark_circle.png Displayed for models whose current total calculated size is less than 100,000 AMU. The memory usage of this model's instances is generally considered low.
    orange_circle Displayed for models whose current total calculated size is between 100,000 and 1,000,000 AMU. The memory usage of this model's instances could potentially affect the system.
    red_exclamation_circle.png Displayed for process models whose current total calculated size is greater than 1,000,000 AMU. The memory usage of this model's instances is high.

    Note:  The qualifications of Low, Medium, and High memory usage are based on average resource allocation and usage. Your systems and expected usage may not reflect these boundaries. If you have concerns, contact your system administrator.

  5. Total Memory (AMU): The total size of the process model's memory, derived from the aggregated memory usage of the individual process instances. This size is based on the instance memory that has currently been calculated.
  6. Avg. Process Instance Memory (AMU): The average amount of memory each instance of the process model is consuming, based on the instance memory that has currently been calculated.
  7. Instances: The total number of instances that exist on the system for the given process model. Clicking the linked instance count will open the Process Activity view, filtered to show just the selected process model's instances with the Time Range filter defaulted to "All".
  8. Completed: The percent of instances that have completed for the given process model.
  9. Clean-up Days: The number of days set in the clean-up policy for the process model. This can be a number between 0 and 999, otherwise it will be "Never" if the process model is set to not automatically clean-up processes.
  10. Clean-up Type: The clean-up policy for the process model. This value displays either Archive, Delete, or N/A if the process model is configured to not automatically clean-up processes.

Monitoring process model AMU

It is important to look at all of the various dimensions available in the Process Model Metrics tab, when trying to optimize the performance of your process models and their instances on your system. While Total Size is a good initial indicator of potentially memory intensive process models, it is often necessary to look beyond just this value on its own.

For process models using a significant amount of memory:

  • Is the average instance's memory high? View the memory of the individual instances in the Process Activity tab to verify that there are no outliers that may be causing the average memory to spike. If all of the instances are consistently using a large amount of memory, then this might indicate that the model's design needs to be improved to reduce its overall memory footprint.
  • Are there a lot of instances? Consider updating the clean-up policy to archive or delete completed processes more frequently, especially if the completion percentage is consistently high.
  • Are the model's instances completing as expected? A low completion percentage could mean that the model is often encountering errors or generating uncommonly long-lived processes, due to incorrect or inefficient model designs. As a result, this might indicate the model's design needs to be improved to reduce its overall memory footprint.

If you're updating the design of a process model, consider the following factors which impact the memory footprint of your process models and their instances:

  • The definition of the process model itself
  • The definition of each process node
  • The number of process variables
  • The values of each process variable
  • The length of the process history
  • The values being stored in the process history
  • Any notes and attachments that the process may carry

Record Response Times

The Record Response Times tab allows you to monitor the performance of your record interfaces (both record lists and record views), and identify those with the slowest interactions.

This tab displays the top ten slowest response times for each record list or view, including details about when the slowest response times occurred and who executed them. For each of these response times, you can check the Performance tab to help you identify why a specific interaction might not be performant (see #9 below).

Note:  Developers must have at least Viewer permissions to records in order to view their response times on this tab.

The annotated screenshot and descriptions below define the features and metrics displayed in the Record Response Times tab.

  1. Refresh button: Refreshes the status of the Record Response Times tab.
  2. Select Another Environment button: Allows you to view how your record interfaces are performing in another environment. Clicking this button opens a dialog that displays a list of the connected environments that have been configured in your DevOps Infrastructure in the Admin Console. Select a different environment to view the record response times and performance tab metrics of that environment directly in your current tab.
  3. Record UI: The name of the record interface. Select the row to see more details about that specific record interface and its response times, including its top ten slowest responses.
  4. Category: The type of record interface (list or view).
  5. Maximum Time (s): The slowest response time (in seconds) captured for the record interface, over the last 30 days.
  6. Health Icon: A quick visual indicator of each record interface's response time health, based on the average response times that were collected for the interface over the last 30 days. Possible statuses include:

    Health Icon Response Time Status
    green_checkmark_circle.png Displays when the response times for this record are low.
    orange_circle Displays when the response times for this record could potentially affect the system. Consider reviewing the record's performance views (#9 below) and design to reduce its overall latency.
    red_exclamation_circle.png Displays when the response times for this record are high. Review the record's performance views (#9 below) and designs to reduce its overall latency.
  7. Record List/View Name: The name of the selected record interface. Click the link to view the record type object of the record interface.
  8. User: The name of the user who executed the record interface. Click the user link to view their user properties.
  9. Response Time (s): The response time (in seconds) for the execution of the record interface. Click the response time link to see the real-time performance of the execution and evaluation metrics.
  10. Occurred: The time at which the record interface interaction occurred.
  11. Delete History button: Removes the response times and performance metrics for the selected record interface from the system. Response times and metrics cannot be restored after deletion.

    Note:  Developers must have at least Viewer permissions to the selected record interface in order to delete the response time history.

  12. Metrics Collection toggle: Turns on or off the collection of response time and performance metrics in the background. This toggle is only available to system administrators.

    Note:  This toggle is turned on by default. Turning metric collection off may improve your overall system performance.

Monitoring record response times

When record UIs have high average response times, use their performance tab (#9 above) to troubleshoot and ensure that all of their rules and queries are performant.

Record Sync Status

The Record Sync Status tab displays status information for all record types with sync enabled. This includes the source type, sync status, time of the last sync, and the total rows synced for each record type.

From this tab, you can easily perform cross-environment monitoring for all synced record types that you have access to view by switching between your connected environments, both local and remote. Drill down into a specific record type to view its sync history and any errors or warnings that occurred during the course of the sync activity.

The annotated screenshot provides a description of each grid column on the Record Sync Status tab.

  1. Refresh button: Refreshes the sync statuses.
  2. Select Another Environment button: Allows you to select a local or remote connected environment and view the status information for all synced records in the selected environment.
  3. When you select the checkbox next to a record type, different options will appear in the toolbar above the list:
    • Start Full Sync button: Triggers a manual sync of the selected record type. If you do not have permission to edit the record type, this button is disabled.
    • Cancel Full Sync button: Cancels an active full sync on a selected record type. This button only appears if you select a record type that is actively syncing. If you do not have permission to edit the record type or the data is already synced, this button is disabled.
  4. Checkbox: Allows you to start a full sync or cancel an active sync on the selected record type.
  5. Record Type: A link displaying the name of the record type. Click the link to access the Sync History grid for the record type.
  6. Source Type: The data source for the record type. The possible source options are Database, Salesforce or Web Service.
  7. Last Sync Status: The current sync status of the record type. Possible statuses include:

    Icon Status Meaning
    Running A manual or scheduled sync is taking place, the record type is saving, or the record type is being imported to the environment.
    Canceling A manual or scheduled sync is being canceled.
    Completed A manual or scheduled sync, record type save, or record type import has successfully completed.
    Failed An error occurred while attempting to sync the record type and the record type is unavailable. Click the link next to the icon to open the Sync Alerts dialog.
    Failed and Skipped An error occurred while attempting to sync the record type, but the record type is still available. Since this sync was skipped, queries will return data from the most recent successful sync. Click the link next to the icon to open the Sync Alerts dialog.
    Failed and Retrying The sync initially failed and the system will retry a few times before failing. After failing, the record type will be unavailable.
    Canceled A manual or scheduled sync was canceled. The record type returns to the previous sync status. If the previous sync status was Failed, then the record data will be unavailable. Click the link next to the icon to open the Sync Alerts dialog.
    Approaching Limit The record type was able to sync but it's approaching the row limit.
    Limit Reached The record type was able to sync but the row limit has been reached.
  8. Last Sync Time: The date and time of the most recent sync.
  9. Total Synced Rows: The number of rows currently synced for the record type. If the most recent sync failed, then a dash is shown in this column.

Monitoring synced records across environments

As an administrator, you need a way to restart a sync for a record type in a remote environment. You also need a way to quickly view the statuses, sync history, and errors associated with your synced record types across multiple environments. This visibility allows you to easily resolve issues that cause your syncs to fail.

The Select Another Environment button on the Record Sync Status page opens the Select Environment dialog, which lists all of your local and remote connected environments.

/Cross Environment Monitoring Select

After you select a specific environment from the list, click VIEW RECORD SYNC STATUS to switch to the select environment and view the statuses for all of the synced record types deployed in the selected environment.

Note:  You can view the status for synced record types if they have been deployed to an environment that allows a connection from Appian to the selected environment. See Managing Environments for more information.

The Record Sync Status tab will now show the sync statuses for all record types deployed in the selected environment only. In order to view synced records in a local environment, developers must have at least Viewer permissions to the record types. When connecting to a remote environment, developers only have access to the record types they have access to in the local environment.

Also note that only users with edit access to the record type in the selected environment can start a sync.

Record sync alerts dialog

When the sync status is Failed, Failed and Skipped, or Canceled, you can click on the link in the Sync Status column to open the Record Type Sync Alerts dialog. This dialog provides more information and details about the failed or canceled sync.

screenshot of an error in the record sync alert dialog

Depending on the type of alert, the dialog can contain the following properties:

Property Description
Record Type A link to the record type.
Source Type The source type of the record type. Possible values are Database, Salesforce or Web Service.
Initiated by Who started the sync. Depending on the type of sync, this value can be System, Administrator, or the username of the user who started the sync.
Alert The cause of the alert.
Caused By Any additional details provided by the source to help troubleshoot the error.
Details A link to the process instance that updated the source and up to five primary keys from the source rows that were updated by the write operation, but not synced in Appian. This property is only displayed when a sync fails on a record type that uses a database table or Salesforce object as the source.

For information on resolving errors with your sync, see Troubleshooting Syncs.

Sync history

When you click into a specific record type in the grid list from the Record Sync Status tab, you are directed to the Sync History grid for the selected record type. This page shows information about the previous and currently running syncs for the record type.

You can also access this Sync History grid from the Data Sync tab in record type object.

Like the Record Sync Status tab, you can access any errors for your record type's syncs from within its history.

The annotated screenshot and descriptions below define the buttons and grid columns displayed in the Sync History grid page.

  1. Link to open the record type object.
  2. Status: The sync status of the record type. If the status is Failed or Failed and Skipped, you can click the link to open the Sync Alerts dialog. Possible statuses include:

    Icon Status Meaning
    Running A manual or scheduled sync is taking place, the record type is saving, or the record type is being imported to the environment.
    Canceling A manual or scheduled sync is being canceled.
    Completed A manual or scheduled sync, record type save, or record type import has successfully completed.
    Failed An error occurred while attempting to sync the record type and the record type is unavailable. Click the link next to the icon to open the Sync Alerts dialog.
    Failed and Skipped An error occurred while attempting to sync the record type, but the record type is still available. Since this sync was skipped, queries will return data from the most recent successful sync. Click the link next to the icon to open the Sync Alerts dialog.
    Failed and Retrying The sync initially failed and the system will retry a few times before failing. After failing, the record type will be unavailable.
    Canceled A manual or scheduled sync was canceled. The record type returns to the previous sync status. If the previous sync status was Failed, then the record data will be unavailable. Click the link next to the icon to open the Sync Alerts dialog.
    Approaching Limit The record type was able to sync but it's approaching the row limit.
    Limit Reached The record type was able to sync but the row limit has been reached.
  3. Start Time: Displays the timestamp of when the sync started in the user's timezone. When checking the time of your scheduled sync, you may notice that it didn't occur at the exact time at which you scheduled it. There are a variety of possible causes:
    • Limit for syncs running simultaneously: If you have multiple record types scheduled to sync at the same time, not all of them can occur at exactly the scheduled time. Appian limits the number of simultaneous syncs running to 2 per application server. For example, if multiple record types are set to sync at 3:00 AM, one of the scheduled syncs may not complete until 3:02 or 3:10 AM. If you have other processes that have significant resource use scheduled to occur at this time, this may also cause your syncs to complete later than expected.
    • Failed & retrying: It is possible that something caused your sync to fail. In some cases, the system will try again before ultimately failing or successfully completing the sync. There are two possible methods of retrying:
      • Batch Retry When a full sync occurs, the data is synced in batches of up to 1,000 records. If a single batch fails for any reason, the sync pauses and retries again only for the batch that failed. Overall it can retry up to twice for a single batch and a total of 10 times across all batches before it fails.
      • Full Retry In addition to retrying a single batch, the system will also retry the entire sync in situations where it's likely to succeed. For example, if your sync failed because of a connection issue, Appian will try to sync again; however, if the sync failed because of a schema mismatch, the sync will not retry. If a completed sync had to retry multiple times, it may be a few minutes behind schedule.
    • Check your timezone: Make sure that you selected the right timezone when you set up your scheduled sync. If not, you can change this by editing the sync schedule settings in Data Sync.
    • Daylight savings time: If your timezone or region observes daylight savings and your sync is scheduled for one of the hours in which daylight savings time changes, your sync may not run when the time changes. To avoid this, choose a time after 2 AM.
  4. End Time: Displays the timestamp of when the sync ended in the user's timezone.
  5. Duration: The total time (in seconds) that it took the record type to sync.
  6. Events: The event that triggered the update. The possible events are:
  7. Initiated By: Depending on the type of sync, this value can be System, Administrator, or the username of the user who started the sync. Only users with access to edit the record type will be able to view the Initiated By column.
    • If the value is Administrator or a username, the sync was triggered by clicking START FULL SYNC, saving the record type, or by importing a record type.
    • If the value is System, the system initiated the sync by writing data from Appian to your source, using a scheduled full sync, or by retrying a failed sync.
  8. Total Synced Records: The record count from the sync at the end of the sync.
  9. Total Source Rows: The record count from the source at the time of the sync.
  10. Refresh button: Refreshes the entire page.
  11. Start Sync button: Triggers a manual sync of the record type. If you do not have at least Editor permissions to the record type, this button is disabled.

You can sort the results in the Sync History grid by Start Time, End Time, Duration, Total Synced Records, and Total Source Rows.

Query Performance

The Query Performance tab centralizes key information about each query to your record types. This allows you to quickly identify which parts of your application may experience slow queries.

This summary includes the names of users and design objects involved in running the queries, as well as critical information from system logs throughout your environment.

This tab captures queries that are run by developers in Appian Designer and by users interacting with your applications.

To understand the overall performance of an interface evaluation, see the Performance view for the interface.

The annotated screenshot provides a description of all key elements on the Query Performance tab:

  1. Capture Query Data option: By default, Appian does not capture information for display in the Query Performance tab. Use the Capture Query Performance option to enable the capture of information about queries to record types in your environment.

    Tip:  To avoid potential performance impacts in production environments, only enable this setting if you are actively troubleshooting.

  2. Switch Environments: By default, Appian displays a grid of queries run in your current environment. Click Switch Environments to view the query performance in any of your connected environments.
  3. Filters: You can filter by values in any column of the details grid.
  4. Grid: This grid contains the key details about your queries. Columns include:

    Column Description
    Query UID A unique identifier for the query. Click the link to see an expression that illustrates the record types, fields, filters, and functions used in the query.
    Query Start Time The date and time at which the query started running.
    Query Execution Time The time (in milliseconds) that the query took to wait for resources and run.
    Query Wait Time The time (in milliseconds) the query waited for resources.
    Started By The username of the user who ran the query.
    Evaluation ID A unique identifier for a single evaluation of the interface or expression rule used to run the query. A single evaluation of an interface or expression rule can include multiple queries, which will be listed separately in this table. Use this ID to evaluate the cumulative performance of all queries in an interface or expression rule.
    Interface The interface where the user ran the query. This column may contain an expression rule if the query was run from a process model, or may be blank if the query was run directly from a record view or record list. Click this link to open the identified design object.
    Expression Rule The design object used to run the query, usually an expression rule. This column may be blank if the query was run directly from a record view or record list. Click this link to open the identified design object.
    Record Type The record type used in the query. Click this link to open the identified record type object.
    Component The component used to run the query. In some instances, this column may contain a function, record view, or record action, depending on how the interface or expression rule is configured.
    Error Code The Appian error code. This column is only populated if the query evaluation encounters an error. Learn more about error codes for a!queryRecordType function.

Portal Monitoring

The Portal Monitoring tab allows you to view key metrics and details that are vital to understanding how users are interacting with your portals and what issues they may be experiencing. Regularly monitoring these metrics alerts you to any potential issues related to response times or availability and helps you deliver exceptional user experiences while maintaining high operational standards.

To view metrics for other connected environments, use the icon to switch between environments. This is especially helpful to view metrics for portals in a production environment without requiring access to the environment.

The annotated screenshot provides a description of all key elements on the Portal Monitoring tab. For more information about using the Portal Monitoring tab to troubleshoot issues in a portal, see Troubleshooting a Portal.

  1. Refresh button: Refreshes the data in the grid.
  2. Select Another Environment button: Allows you to view how your portals are performing in another environment. Clicking this button opens a dialog that displays a list of the connected environments that have been configured in your DevOps Infrastructure in the Admin Console. Select a different environment to view the portal monitoring metrics of that environment directly in your current tab.

    Note:  You must have at least Viewer permissions to portals in the current environment in order to view their metrics from another environment.

  3. PUBLISHED STATUS filter: Allows you to filter the grid by the publication status of the portal. Options are Published, Not Published, and Published with errors. By default, all statuses display.
  4. TIME PERIOD filter: Allows you to filter the metrics that display on the grid by time period. Options are Last 24 Hours, Last 7 Days, Last 30 Days, Last 90 Days. The default time period is Last 7 Days.
  5. Portal Name: Name of the portal object. You can click the link to open the portal object.
  6. Error Metrics:
    • Error Count: The total number of errors that occurred on the portal. If a user encountered an error within the last 24 hours, a icon displays next to the error count. Click the error count to view the Portal Errors grid that lists the error messages.
    • Error Rate: This value represents the number of errors divided by the number of traffic requests to the portal.
  7. Traffic Requests: The total count of all page loads and user interactions with the portal.
  8. Latency Metrics:
    • Median Latency (s): The median latency value.
    • 90th Percentile Latency (s): The slowest response time of the fastest 90 percent of requests.
    • 99th Percentile Latency (s): The slowest response time of the fastest 99 percent of requests.
  9. Published Status: The published status of the portal: Published, Not published, Published with errors.
  10. Last Published: Displays the date/time stamp of when the portal was last published and the user who published the portal.

Latency, traffic, and error rate metrics explained

While the goal is designing and publishing high-quality portals that provide an issue-free user experience, problems can occasionally occur. These metrics are meant to alert you when problems arise with the speed or availability of your portals.

A better understanding of these monitoring metrics will help you understand what's happening and where to begin troubleshooting if you see longer than expected latency times or high error rate percentages on this tab.

Latency

A simple way to think about latency is as a measure of the "waiting time" between when you do something and when you see a result or get some sort of feedback from the action you've taken.

In the context of portals, latency could be a measure of how long it takes for:

  • The initial portal page to load.
  • User-entered data to submit after they click a button.
  • A rule in an interface to evaluate.

The latency metrics displayed on the Portal Monitoring tab represent the delay between all traffic requests and the portal server's response to those requests.

Traffic requests

A traffic request occurs anytime a page loads or a user interacts with the portal, like when they click a button. Depending on the portal and the time period, traffic requests can number in the hundreds or even thousands.

The number of traffic requests also provides useful context for error rate and latency metrics. For example, a 50% Error Rate may not be as worrisome over a handful or traffic requests and a double-digit Error Count may not be reason for alarm if the portal has received thousands of traffic requests for a given time period.

Keeping an eye on traffic requests helps you ensure your portals can handle high user demand while remaining both available and performant.

Error rate

Traffic requests have the potential to result in an error. The error rate is a percentage value that represents the proportion of traffic requests that resulted in an error.

A high error rate can be an indicator that users are encountering serious problems when they interact with a portal. A icon displays next to the error count when a user has encountered an error within the last 24 hours.

How to act on these metrics

See Troubleshooting a Portal for more information on how to act on these metrics, including how to troubleshoot errors and how to troubleshoot latency issues.

View Portal Errors grid

From the Portal Monitoring tab, you can view a Portal Errors grid to help determine which objects could be causing the errors and where to look next for more information. You can also download the Portal Error Log, which can be accessed above the grid.

In Appian Cloud environments where enhanced portal logs aren't available, you won't be able to click the number in the Error Count column to view the Portal Errors grid. Instead, download the Portal Server Log to troubleshoot errors.

To view error details from the Portals Monitoring tab:

  • For the portal that you want to view errors for, click the number in the Error Count column. The Portal Errors grid displays.

Open in Github Built: Fri, Jun 14, 2024 (05:47:37 PM)

Monitor View

FEEDBACK