Health Check

Health Check is now available within the Administration Console. If you are already using the Health Check plug-in, Appian recommends switching to this new and improved version of Health Check. With this release, the Health Check plug-ins on the AppMarket are now deprecated. For help setting up Health Check from the Administration Console, see this page.

What Is Health Check?

Health Check provides insights into application design patterns and performance risks in your environment. The insights are summarized in a report that includes links to suggestions for mitigating any identified risks.

Health Check is available to system administrators on any environment and is located in the Appian Administration Console. To learn more about how to set up, schedule, and run Health Check, see the instructions here.

Prerequisites

To set up, schedule, and run Health Check from the Admin Console, the following conditions must be met:

  • The Appian Health Check plug-in must be uninstalled from all application servers.
    • Note: If you want to run Health Check using a Continuous Integration (CI) tool, such as Jenkins, you will need to continue using the Appian Health Check plug-in instead of the Admin Console.
  • If you have a distributed Appian installation with multiple application servers, shared logs must be configured.
  • You must have Health Check credentials for Appian Community. Your organization only needs one set of credentials, which can be used for multiple environments. You can request credentials by opening a support case.

The Report

To generate a Health Check report, Health Check collects data about your environment and analyzes it based on Appian best practices. The report provides insights and warnings about the following four areas of your environment:

  • Design: The architecture, patterns, and configurations of Appian applications and their objects. For example: data models, security models.
  • User Experience: The performance of user interfaces. For example: user responsiveness of record types or reports.
  • Infrastructure: The ability of the underlying hardware and software to support the Appian platform features and usage. For example: CPU, memory, storage.
  • Configuration: The architecture and settings used by the Appian software installation. For example: Appian version, supporting hardware and software, custom authentication.

In addition, each Health Check report contains:

  • A short summary about the individual run.
  • Graphs that highlight historical trends about the environment (including user activity, average response times, and resource utilization).
  • Details regarding the memory usage of an environment’s running process instances.

To help you make the most of your Health Check report, see Understanding the Health Check Report.

Running Health Check

It is a best practice to schedule Health Check to run on each of your environments, and to have a member of your team regularly review the reports. Health Check reports highlight important information in different environments, providing feedback at each phase of your application development lifecycle.

When building your application, Health Check identifies design and configuration problems early on, when they are easiest and cheapest to fix. When testing your application, Health Check can pinpoint potential functional and performance risks. And when your application is in production, Health Check helps to monitor environment performance and infrastructure capacity trends over time.

Caution: Running Health Check may increase your environment’s system load and degrade performance for users. Appian recommends running Health Check during non-business hours in a production or active environment. When scheduling Health Check, be sure to take into consideration business hours across time zones (if that applies).

How It Works

/hc 3 step chevron.png

Each Health Check run consists of three steps: data collection, data review, and data analysis. During each run, Health Check will:

  1. Collect information about your environment’s configurations and design, and generate a zip file.
  2. Allow system administrators to review and edit the contents of the zip file (optional).
  3. Upload the zip file to Appian Community for analysis, generate a Health Check report, and share the report with system administrators.

To run Health Check, you must first set it up in the Admin Console.

Note: Data collection zip files uploaded to Appian Community for analysis are not shared with any third parties, and are not publicly visible.

Step 1: Data Collection

Data collection is the first step in each Health Check run. During data collection, Health Check generates a zip file of existing Appian logs, as well as information about application design patterns, configurations, and objects. This zip file is used in the data review and analysis steps described below. For more details about what type of information is collected, see Health Check Data FAQ.

The amount of time it takes for an environment to perform data collection will vary. However, it is important to note that the time is directly proportional to the number of applications and objects within the environment. The larger the environment, the longer data collection is likely to take. The historical grid of your Health Check runs can help you estimate how long data collection will take on average for your environment.

Step 2: Data Review

Data review is an optional step that allows system administrators to download the generated data collection zip file and review its contents. System administrators can remove any logs they don’t want to share with Appian and upload a new zip file (with the same structure) for analysis. Removing log files will reduce the scope of the Health Check analysis and may limit the findings provided in the report.

System administrators can opt to autoapprove the data review step and skip it for future runs by selecting the Autoapprove this step for future runs checkbox while a run is in progress.

/hc enable autoapprove checkmark step2

Step 3: Data Analysis

After data review, the data collection zip file is uploaded to Appian Community for analysis. Once Community has completed its analysis, it generates a Health Check report. For more information on how to understand the results, see Understanding the Health Check Report.

Note: Generating your Health Check report may take a while (up to 24 hours). Take this into account when planning Health Check runs.

For more information on how Appian handles your Health Check data during analysis see the Health Check Data FAQ.

Automatic Upload

All Health Check runs include the data collection, data review, and data analysis steps described above. However, these steps may run automatically or require manual intervention, depending on how you configure your Health Check Settings.

Appian recommends enabling automatic upload to ensure that Health Check runs regularly, so that your team can focus on analyzing the report instead of managing the process.

When automatic upload is enabled, your environment will automatically upload the zip file generated during data collection to Appian Community for analysis. Once a Health Check report has been generated, an email will be sent to all environment system administrators and members of the Health Check Viewers group. The report will be made available in the following places:

  1. Posted to members of the Health Check Viewers group on the environment’s News feed.
  2. Linked from the environment’s Health Check page in the Admin Console.

If you choose to not set up automatic upload, system administrators must download the data collection zip file from the Admin Console and manually request an analysis on Appian Community. The Health Check report will then be emailed directly to the system administrator who uploaded the zip file to Community.

/hc automatic upload

Open in Github

On This Page

FEEDBACK