From 0f683763d99e4cb45ceedfd6300f167d098dd25b Mon Sep 17 00:00:00 2001 From: Brandon Morelli Date: Mon, 29 Jun 2020 16:07:07 -0700 Subject: [PATCH] docs: update alerting (#69839) (#70234) --- docs/apm/apm-alerts.asciidoc | 23 +++++++++++++++++++++-- docs/apm/images/add-variable.png | Bin 0 -> 4043 bytes 2 files changed, 21 insertions(+), 2 deletions(-) create mode 100644 docs/apm/images/add-variable.png diff --git a/docs/apm/apm-alerts.asciidoc b/docs/apm/apm-alerts.asciidoc index 75ce5f56c96c65..bc5e1ccc1dd55e 100644 --- a/docs/apm/apm-alerts.asciidoc +++ b/docs/apm/apm-alerts.asciidoc @@ -15,15 +15,20 @@ and enables central management of all alerts from <>. + +The APM app supports two different types of threshold alerts: transaction duration, and error rate. Below, we'll create one of each. [float] [[apm-create-transaction-alert]] === Create a transaction duration alert -This guide creates an alert for the `opbeans-java` service based on the following criteria: +Transaction duration alerts trigger when the duration of a specific transaction type in a service exceeds a defined threshold. +This guide will create an alert for the `opbeans-java` service based on the following criteria: +* Environment: Production * Transaction type: `transaction.type:request` * Average request is above `1500ms` for the last 5 minutes * Check every 10 minutes, and repeat the alert every 30 minutes @@ -52,14 +57,22 @@ Enter a name for the connector, and paste the webhook URL. See Slack's webhook documentation if you need to create one. +Add a message body in markdown format. +You can use the https://mustache.github.io/[Mustache] template syntax, i.e., `{{variable}}` +to pass alert values at the time a condition is detected to an action. +A list of available variables can be accessed by selecting the +**add variable** button image:apm/images/add-variable.png[add variable button]. + Select **Save**. The alert has been created and is now active! [float] [[apm-create-error-alert]] === Create an error rate alert +Error rate alerts trigger when the number of errors in a service exceeds a defined threshold. This guide creates an alert for the `opbeans-python` service based on the following criteria: +* Environment: Production * Error rate is above 25 for the last minute * Check every 1 minute, and repeat the alert every 10 minutes * Send the alert via email to the `opbeans-python` team @@ -81,6 +94,12 @@ Based on the alert criteria, define the following alert details: Select the **Email** action type and click **Create a connector**. Fill out the required details: sender, host, port, etc., and click **save**. +Add a message body in markdown format. +You can use the https://mustache.github.io/[Mustache] template syntax, i.e., `{{variable}}` +to pass alert values at the time a condition is detected to an action. +A list of available variables can be accessed by selecting the +**add variable** button image:apm/images/add-variable.png[add variable button]. + Select **Save**. The alert has been created and is now active! [float] diff --git a/docs/apm/images/add-variable.png b/docs/apm/images/add-variable.png new file mode 100644 index 0000000000000000000000000000000000000000..860ab66f22f4e28bee273f3d638b1fc1ad3f863a GIT binary patch literal 4043 zcmZ`*by$>L)4%C%St)^~LttGRVOcsPmQa^wDFK0{WGRvEMnbw32??nOK?FgiL`rF- zaS0JA5qKB%d!Fa|-s?Tr^*b|XW_~kg=01PiF$g^kDsmQb005}8G*u08lIsGb#JF8f zgQ5!n$Ui%&s35ddR5%fyXa^@3djQakNzWufq)mc?cg`P25#o~-X_B>*jgWEjhJ)Zr za?#qF_+-41myBJWT&-C!MbN#fFOK6P&nSzgsp#)U$BLnrAQ8>X|4c;iCjJnYM$?y z=GC(J)W}tRt>eY{j{2D%Cx~Z5w;5Om)jzQT@-hAC4glO!bu(Vxl9)c~QbcV@mKZ&^ zd2p?m{@WGq_+_F|FHcb7E^XID^h-hjN`-QmDzI_*$s3d{1k21RT8!!FCE^fB)v9m3 zarVCCcs@0)I%@zGb2Syg!jj-& zV%{hn;Paa2aa^eEQyEXaO&$t6rE6(dEtsnN(nakX_#O%8^;N!&HJXgTPZSF3fJmWI z_f&Tq_)Rhx8DJ~jwP^=`CF|jb`ni2pTr`N4R6C7|pG1>jp|-1H>W#M(&4()54W5b*EJv#8LZbn2Fy10u zDw#lVA=H`^--a`p0@VK|8zuJeYDz3L+>@BX&jX)WW56qG$lb?V-EHpENnQ*6&ic|0 zeX&(eeRTz1=US;@g}kIaMH^9PoiPwiWh9050}wy(T0FBKC$H*$8n#trf)la?6Mqk; zgAhz~vda))7N~wI(UKCRaDsS3j)O_UIY}x4>5#;?Lbwq4QX#H|_?vhqol5S6Y$Uo1 z5;8QRVb}#w3kiFe+c1e`2_mCwv5vnv``Pdo zLP(Hb@KBID+gO)>P;-!Na6dar;+ZqG9A93F?SgR3^ zZ1tQ~g#_tp->F@vBuZ-nvoOc7GU5|TH>P+d7UoDMZAuK2C4>!H%zDgf&*Ca6cUQtu zNAf@t#Eh1N-T9eXG-!RTo_QrcE*`}|kcME0cxRbLon~MpJSsCfUcO(hKN#(x)8O4u z?cnOrz1q9lFp&A^W42;FClVqO4w@F35`iI2P56*CjV|?UwIhv-$Q843Q-wM{vlEjw z)7vKVjjyI4uJtZHlQZ=ZuCp!?P3cY2Th`Yx*HdOi+lDr>Hu6V%Mk~wboB1ajHupB~ zZUwNdQ`1pbUdd*&d=Du|k+;?bJC9Q>*%m?d5~Y%t7+BcQlia;D<{sHC-<1(%LCGKSCj54|Vp45FvikFZ z&^r->Q&8+Xm$=ErN!=9AREAdGZ%z+y8oP~E$bOPF@Df^k5$zLe37TbBNid=H5?HQY)|n#L;e;H*@$ zSdU1VK-t~=@fSUNHA5c@3KY%<@Dqq;i1-b!RghIg8NPJqZoN5^BB3`m^c=;W)0}r0 zyYqg&kK@u2sW#E+25h5jgMb;vYz8Hc2- zg0yTe!z$h(dMk6s=kB{*dNFyWnj?AG^fnO;l0~#SL#f`c-a(d%`JtOY72~|1|F^(B zp*@&rtd+M--Kx#*BI^y8%qp{y0*>7CQN!HGQW0{myU3%PP;2X|?5L!?m@AwTErVJI--qaiwa9AN`-r?kW5T_;7dy zYd*1sJgm;L3aoxzS6a2)??3nBuAX(+&k9zkVJD3x#?O}UnMjhHJjPI({pxox}|vS!PAO~XQCBn{_w!U z6YKA<;w0H6C8H>*U8^GQGB$=q8Bx#6(fgLR4t2Pp71}$N1!SJe{P>3aQdhI|`OUN* zM1SnmWp{6g*jdGcd#t6@qebh}*lh0Dj30E<&MXddqgyb_h(s?Zw?@9?zQdBq;$&At zpV#r4x+!n9%9{AlVUvhsKp=RxYc|eH)W@9srT2>G*ADac>~J!2)lAn)!E@%=i{-zs)usb!f!&3LM^$8p`t?B&@p=6oJa$xnUQ zp3-5^VR5dvGaI64e(uN`!{T=UTRUBkT1@iipb4@Gaz4-f+WNrz!{wRGZ_lKx%sL_- z1QZV#2=ST=VgfJ0!4!J>Bnw-3b}&8s;Mf7$*R2eD`z>&WdBP>aGY0*Eg{4Jm_?6;b zb#5PFKqJN81PG2)1Z-^$suY7Q%#E>DTsJTt`O#|1ZhozhX}HYn3^&s5vuQ zasRxr_DC%UU0py3r;`GNcq{-BPQ$|ihR6E1u8t=F5d5;^13;7$K=>y{4<|2HG7cA< z-;y9T5+K2y=yC8Z#Q!^*tB~Ly9p?j-j8wF=aMH-u)85|A%MtCpQCc33GmyD!ns@;K zi1z|`T82DdarwubjFH|*T^%`Fw5uq}4sByE>g(!$kq40XmBXp7_TDH?Uso45FF9WY zu3r&yIQ_yb#>M$7#QUxS7g86&se<;j=adwc5QT8T$T>MV$I3)!xh2)5+c2 z3GK#tkr!oyzUQsL#dT5W@Adnh_P$R4RC4qB(-y8lu?vsbHBpGz-??#A`3tKY!pYa( z1*z)fiklg(225N+{#W>aIsPg5n|Ra9-ctqbisO01{+an7^1q$`pZKey$^WYOFUKFE zyx2wG|C+<^A^)=CrVJyO7yJ8*!N|u>UtBycHYZhmW1Pf2v0sZ0w+rBKAulk(%hoZ9 zllfYzO2$Yso1Zj?<)JkBg9EX;}$S0&C<8Ma7V zq=L#oXo_=gKvah%lTp&K83s{>ge1u-9?^xYz*31>cpOcfO%{xaqdb3IBGe6trxA~) zrD|X*r|FH_;GP0Qs2+}RkAfegU!r6J) z?|q}jja>uxfLka_1I89S-xg|Bh4Gz)D#xbc56+wC7s*Z}yW8|I@{ZAF(&K}6(^Wyc zW3{w7%$yoJn%u=B-Q|yxnVv8YH?ER*_omV83K6Mkm_$>13<59s=#mL}7aE%9p}BvZ xW`FKYOR^p>{4%F=^WiJx&8%0Kkg3H4fU#e=kto4e9^7yNEj2yW8fELy{{U?O1{44Q literal 0 HcmV?d00001