Metrics in OpsRamp Monitoring allow you to track resource performance and system health. This section covers how to manage metrics, understand their formats, and use export/import features for efficient monitoring.

Create a Metric

To create a metric,

  1. Login to OpsRamp portal.

  2. Navigate to Setup > Account.

  3. Click the Monitoring card. The following page is displayed.

  4. In the Metrics tab, click +ADD. The ADD METRIC page is displayed.

  5. Enter the following field details:

    SectionFieldDescription
    General DetailsNameUnique name for the metric. For example, apache_tomcat_webapps_count_.
    Display NameEnter Display Name. For example, System Drive Free Space.
    Tag NameUser-defined tags for better filtering.
    Adapter TypeSelect from:
    • Application, for which you also need to select a value for Application Type and Attribute.
      JMX, for which you also need to enter value for Class/Attribute path.
    • Derived Metric, for which you need to select Metric from the Metric Query drop-down list in Query Builder.
    DescriptionProvide additional details for the metric.
    CategorySelect the appropriate category for the metric.
    Data Point typeValue chosen to plot data in the graph.
    Unit Multiplication FactorValue chosen to multiply a value based on the chosen unit.
    Format Metric ValueDataPoint Value ConversionOptions are:
    • Value:To populate data using values. Select the appropriate unit from the Units drop-down.
    • Enumerated Map: To populate alert and graph details after adding the states such as Up or Down. The screen displays a section where you can add the state descriptions and select Alerts and Graphs to populate data.
    Query Builder (for Derived Metric type only)FrequencyThe time interval to run the query.
    Metric ProcessingTypeSelect Alert and/or Graph checkboxes for metric processing type.
    Alert allows you to setup a warning or critical alert based on the metric, threshold, and repetition.
    You can also decide how to display the alert details by adding a format in Alert Subject and Alert Content fields.
    Query Builder(for Derived Metric type only)FrequencyThe time interval to run the query.
    Metric QueryQuery expression used to retrieve and aggregate metric data.
    Query ResultResults returned by the metric query.
    Labels Map (for Derived Metric type only)Name and ValueClick +ADD LABEL to add details about label maps.

  6. Click ADD METRIC. The metric is added and is available in the metrics list.

Metric name format

The following are acceptable formats for a metric name:

  • Metric names should not contain a dot (.), instead use an underscore (_) between the words.
    system.cpu.usage is not valid
    system_cpu_usage is valid
  • A metric name can have a maximum of ten underscores “_”. A metric name cannot start or end with an underscore.
  • A metric name can contain numeric values (0-9), but cannot start with a numeric value.
  • A metric name should be case-insensitive.
  • The length of the metric name should be less than or equal to 255, including underscores.

Graphs with New Metrics data

The following table details the graphs.

View details

PropertyExpected BehaviourWorkaround / Details
Graphs plotting frequency Vs Monitoring FrequencyThe graph shows raw samples based on default step value: 1min i..e the plotting frequency for graphs irrespective of configured monitoring frequency.
  • If metrics are collected every 5 minutes with a default step value of 1 minute ( i..e plotting with 60s frequency), the same value is plotted from T to T+5 minutes (e.g., 8:00 AM to 8:05 AM). This is the default behavior which will show the same value from 8:00 AM to 8:05 AM in plotter graph.
  • If the Availability/Agent status/Gateway Status/Interface Status/ or any metric triggers an alert indicating downtime and you want to see real gaps for monitoring frequency less than 5 minutes, refer to the section Visualize Real-time data.
Graphs plotting behavior
  • Default Plotting Frequency: The application plots the metric graphs at a default frequency of 1 minute.
  • Rendering Duration: The same metric value is displayed for up to 5 minutes.
  • Higher Frequency Monitoring: When the monitoring frequency is set to intervals greater than 5 minutes (e.g., 15, 30, or 60 minutes), gaps may appear in the graph.
  • Data Availability: For a 15-minute frequency, the next data point becomes available after 10 minutes, resulting in gaps where no new data is plotted.
    • This behavior ensures that the most recent data is visualized accurately, although it may lead to gaps when using longer monitoring intervals. Adjusting the monitoring frequency can help balance the need for real-time data visualization with the granularity of the data collected.
To avoid plotting gaps, ensure that the metric collection frequency matches the default graphing frequency or adjust the graphing frequency to match the metric collection intervals which is less than or equal to 5 minutes.

The recommend monitoring frequency for any metric should be <= 5 minutes

Visualize Real-time dataThe data points for new metric graph data are calculatedly plotted every 1 min except at the frequency time-interval.

In order to view real-time data, the metric graphs offer displaying the actual timestamps when the data was collected.Status and availability metrics need to show when data collection stopped, indicating a resource or service outage.

Graph > Expand Info section > shows “Real Time Data” option.
Metrics DetailsIn the new metrics system, templates that describe the relationship between different metrics are not available. User might see the legacy metrics name while detailing, which is expected behavior and these will be slowly transitioned to show in the new metric nomenclature.To view the relationships between template and metrics, navigate to the Monitors tab where detailed information is provided.
Default Time Period for GraphsDefault time-period has been set as 1 Hour from the existing 4 Hr windowDefault Time-period is now set 1H
Multiple metricsThe new metric visualization supports only a single metric graph data.The new metric visualization doesn’t support multiple metric graph data visualization due pagination and hence not available.

View Metrics

You can view the list of all metrics in the Metrics page.
The following table provides details of each field.

AttributesDescription
NameUnique name for the metric.
Display NameDisplay name for the metric.
Adaptor TypeCollector type that you want to use to gather metric data.
Application TypeTechnology associated with the metric.
UnitMetric value unit.
GraphConfigured critical or warning expressions.
Alert Expression (Warning/Critical)The configured critical or warning expressions.
DescriptionMetric description.

Export a metric

The Export functionality allows you to save a metric in CSV or JSON format. Follow these steps to export a metric:

  1. In the Metrics tab, search for the metric(s) you want to export.

  2. Select the metric(s) and click Export.

  3. The metric is exported.

Import a metric

The Import functionality allows you to import a CSV or JSON formatted metric file as a metric. Follow these steps to import a metric:

  1. In the Metrics tab, click the Import icon and then click Upload.

  2. Select a file to upload. Supported file formats are JSON or CSV.

  3. Click Import. The metric is imported and the details are shown in the Import Metrics page.

  4. If the import fails, a message is displayed with the reason for the failure.

Tabbed Interface with Table