Resources

This section provides the purpose, elements, and actions performed on the Resources pages.

System Health
Disk Utilization
Index Management
Task Server

Purpose

The System Health page monitors system health metrics for Controller and CoPilot (system health) or Controller only (network health), views overall health status, services status, alerts, and creates alert configurations.

Elements

Monitor: Dropdown to select monitor (Controller or CoPilot for system health; Controller for network health).
Time Period: Dropdown to select time period (Live View, Last Hour, etc.).
Start: Text field for start date and time.
End: Text field for end date and time.
Apply button: Applies the selected time period filters.
Overall Health: Section displaying overall health status (Up/Down).
Services: Section showing services status with count of down services and the View All Services button.
Open Alerts: Section showing count of open alerts.
Alert Configurations: Section showing count of alert configurations.
Metrics: Multiselect dropdown for selecting metrics (CPU Used, Disk Free, Memory Used) on system health view.
Create Alert button: Opens a dialog to create an alert configuration.

Actions

View System Health

To view system health:

Go to Settings > Resources > System Health.
Select Monitor (Controller or CoPilot), set Time Period or Start/End, and click Apply. Review Overall Health, Services, Open Alerts, Alert Configurations, and Metrics.
Optionally, click Create Alert to add an alert configuration.

The system health view shows health metrics for the selected monitor.

Parameter Details

CoPilot Parameter Name	Description
Monitor	Select the monitor to view health metrics for (Controller or CoPilot).
Time Period	Select the time period for viewing health metrics (Live View, Last Hour, Last 24 Hours, etc.).
Start	Specify the start date and time for the custom time period.
End	Specify the end date and time for the custom time period.
Overall Health	Displays the overall health status of the selected monitor (Up or Down).
Services	Shows the number of services that are down and provides a button to view all services.
Open Alerts	Displays the count of currently open alerts.
Alert Configurations	Displays the count of configured alert configurations.
Metrics	Select one or more metrics to display (CPU Used, Disk Free, Memory Used).

View Network Health

To view network health:

Go to Settings > Resources > System Health and select Monitor (Controller) for network health view.
Set Time Period or Start/End and click Apply. Review Overall Health, Services, Open Alerts, and Alert Configurations.

The network health view shows health metrics for the Controller.

Purpose

The Disk Utilization page displays disk usage information, estimated disk runway, and allows you to configure data retention policies for various data types.

Elements

Disk Usage & Projections: Section showing disk usage and projections for different data types.
Estimated Disk Runway: Section showing estimated disk runway with the Attach Additional Disk button.
Data Retention Policy: Section for configuring data retention policies for various indices.
Critical Capacity Management: Slider for setting critical capacity threshold percentage.
Sort By: Dropdown to sort data retention policies.
Disks table: Table displaying disk information with columns for Disks, Size, Used, Available, % Used, and Mount Point.

Actions

View Disk Utilization

To view disk utilization:

Go to Settings > Resources > Disk Utilization.
The page appears with Disk Usage & Projections, Estimated Disk Runway, Data Retention Policy, Critical Capacity Management, and Disks table.
Optionally, use Attach Additional Disk, adjust retention policies, or Sort By to manage disk and retention.

The Disk Utilization page shows disk usage and retention configuration.

Parameter Details

CoPilot Parameter Name	Description
Disks	Shows the disk device name.
Size	Shows the total size of the disk.
Used	Shows the amount of disk space used.
Available	Shows the amount of disk space available.
% Used	Shows the percentage of disk space used.
Mount Point	Shows the mount point where the disk is mounted.
Estimated Disk Runway	Displays the estimated time until disk capacity is reached based on the current usage rate.
Critical Capacity Management	Set the critical capacity threshold percentage (default: 10%).
Data Retention Policy	Configure retention period for different data types (local-metrics, Performance, Security Audit, etc.).
Retention Period	Set retention period in days or select Unlimited, 6 Months, or 1 Year.
Used Space	Shows the amount of disk space used by the data type.
Records	Shows the number of records stored.
Avg. Storage/Day	Shows the average storage used per day.

Purpose

