Skip to content

Commit e8d5328

Browse files
csibbittJoanneOFlynn2018leifmadsen
authored
Adding procedure for SNMP traps (#141)
* Adding procedure for SNMP traps * Update doc-Service-Telemetry-Framework/modules/proc_configuring-snmp-traps.adoc * Update doc-Service-Telemetry-Framework/modules/proc_configuring-snmp-traps.adoc Co-authored-by: JoanneOFlynn2018 <45287002+JoanneOFlynn2018@users.noreply.github.com> * Update doc-Service-Telemetry-Framework/modules/proc_configuring-snmp-traps.adoc Co-authored-by: JoanneOFlynn2018 <45287002+JoanneOFlynn2018@users.noreply.github.com> * Update doc-Service-Telemetry-Framework/modules/proc_configuring-snmp-traps.adoc Co-authored-by: JoanneOFlynn2018 <45287002+JoanneOFlynn2018@users.noreply.github.com> * Update doc-Service-Telemetry-Framework/modules/proc_configuring-snmp-traps.adoc * Update doc-Service-Telemetry-Framework/modules/proc_configuring-snmp-traps.adoc * Update doc-Service-Telemetry-Framework/modules/proc_configuring-snmp-traps.adoc * Update doc-Service-Telemetry-Framework/modules/proc_configuring-snmp-traps.adoc * Update doc-Service-Telemetry-Framework/modules/proc_configuring-snmp-traps.adoc Co-authored-by: JoanneOFlynn2018 <45287002+JoanneOFlynn2018@users.noreply.github.com> Co-authored-by: Leif Madsen <lmadsen@redhat.com>
1 parent 1b4abbf commit e8d5328

3 files changed

Lines changed: 63 additions & 0 deletions

File tree

doc-Service-Telemetry-Framework/assemblies/assembly_advanced-features.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,9 @@ include::../modules/proc_creating-an-alert-rule-in-prometheus.adoc[leveloffset=+
4747
include::../modules/proc_configuring-custom-alerts.adoc[leveloffset=+2]
4848
include::../modules/proc_creating-an-alert-route-in-alertmanager.adoc[leveloffset=+2]
4949

50+
//SNMP Traps
51+
include::../modules/proc_configuring-snmp-traps.adoc[leveloffset=+1]
52+
5053
//High availability
5154
include::../modules/con_high-availability.adoc[leveloffset=+1]
5255
include::../modules/proc_configuring-high-availability.adoc[leveloffset=+2]

doc-Service-Telemetry-Framework/modules/con_advanced-features.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ The following optional features can provide additional functionality to the {Pro
2828

2929
* xref:manifest-overrides_advanced-features[]
3030
* xref:alerts_advanced-features[]
31+
* xref:configuring-snmp-traps_advanced-features[]
3132
* xref:high-availability_advanced-features[]
3233
* xref:dashboards_advanced-features[]
3334
* xref:configuring-multiple-clouds_advanced-features[]
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
// Module included in the following assemblies:
2+
//
3+
// <List assemblies here, each on a new line>
4+
5+
// This module can be included from assemblies using the following include statement:
6+
// include::<path>/proc_setting-up-the-dashboard-to-host-grafana.adoc[leveloffset=+1]
7+
8+
// The file name and the ID are based on the module title. For example:
9+
// * file name: proc_doing-procedure-a.adoc
10+
// * ID: [id='proc_doing-procedure-a_{context}']
11+
// * Title: = Doing procedure A
12+
//
13+
// The ID is used as an anchor for linking to the module. Avoid changing
14+
// it after the module has been published to ensure existing links are not
15+
// broken.
16+
//
17+
// The `context` attribute enables module reuse. Every module's ID includes
18+
// {context}, which ensures that the module has a unique ID even if it is
19+
// reused multiple times in a guide.
20+
//
21+
// Start the title with a verb, such as Creating or Create. See also
22+
// _Wording of headings_ in _The IBM Style Guide_.
23+
[id="configuring-snmp-traps_{context}"]
24+
= Configuring SNMP Traps
25+
26+
You can integrate {Project} ({ProjectShort}) with an existing infrastructure monitoring platform that receives notifications via SNMP traps. To enable SNMP traps, modify the `ServiceTelemetry` object and configure the `snmpTraps` parameters.
27+
28+
For more information about configuring alerts, see xref:alerts_advanced-features[].
29+
30+
.Prerequisites
31+
32+
* Know the IP address or hostname of the SNMP trap receiver where you want to send the alerts
33+
34+
.Procedure
35+
36+
. To enable SNMP traps, modify the `ServiceTelemetry` object:
37+
+
38+
[source,bash]
39+
----
40+
$ oc edit stf default
41+
----
42+
. Set the `alerting.alertmanager.receivers.snmpTraps` parameters:
43+
+
44+
[source,yaml]
45+
----
46+
apiVersion: infra.watch/v1beta1
47+
kind: ServiceTelemetry
48+
...
49+
spec:
50+
...
51+
alerting:
52+
alertmanager:
53+
receivers:
54+
snmpTraps:
55+
enabled: true
56+
target: 10.10.10.10
57+
----
58+
59+
. Ensure that you set the value of `target` to the IP address or hostname of the SNMP trap receiver.

0 commit comments

Comments
 (0)