Alertmanager configuration file (jpc_alertmanager.yml)
- Organization of this page
Format
Write in YAML format.
:
(Abbreviated)
:
receivers:
- name: 'JP1IMDD'
webhook_configs:
- send_resolved: true
url: 'http://host-name-of-JP1/IM - Agent:20726/ima/api/v1/proxy/service/imdd/im/api_system/v1/events/transform'
File
jpc_alertmanager.yml
jpc_alertmanager.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
This is a configuration file that defines the operation of AlertManager.
Character code
UTF-8 (without BOM)
Line feed code
In Windows: CR+LF
In Linux: LF
When the definitions are applied
Reflected when Alertmanager is restarted and when Alertmanager is instructed 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 |
|
|---|---|---|---|---|---|
|
global: |
-- |
N |
-- |
-- |
|
|
route: <route> |
Configure alert routing. See the <route> description below. |
Y |
For details, see <route> below. |
-- |
|
|
receivers: |
Set the notification destination for the alert. |
N |
-- |
-- |
|
|
- <receiver> ... |
See the <receiver> description below. |
Y |
For details, see <receiver> below. |
Describes the definition for sending to JP1/IM - Manager (Intelligent Integrated Management Platform). |
|
- Legend:
-
Y: Changeable, N: Not changeable, --: Not applicable
-
<route>
Set only one for sending to the Integrated Operations Viewer for JP1/IM.
Item
Description
Changeability
What You Setup in Your JP1/IM - Agent
JP1/IM - Agent Defaults Value
[ receiver: <string> ]
Specify the value of name in the definition of the alert notification destination set for receivers.
N
--
receiver: 'JP1IMDD'
[ group_by: '[' <labelname>, ... ']' ]
Specify if you want to group multiple alerts from the Prometheus server by label. Specify ['...'] to disable grouping.
N
--
group_by: ['...']
[ continue: <boolean> | default = false ]
Specifies whether to continue routing alerts.
N
--
continue: false
[ group_wait: <duration> | default = 30s ]
Specify the amount of time to wait for grouping alerts.
Group alerts that arrived during the waiting time.
N
--
group_wait: 5s
[ group_interval: <duration> | default = 5m ]
Specifies the interval before snoozing when a new alert is added to a group of alerts.
N
--
group_interval: 5s
[ repeat_interval: <duration> | default = 4h ]
Specify the interval after which an alert is notified before snoozing.
If you specify a value greater than the period specified in the command line option --data.retention, you may be soldered earlier than the period specified in the repeat_interval.
N
--
repeat_interval: 7d
- Legend:
-
N: Not changeable, --: Not applicable
-
<receiver>
Item
Description
Changeability
What You Setup in Your JP1/IM - Agent
JP1/IM - Agent Defaults Value
name: <string>
Specifies the name of the alert notification destination setting.
N
--
- name: 'JP1IMDD'
webhook_configs:
If you are using the data delivery function to multiple manager hosts, additionally include alert notification settings for secondary imagent. For setting examples, see Sample configuration for Alertmanager configuration file (jpc_alertmanager.yml) in 3.15.7(5)(f) Send settings for programs other than JP1/IM agent control base in the JP1/Integrated Management 3 - Manager Overview and System Design Guide.
N
--
--
[ send_resolved: <boolean> | default = true ]
Specifies whether to notify recovery alerts.
<Configuration Example>
See receivers.webhook_configs.url.
Y
Specify false if you do not want to be notified of recovery.
- send_resolved: true
url: <string>
Specify the endpoint to which you want to be notified of alerts.
<Configuration Example>
receivers:
- name: 'JP1IMDD'
webhook_configs:
- send_resolved: true
url: 'http://integrated-agent-host-name:20726/ima/api/v1/proxy/service/imdd/im/api/v1/events/transform'
R
Specify imagent endpoints on the same host. Modify Host name and Port number to suit your deployment.
url: 'http://integrated-agent-host-name:20726/ima/api/v1/proxy/service/imdd/im/api/v1/events/transform'
- Legend:
-
R: Required, Y: Changeable, N: Not changeable, --: Not applicable