Alert configuration file (jpc_alerting_rules.yml)
- Organization of this page
Format
Write in YAML format.
groups:
- name: group-name
rules:
- alert: alert-name
expr: Conditional expressions
for: Period
labels:
jp1_pc_product_name: "/HITACHI/JP1/JPCCS2"
jp1_pc_component: "/HITACHI/JP1/JPCCS/CONFINFO"
jp1_pc_severity: JP1 event severity
jp1_pc_eventid: Event ID of the JP1 event
jp1_pc_metricname: Metric Name
annotations:
jp1_pc_firing_description: Message when abnormal conditions are met
jp1_pc_resolved_description: Message when an abnormal condition is no longer met
File
jpc_alerting_rules.yml
jpc_alerting_rules.yml.model (model file)
Storage directory
■Integrated agent host
- In Windows:
-
-
For a physical host
Agent-path\conf\
-
For a logical host
shared-folder\jp1ima\conf\
-
- In Linux:
-
-
For a physical host
/opt/jp1ima/conf/
-
For a logical host
shared-directory/jp1ima/conf/
-
Description
A file that defines the alert evaluation rules that the Prometheus server runs.
Character code
UTF-8 (without BOM)
Line feed code
In Windows: CR+LF
In Linux: LF
When the definitions are applied
Reflected when the Prometheus server is restarted and when you instruct the Prometheus server to reload.
Information that is specified
For definitions of common placeholders used in the table below, see About definition of common placeholders for descriptive items in yml file.
|
Item |
Description |
Changeability |
What You Setup in Your JP1/IM - Agent |
JP1/IM - Agent Defaults Value |
|||
|---|---|---|---|---|---|---|---|
|
groups: |
-- |
N |
-- |
"groups:" |
|||
|
name: <string> |
Specify the alert group name within 255 bytes. The group name must be unique within the monitoring agent host, and you cannot specify multiple names with the same group name. Note that between different monitoring agent hosts, you can specify a name that specifies the same group name for each. |
Y |
Specify a group name of your choice. |
Not specified |
|||
|
rules: |
Configure alert rules. You can specify up to 100. |
N |
-- |
Not specified |
|||
|
alert: <string> |
Specify a name for the alert. |
Y |
Specifies the name of the alert created by the user. |
Not specified |
|||
|
expr: <string> |
Specify the alert expression within 255 bytes. Specifies the PromQL statement. |
Y |
Specifies the PromQL statement to evaluate.# For notes on PromQL statements, see Note on PromQL expression. |
Not specified |
|||
|
for: <duration> |
Specify the amount of time it takes for an alert to become unhealthy, ranging from 0 seconds to 24 hours. The value is specified in numbers and units. The units that can be specified are s (seconds) and m (minutes). Even if the alert condition expression is applicable, if it no longer applies within the period specified for for, it will not be treated as abnormal. |
Y |
Specifies the amount of time it takes for an alert to reach an unhealthy state. |
Not specified |
|||
|
labels: |
Set labels to add or override for each alert. |
N |
-- |
Not specified |
|||
|
jp1_pc_product_name: <string> |
Specify the value to be set for the product name of the JP1 event. |
Y |
"/HITACHI/JP1/JPCCS2", or "/HITACHI/JP1/JPCCS2/xxxx" You can specify xxxx. |
Not specified |
|||
|
jp1_pc_component: <string> |
Specify the value to be set for the component name of the JP1 event. |
Y |
Depending on the product plug-in that handles the JP1 event, specify the following values. jp1pccs_azure.js:"/HITACHI/JP1/JPCCS/AZURE/CONFINFO" jp1pccs_kubernetes.js:"/HITACHI/JP1/JPCCS/KUBERNETES/CONFINFO" jp1pccs.js:"/HITACHI/JP1/JPCCS/CONFINFO" |
Not specified |
|||
|
jp1_pc_severity: <string> |
Specify the value to set for the severity of the JP1 event. |
Y |
Specify one of the following:
|
Not specified |
|||
|
jp1_pc_eventid: <string> |
Specify the value to be set for the event ID of the JP1 event. |
Y |
Specify any value in the range of "0 to 1FFF,7FFF8000 to 7FFFFFFF" that can be specified as the event ID of the JP1 event. |
If the specification is omitted, "00007600" is Setup to Value of ID property of JP1 event. |
|||
|
jp1_pc_metricname: <string> |
Specify the value to be set for the metric name of the JP1 event. In the case of Yet another cloudwatch exporter, the JP1 event is associated with the IM management node in the AWS namespace corresponding to the metric name (or the first metric name if multiple comma-separated values are specified). |
Y |
Specify the metric names separated by commas. |
Not specified |
|||
|
annotations: |
Set the annotations that you want to add to each alert. |
N |
-- |
Not specified |
|||
|
jp1_pc_firing_description: <string> |
Specify the value to be set for the message of the JP1 event when the abnormal condition of the alert is satisfied. If the length of the value is 1,024 bytes or more, set the string from the beginning to the 1,023rd byte. If the specification is omitted, the message content of the JP1 event is "The alert is firing. (alert = alert name)". |
Y |
Specify an optional message. |
If the specification is omitted, the message content of the JP1 event is "The alert is firing. (alert = alert name)". |
|||
|
jp1_pc_resolved_description: <string> |
Specify the value to be set for the JP1 event message when the abnormal condition of the alert is no longer satisfied. If the length of the value is 1,024 bytes or more, set the string from the beginning to the 1,023rd byte. If the specification is omitted, the content of the message in the JP1 event is "The alert is resolved. (alert = alert name)". |
Y |
Specify an optional message. |
If the specification is omitted, the content of the message in the JP1 event is "The alert is resolved. (alert = alert name)". |
|||
- Legend:
-
Y: Changeable, N: Not changeable, --: Not applicable
- #
-
Since the following label is set as an attribute of the JP1 event, do not remove the label by an aggregate operator.
-
instance
-
job
-
jp1_pc_nodelabel
-
jp1_pc_exporter
-
jp1_pc_remote_monitor_instance
-
account
-
region
-
dimension_any-string
Note that the labels accout, region, and dimension_any-string apply only when monitoring Yet another cloudwatch exporter metrics.
-