The Index Management page gives you control over Elasticsearch indices used by CoPilot. You can view index status, document count, and size; delete, filter, search, and download indices; and customize displayed columns.

Elements

Indices table: Lists CoPilot indices with index name, document count, size, and related metrics.
Index Name: Column and filter option to select or filter indices by name (e.g., Index name contains “NetFlow”).
Filter icon / +Filter: Filter conditions and additional conditions for the indices list.
Column icon: Toggle which columns to display or hide.
Search box: Search indices by keywords.
Delete Indices: Button to delete selected indices (consult Aviatrix support before deleting).
Download icon: Download selected indices as CSV.

Actions

View and Manage Indices

To view and manage indices:

Go to Settings > Resources > Index Management.
The page appears with the indices table (Index Name, Status, Doc Count, Size). Use Search, Filter, or Column to narrow or customize the list.
Optionally, select indices and use Delete Indices or Download (consult Aviatrix support before deleting).

The Index Management page shows Elasticsearch indices and supports filter, search, and export.

Parameter Details

CoPilot Parameter Name	Description
Index Name	Shows the name of the index.
Status	Shows the status of the index.
Doc Count	Shows the number of documents in the index.
Size	Shows the size of the index.

Purpose

The Task Server page displays information about scheduled tasks: overview (runtime statistics, failures, last run) and history (past task executions).

Elements

Tasks table (Overview): Table displaying current task statistics: Name, Total Runtime, Avg. Runtime, Failures, Last Run, Last Duration, Frequency.
Tasks History table (History): Table displaying historical execution: Name, Duration, Start Time, End Time, Skipped, First Run, Status, Message.
Show filters button: Button to show filters for the task table.
Select columns button: Button to select columns for the task table.
Export button: Button to export task data.
Search: Search box for filtering task table content.
Oldest Record: Text displaying the oldest record timestamp.

Actions

View Task Overview

To view task overview:

Go to Settings > Resources > Task Server and open the Overview view.
The Tasks table appears with Name, Total Runtime, Avg. Runtime, Failures, Last Run, Last Duration, Frequency.
Optionally, use Show filters, Select columns, Export, or Search.

The task overview shows current task statistics and execution summary.

Parameter Details

Overview table:

CoPilot Parameter Name	Description
Name	Shows the name of the task.
Total Runtime	Shows the total runtime accumulated for the task.
Avg. Runtime	Shows the average runtime for task executions.
Failures	Shows the number of task execution failures.
Last Run	Shows the timestamp of the last task execution.
Last Duration	Shows the duration of the last task execution.
Frequency	Shows how often the task runs (e.g., 1m, 1h, 15m).

View Task History

To view task history:

Go to Settings > Resources > Task Server and open the History view.
The Tasks History table appears with Name, Duration, Start Time, End Time, Skipped, First Run, Status, Message.
Optionally, use Show filters, Select columns, Export, or Search.

The task history shows past task executions and their status.

Parameter Details

History table:

CoPilot Parameter Name	Description
Name	Shows the name of the scheduled task.
Duration	Shows the duration of the task execution.
Start Time	Shows the start time of the task execution.
End Time	Shows the end time of the task execution.
Skipped	Shows if the task was skipped.
First Run	Shows if the task was run for the first time.
Status	Shows the status of the task execution.
Message	Shows the message of the task execution.

Concepts & Architecture

Guides

Reference

Purpose

Elements

Actions

Parameter Details

Purpose

Elements

Actions

Parameter Details

Purpose

Elements

Actions

Parameter Details

Purpose

Elements

Actions

Parameter Details

Parameter Details

​Purpose

​Elements

​Actions

​Parameter Details

​Purpose

​Elements

​Actions

​Parameter Details

​Purpose

​Elements

​Actions

​Parameter Details

​Purpose

​Elements

​Actions

​Parameter Details

​Parameter Details

Purpose

Elements

Actions

Parameter Details

Purpose

Elements

Actions

Parameter Details

Purpose

Elements

Actions

Parameter Details

Purpose

Elements

Actions

Parameter Details

Parameter Details