Configuring Custom Metrics

Precautions

• Currently, only the four types supported by Prometheus can be obtained.
• Before configuring custom monitoring for application components, you need to understand Prometheus and provide the GET API for obtaining custom metric data in your application components so that CAE can obtain the data through this API. Prometheus provides clients in various languages, including Go, Java, Python, Ruby, and Net. For details about the clients, see Client Libraries. For details about how to develop exporter, see Writing Exporters. The Prometheus community provides various third-party exporters that can be directly used. For details, see Exporters and Integrations.

Configuring Custom Metrics

NOTE:

Custom metrics are charged separately. For details, see Pricing Details.

1. Log in to CAE.
2. Choose Component Configurations.
3. Select the target component from the drop-down list in the upper part of the page.
   Figure 1 Selecting a component
   

4. Click Edit in the Custom Metric module.
5. Click to enable custom metrics. Configure the custom metric by referring to Table 1.

   Table 1 Custom metric parameters

   Parameter	Description	Mandatory
   Collection Path	Path exposed by the component using the GET method for CAE to obtain custom metric data. For example, /actuator/prometheus.	Yes
   Collection Port	Port exposed by the component using the GET method for CAE to obtain custom metric data. Value range: 1 to 65535. For example: 9090.	Yes
   Metric	Name of the custom metric exposed by the component using the GET method. For easy understanding, ensure that the name can reflect the actual meaning. For details, see Metric and Label Naming. For example, to define the number of clicks of a button, name it click_ operated_total. If the metric exposed by the component is inconsistent with the entered metric name, the metric does not take effect. The metric name contains 5 to 100 characters, including only letters, digits, and underscores (_).	Yes

6. (Optional) Click Add Monitoring Metric to add more custom metrics.
7. Click OK.
8. Make the configurations take effect.
   • If the component has been deployed, click Activate Settings in the upper part of the page. In the dialog box displayed on the right, confirm the configurations and click OK for the configurations to take effect.
   • If the component has not been deployed, click Set and Deploy Component in the upper part of the page. In the dialog box displayed on the right, click OK. After the deployment is complete, the configurations take effect.

9. After the configuration and deployment are complete, you can view monitoring metrics on the Component Monitoring page.
   Figure 2 Viewing custom metrics
   

Editing Custom Metrics

1. Log in to CAE.
2. Choose Component Configurations.
3. Select the target component from the drop-down list in the upper part of the page.
4. Click Edit in the Custom Metric module.
5. Edit or delete a monitoring metric.
   • Reconfigure the parameters by referring to Table 1.
   • Click next to a metric to delete it.

6. Click OK.
7. Click Activate Settings in the upper part of the page. In the dialog box displayed on the right, confirm the configurations and click OK for the configurations to take effect.

Disabling Custom Metrics

1. Log in to CAE.
2. Choose Component Configurations.
3. Select the target component from the drop-down list in the upper part of the page.
4. Click Edit in the Custom Metric module.
5. Click to disable custom metrics. Click OK.
6. In the displayed dialog box, enter SWITCHOFF and click OK.
7. Click Activate Settings in the upper part of the page. In the dialog box displayed on the right, confirm the configurations and click OK for the configurations to take effect.
8. After the configurations take effect, the custom metric data of the corresponding instance is not displayed on the Component Monitoring page.