Working with custom pages
Custom pages are user-defined pages that contain charts with custom metrics or built-in metrics that you specify. Custom pages are associated with a source and are accessible from the left pane of protocol pages, so you can view custom charts within the context of other protocol metrics for an application, device, or device group.
Note: | Custom pages can only be viewed on Application, Device, and Device Group protocol pages by selecting Switch to legacy layout at the bottom left of the page. As an alternative to building a custom page, you can build a dashboard, which also contains customized charts of metrics that are important to you. For more information, see Create a dashboard. |
The following information shows you how to create custom pages and add charts to them.
Create a page
Important: | Assigning a custom page with trends to more than 1,000 devices might affect system performance. |
Delete, disable, enable, or copy custom pages
- Click the System Settings icon at the top of the page.
- Click Pages.
- Search for the custom page that you want to manage. The Filter text box above the table supports substring matching and regular expressions.
-
Select the checkbox next to the page(s) and then complete one of the
following steps:
- Click Copy. The name of the copied page is generated automatically by appending the word "(copy)" to the original name.
- Click Delete to permanently remove the custom page from the ExtraHop system.
- Click Enable. Custom pages that were previously disabled will become active and appear in the left panel.
- Click Disable. The selected custom pages will become inactive and not be accessible from the left pane of protocol pages.
Trend configuration
You can add trend lines to your custom page. From the Trend Configuration window, you can specify the following information:
- Configure the Trend Lines
- Determine the Weighting Model
- Add an optional Multiplier
- Configure Exclusion Intervals
- Enter an optional Description
- View the trend History
Trend Line
The Trend Line tab provides the following configuration settings to define the trend line:
- Name
- In the Name field, type a name for the trend.
- Author
- In the Author field, type a custom name. The author is set by the Discover appliance based or set manually by the user.
- Disable Trend
- Select Disable Trend to stop calculating data for the trend line.
- Metric
- In the Metric field, select a metric to calculate data for your trend. Click the gear
icon to the right of this field. Trends with dataset and sampleset metrics have
the following additional options:
- Merge
- Merges all the datasets and applies the trending function to one big dataset.
- Mean
- Takes the mean of each dataset.
- Percentile
- Allows you to set a percentile value of datasets.
- Standard Deviation
- Calculates the normal deviation compared to the current trend with the same
standard deviation parameters as the trend. These parameters can be absolute or
relative, and population or sample. Normalization displays the standard deviation
relative to mean. Click the Normalization drop-down list
and select one of the following options.
- Absolute
- Displays the standard deviation as a constant.
- Relative to Mean
- Displays the standard deviation relative to the mean.
Note: If the trend is not a standard deviation, it is calculated as an absolute sample. - Ratio
- Click the Ratio checkbox if the data will be measured as a ratio.
- Window
- In the Window field, select one of the following calculations from a drop-down list:
- Same Hour of Week
- Calculates the trend within a specified 1-hour window each week.
- Same Hour of Day
- Calculates the trend within a specified 1-hour window each day.
- Minute Rolling Average
- Calculates the trend based on the average of the data gathered each minute within a specified amount of time from the present time.
- Hour Rolling Average
- Calculates the trend based on the average of the data gathered each hour within a specified amount of time from the present time.
- Lookback
- In the Lookback field, type the number of minutes of lookback to begin the trend calculation.
Weighting Model
Click the Weighting Model tab to select options for how to weigh the trend line. For more information about weighting models, see the ExtraHop blog post, Using Math Adds up to Better Alerts.
- Mean
- In the Mean field, select one of the following options from the drop-down list to
calculate the average:
- Linear Average
- Calculates the average with all data points weighted equally.
- Single Exponential
- Calculates the average with the most recent data points weighted more heavily.
- Double Exponential
- Calculates the average with the most recent data points weighted the most heavily.
For linear averages, the most recent value is weighted at 1 times the oldest value by default. For single and double exponential means, enter a number to weight the most recent value.
- Percentile
- In the Percentile field, select one of the following options from the drop-down list
to specify the percentile value that will be the basis for creating the trend:
- Percentile
- Records the trend with data points from a user-specified percentile.
- Min Value
- Records the lowest data point gathered during the time interval.
- Max Value
- Records the highest data point gathered during the time interval.
- Regression
- In the Regression field, select one of the following options from the drop-down list:
- Linear
- Calculates steadily increasing trends based on previous trends that are equally incremental.
- 2nd Degree Polynomial
- Calculates exponentially accelerating trends by projecting a curve with the
following equation:
y = ax2 + bx + c
- Standard Deviation
- In the Standard Deviation field, select one of the following options from the
drop-down list to calculate the normal deviation compared to the current trend:
- Type
- Applies a sample-based or population-based standard deviation.
- Normalization
- Displays the standard deviation relative to mean.
Note: If a trend is a standard deviation, its associated alerts apply the same parameters as the trend. If the trend is not a standard deviation, then the alert is calculated as "sample" and "absolute". - Static Value
- In the Static Value field, type a number that will be the basis for calculating a static value. A static value is useful for monitoring constant lines for service level agreements (SLAs) in a chart.
- Time Delta
- Select the Time Delta option to display the oldest trend, resulting in a time delta option based on the lookback window.
- Trimean
- Calculates the weighted average of the 25th, 50th, and 75th percentile values.
- Winsorized Mean
- In the Winsorized Mean field, select one of the following options from the drop-down list to replaces the most outlying values with the highest and lowest remaining values. Values above the 90th percentile become the same value as the 90th and values below the 10th percentile become the same value as 10th.
Multiplier
The Multiplier tab allows you to specify a multiple of the trend to appear in your chart, which can be useful for banding.
- Multiplier
- In the Multiplier field, type a number by which to multiply the trend line.
- Offset
- In the Offset field, type a number to display an offset line along the x-axis.
Positive numbers offset forward and negative numbers offset backward. Click the
drop-down list and select one of the following:
- (absolute)
- Displays the offset as a constant.
- per minute
- Calculates the offset per minute.
- per hour
- Calculates the offset per hour.
Exclusion Intervals
The Exclusion Intervals tab displays all the defined exclusion intervals that can be applied to trends. From this page, you can configure exclusion intervals. The Exclusion Intervals table contains the following information:- Name
- Specifies the name of the exclusion interval.
- Description
- Provides a space for an optional, user-defined description.
- Type
- Specifies the type of exclusion interval, which includes the following options:
- One-time
- Specifies an exclusion period that occurs only once from a designated start time (date and time) to a designated end time (date and time).
- Daily
- Specifies an exclusion period that occurs every day from a designated starting hour to a designated ending hour.
- Weekly
- Specifies an exclusion period that occurs every week from a designated start time (day and time) to a designated end time (day and time).
Thank you for your feedback. Can we contact you to ask follow up questions?