5.3 Add metric for Trend Viewing and Alerting

You can add metrics for JP1/IM - Agent trend viewing and alerting.

For metrics handled in trend viewing, see 3.15.6 (3) Return metric List and 3.15.6 (4) Return of trend data in the JP1/Integrated Management 3 - Manager Overview and System Design Guide, and for metrics handled in alerting, see 3.15.1 (3) Performance data monitoring notification function in the JP1/Integrated Management 3 - Manager Overview and System Design Guide.

The configuration steps for adding metrics are as follows:

1. Exporter Settings

   If Exporter has not collected metric you want to add, configure the settings to collect them. Different Exporters are configured differently. For details, see 3.15.1(1)(i) Blackbox exporter (Synthetic metric collector), 3.15.1(1)(d) Node exporter (Linux performance data collection capability), 3.15.1(1)(c) Windows exporter (Windows performance data collection capability), and 3.15.1(1)(g) Yet another cloudwatch exporter (Azure Monitor performance data collection capability) in the JP1/Integrated Management 3 - Manager Overview and System Design Guide.

   Restart Exporter after configuring the settings. (For Blackbox exporter, you can perform a reload instead of a reboot.)

2. Edit the Prometheus configuration file

   In scrape defnition of Prometheus configuration file (jpc_prometheus_server.yml), change the metric_relabel_configs settings to ensure that metric of Exporter used by PromQL expression is not removed. Specifically, metric_relabel_configs the new metric name to be used by the Exporter where the importer's metric names are listed in the next regex. If it has already been added, no additional is required.

   Here is an example of adding the "aws_ec2_network_in_average" metric in the Yet another cloudwatch exporter (add an underline):

   - job_name: 'jpc_cloudwatch'
   ...
     metric_relabel_configs:
   ...
       - source_labels: ['__name__','jp1_pc_nodelabel']
         regex: '(aws_ec2_network_in_average|aws_ec2_cpuutilization_average|...);.+$'
   action: 'keep'

   For details about the Prometheus configuration file, see Prometheus configuration file (jpc_prometheus_server.yml) in Chapter 2. Definition Files in the JP1/Integrated Management 3 - Manager Command, Definition File and API Reference.

3. Edit the alert configuration file (if you want to add metrics to be handled by the alert)

   Add a metric to the alert definition in the alert configuration file and write a PromQL statement using the added metric in the expression of the alert.

   For details about the alert configuration file, see Alert configuration file (jpc_alerting_rules.yml) in Chapter 2. Definition Files in the JP1/Integrated Management 3 - Manager Command, Definition File and API Reference.

4. Restarting or reloading the Prometheus server service

   Restart or reload the Services of the Prometheus server on the host where you edited the Prometheus configuration file and the alert configuration file.

5. Edit the metric definition file (if you want to add metrics to be handled in the trend display)

   The return function of the metric list returns the metric defined in the metric definition file. The metric definition file exists for each Exporter. Check the Exporter of the IM management node to which you want to add the metric, and add the metric definition to the metric definition file for the exporter.

   For details about the metric definition file, see the metric definition file for each Exporter in Chapter 2. Definition Files in the JP1/Integrated Management 3 - Manager Command, Definition File and API Reference.

   After editing the metric definition file, the information in the updated metric definition file is reflected when you perform one of the following operations:

   • Refresh the Trends tab in the Integrated Operations Viewer

   • Refresh the Dashboard tab in the Integrated Operation Viewer

   • Run the JP1/IM - Manager Metrics List Acquisition API

   • Run the JP1/IM - Manager Time Series Data Acquisition API

To Page Top