Introduction

The Availability Details application will provide you with a summary of the availability or detailed outages of resources, service groups, and synthetics over a certain time period.

Configuration Parameters

• Query: Use the query to select the entities that you wish to include in the report.
  • Default query: The default query {state=active and monitorable=true} will be populated by default when an asset inventory app opens. The user can modify/delete the default query and run a custom query.
  • Using an OpsQL query, you can customize the report result. If users did not select state and monitorable attributes in the query string, in that case the user selection query would be appended by default with state and monitorable attributes.
    For example, if a user only selects the agentInstalled attribute, the query will automatically show as append state = 'active' AND monitorable = true
    The query will appear as follows:
    state = "active" AND monitorable = "true" AND (agentInstalled = "xxxxxx")
• Client Selection: You can select Single Client, Multi Clients, or All Clients from the dropdown list. Only selected client data will get into the report.
  • The Select Clients dropdown allows you to choose up to 50 clients
  • When Multi-Client is selected, the Share and Notifications settings on analysis will follow the same behavior as the All Clients option.
• Availability By: Defines the availability to be presented by resource, service group, or synthetic script.
  • Resource: View availability at the resource level.
    • Inlcude Insights: Select this checkbox to include insights in the report. When this option is selected, Select Availability State will no longer be available
    • Exclude Schedule Maintenance Time: Select this checkbox to exclude scheduled maintenance windows in the report. Selecting this option will recalculate the availability percentage without the duration of the scheduled maintenance.
    • Include Deleted Resources: Select this checkbox to include deleted resources in the report.
  • Service Group: View availability at the service group level.
  • Synthetic Script Availability: Analyze the availability, breaches, and errors as a percentage for each transaction and location within synthetic resources.
• Select Availability State: View availability based on the state. The options are Up, Down, Unknown, or Undefined. This selection is optional. If nothing is selected, it will default to Down time.
• Time Duration: Select the time period over which your environment down time was analyzed.
• Supported Analysis Period: Supported analysis periods are: Last 24 hours, 7 days, Last month, Last 3 months, and specific period.
  • Included Hours: When analyzing data from Last 3 Days, Last 7 Days, or Last Month, users have the option to narrow down the analysis to specific hours. The options are 24 Hours Every Day, Same Time Every Day, Same Time Every Weekday, or Different Times Every Day. This selection is optional.
• Attributes Selection: Specify the attributes, including custom attribites, of the selected entities that you want to include as columns in the report. You can customize the order of default attribute by using drag and drop. You are allowed to select a maximum of 25 attributes.
• Supported Format: Reports are generated only in XLSX format.

Refer to the Resource Availability document to see how the Resource Availability State% works.

Excluding Scheduled Maintenance Time

When creating an Availability Report, a user may want to calculate resource availability by excluding a scheduled maintenance time from the availability calculation. In this mode, scheduled maintenance should not be counted as UP, DOWN, or UNKNOWN.

Instead, the maintenance duration should be removed from the denominator used to calculate availability percentages.

This allows the report to reflect only the effective service period — the time during which the resource was expected to be operational.

Excluding scheduled maintenance times enable customers to generate availability reports based only on in-scope operational time, so that planned maintenance does not improve or reduce the availability score.

This is useful for customers who define availability using net service time instead of total calendar time or total business time.

Example Calculation

Assume a 10-hour reporting window from 10:00 AM to 8:00 PM.

During the scheduled maintenance hour from 7:00 PM to 8:00 PM, the actual resource state is:

• 30 minutes UP
• 30 minutes DOWN

Scenario 1: Include Maintenance As-Is

Applicable Setting: Client-level maintenance setting: Default

The maintenance hour is counted exactly as it occurred.

Therefore, the UP and DOWN states observed during the maintenance window are included in the calculation.

Denominator used for percentage calculation: 10 hours

Result: UP = 65.00%, DOWN = 25.00%, UNKNOWN = 10.00%

UI/report behavior: UI and report values are expected to match when the report also includes maintenance as-is.

Scenario 2: Treat the Full Maintenance Window as UP

Applicable setting: Client-level maintenance setting: UP

The entire scheduled maintenance hour is treated as UP, regardless of the actual resource state during that period.

Denominator used for percentage calculation: 10 hours

Scenario 3: Exclude Scheduled Maintenance from the Report

Applicable setting: Report-level option: Exclude scheduled maintenance time.

The maintenance hour from 7:00 PM to 8:00 PM is removed from the calculation. The denominator changes from 10 hours to 9 hours.

Denominator used for percentage calculation: 9 hours

Result: UP = 66.67%, DOWN = 22.22%, UNKNOWN = 11.11%

UI/report behavior: The report values may not match the UI availability bar because the report excludes maintenance time, while the UI availability bar is based on the full selected time range and the client-level maintenance setting.

Final Results of Example

Scenario 1 Availability Bar

Scenario 2 Availability Bar

Scenario 3 Report

Why are the UI and Report Values Different?

OpsRamp continues to monitor resources during scheduled maintenance. Metrics can still be received by the platform, and alerts can still be processed depending on the configured behavior. As a result, the resource continues to have one of the standard availability states: UP, DOWN, or UNKNOWN.

The UI availability bar is used across the product, including resource overview pages, dashboards, service maps, and other areas that rely on the current or historical availability state of a resource. For this reason, scheduled maintenance is not shown as a separate availability state in the UI availability bar.

When a report excludes scheduled maintenance time, the report removes that duration from the calculation. This changes the denominator used to calculate UP, DOWN, and UNKNOWN percentages. Because the UI and the report are using different calculation scopes, the percentages can be different.

When scheduled maintenance is excluded from the availability report, OpsRamp removes the maintenance duration from the report denominator and recalculates UP, DOWN, and UNKNOWN percentages only for the effective service period. The UI availability bar continues to represent the full selected time range based on the client-level maintenance handling setting. Therefore, report values may differ from the UI availability bar when maintenance exclusion is enabled in the report.

Reports Output

Once the report is generated, it will consist of the following sections:

• Summary: This section provides the configuration details.
• Availability Summary: This section provides a summary of the availability of your IT environment over a period of time.
• Detailed Outage Time: This section provides detailed outages of your IT environment over a period of time. If no selection is made for Select Availability State, this section will default to Down time.
• Location Availability: This refers to the availability of Synthetic Script resources for each configured location.
• Transaction Availability: This refers to the availability of resources for every action configured in the Synthetic Script resource.
• Deleted Resources Summary: This section includes availability details of deleted resources. It will appear when the user selects Resource in the Availability By option and enables the Include Deleted Resources checkbox in the parameters.
• Glossary: This section contains detailed information about each section present in the report tab, helping you to understand the generated data better.

Sample of reports in XLSX format:

Availability Report Vs Availability Details