diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle index 78e3cab..0588840 100644 Binary files a/docs/build/doctrees/environment.pickle and b/docs/build/doctrees/environment.pickle differ diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree index 4c99d35..51b6540 100644 Binary files a/docs/build/doctrees/index.doctree and b/docs/build/doctrees/index.doctree differ diff --git a/docs/build/doctrees/user/demo.doctree b/docs/build/doctrees/user/demo.doctree index 03e6132..7f56578 100644 Binary files a/docs/build/doctrees/user/demo.doctree and b/docs/build/doctrees/user/demo.doctree differ diff --git a/docs/build/doctrees/user/install.doctree b/docs/build/doctrees/user/install.doctree index ca402c3..ccb5f9a 100644 Binary files a/docs/build/doctrees/user/install.doctree and b/docs/build/doctrees/user/install.doctree differ diff --git a/docs/build/doctrees/user/intro.doctree b/docs/build/doctrees/user/intro.doctree index 3a25acc..c706f94 100644 Binary files a/docs/build/doctrees/user/intro.doctree and b/docs/build/doctrees/user/intro.doctree differ diff --git a/docs/build/doctrees/user/setup.doctree b/docs/build/doctrees/user/setup.doctree index cd4d6c4..c0fc5ce 100644 Binary files a/docs/build/doctrees/user/setup.doctree and b/docs/build/doctrees/user/setup.doctree differ diff --git a/docs/build/doctrees/user/usage.doctree b/docs/build/doctrees/user/usage.doctree index f9732df..ab9efdf 100644 Binary files a/docs/build/doctrees/user/usage.doctree and b/docs/build/doctrees/user/usage.doctree differ diff --git a/docs/build/html/_sources/user/setup.txt b/docs/build/html/_sources/user/setup.txt index 4fd4ba7..07e4942 100644 --- a/docs/build/html/_sources/user/setup.txt +++ b/docs/build/html/_sources/user/setup.txt @@ -362,11 +362,15 @@ AWS SNS Output Parameters - :code-no-background:`template` (string: ``""``) - The message template that will define what alert messages will look like. This template is based on `Go templates `__. It allows you to interpolate an array - of `alert records + of `alert records `__ into the template to expose custom message formatting for your alerts. This field is required. +**IMPORTANT**: If sending SMS messages with your SMS topic, a strict 140-character +limit is enforced. Please take this into consideration when writing your message +template. + As an example, let's say you have this output method in one of your rule files: .. code-block:: json diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js index 9a5e7a2..048e437 100644 --- a/docs/build/html/searchindex.js +++ b/docs/build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({envversion:47,filenames:["index","user/demo","user/install","user/intro","user/setup","user/usage"],objects:{},objnames:{},objtypes:{},terms:{"00z":3,"10m":4,"10t10":3,"13t15":1,"471f879ed2f31c030832553c6d9cb878dac5d413892ecad9b05a7446bdf3c807":5,"798z":1,"_doc":1,"_linux_x86_64":5,"_search":[1,4],"_sourc":4,"boolean":4,"case":1,"default":4,"function":5,"int":4,"new":[0,1,3,4,5],"return":3,"true":[4,5],"try":[0,1],"var":1,"while":[1,3],abc:4,about:0,abov:[3,4],access:4,accord:5,achiev:3,acl:4,acquir:[1,5],across:5,action:1,actual:3,addition:[3,4],address:[4,5],affili:3,after:[1,4],again:[1,3],agg:4,aggreg:[1,4],agre:3,alerts_:5,all:[3,4,5],allow:[4,5],alpin:5,also:[1,2,3,4,5],altern:3,alwai:4,alwya:4,amazon:4,amd64:2,ani:[1,3,4,5],announc:1,anoth:[1,3,5],apach:3,api:4,apm:5,app:4,appear:1,applic:[1,3,4,5],arrai:4,artifact:5,asdfasdf:4,assign:4,assum:4,attempt:[1,3,5],attr:5,authent:4,auto_revert:5,aux:5,avoid:5,awk:5,background:0,bar:4,base:[3,4],bash:1,basi:3,becaus:[1,5],becom:[1,5],befor:[3,4],begin:0,behavior:4,below:[0,3,4,5],between:4,bim:4,bin:[1,2],binari:[2,5],bit:2,block:5,bodi:4,body_field:[1,4],bool:[1,4],brief:4,broswer:1,browser:1,bucket:4,build:2,built:3,ca_cert:[4,5],cacert:4,call:[1,5],can:[0,1,2,4,5],canari:5,cat:1,cert:[4,5],certif:4,chain:5,chang:5,change_mod:5,change_sign:5,check:[0,1,5],checksum:5,cleanup:0,client_cert:[4,5],client_kei:[4,5],clone:[1,2],code:[1,5],com:[1,2,4,5],come:4,command:[1,2,5],commun:4,communc:4,compat:5,compil:2,complianc:3,compon:3,compos:1,concaten:4,condit:3,config:[4,5],configur:[0,1,3],connect:4,constraint:5,consul:0,consul_cacert:4,consul_capath:4,consul_client_cert:4,consul_client_kei:4,consul_http_addr:[4,5],consul_http_ssl:4,consul_http_ssl_verifi:4,consul_http_token:4,consul_lock_kei:[4,5],consul_tls_server_nam:4,consult:3,contain:[1,2,5],content:[1,4],continu:5,control:4,copi:3,copyright:3,correspond:4,count:[4,5],cover:[2,5],cpu:5,creat:[0,1,5],cron:4,cross:2,ctrl:1,curl:[1,4],current:[1,4,5],custom:[3,4,5],daemon:5,data:[0,1,3,4,5],datacent:5,date:1,dedic:3,def:4,defin:[1,3,4,5],definit:5,delai:5,delet:1,demonstr:0,depend:4,desc:1,destin:5,detail:4,dictat:4,differ:4,directori:[2,4],disk:[3,4],distinct:3,distinct_host:5,distribut:[0,1,3,4],dns_server:5,doc_count:4,docker:[0,1],document:[0,1,2,3],done:1,down:1,download:0,driver:5,duplic:5,each:[3,4,5],east:[4,5],either:3,elast:5,elastalert:3,elasticserach:5,element:4,elsewher:4,email:3,enabl:[4,5],encod:4,end:4,endpoint:4,ensur:3,env:5,environ:[2,4],eof:1,eoh:5,ephemeral_disk:5,epoch:1,equal:3,error:[1,4,5],etc:[4,5],even:4,everi:[1,4],exact:4,exampl:[1,2,3],example_error:3,except:3,execut:[3,4,5],exist:[3,4],exit:1,expos:4,express:3,extens:4,fail:1,fals:4,fashion:[4,5],featur:[1,3,4,5],field:[1,3,4],file:[0,1,3],filebeat:4,filter:[0,1,3],find:[0,3,4],finish:2,first:1,flexibl:3,focus:0,follow:[1,2,3,4,5],foo:4,format:4,found:[2,4],from:[1,2,3,4,5],further:4,gea:1,gener:[3,4],get:[0,1],ghi:4,git:[1,2],github:[1,2,4,5],given:[1,3,4,5],gmail:4,go_elasticsearch_alerts_config_fil:[4,5],go_elasticsearch_alerts_rules_dir:[4,5],go_elasticsearch_alerts_smtp_password:4,go_elasticsearch_alerts_smtp_usernam:4,go_elasticsearch_alerts_vers:5,goe:1,gopath:2,goroutin:3,govern:3,greater:3,grep:5,group:[4,5],gte:1,handler:[1,3,4,5],hashicorp:[4,5],have:[1,2,4,5],header:[1,4],health:1,health_check:5,healthi:1,healthy_deadlin:5,hello:4,henceforth:3,here:[1,4],highli:5,hit:[3,4],hits_count:3,hold:5,hook:4,host:[3,4],hostnam:[1,3,4],how:[1,3,4,5],howev:[1,5],http:[1,2,3,4,5],illustr:[1,4],imag:5,immedi:[1,3],impli:3,includ:[1,3],index:[1,3,4],info:1,inform:[0,4],insert:5,instal:[0,1],instanc:[1,4,5],instead:4,instruct:0,interpol:4,interv:[3,5],introduct:0,itself:1,job:[1,4,5],json:[1,4,5],just:0,keep:[3,4],kei:[1,4,5],kill:[3,5],kind:3,languag:3,latest:3,law:3,leader:[1,4,5],least:4,let:[0,3,4],licens:0,like:[0,1,4],limit:3,list:4,live:[3,5],llc:3,local:[2,4,5],locat:[3,4],lock:[1,3,4,5],log:1,logic:4,longer:1,look:[1,4],lookup:3,machin:2,made:3,mai:3,main:[0,1,3],maintain:[3,5],make:[1,2,4],manual:4,map:1,match:[0,1,3,4],max_parallel:5,media:4,memori:5,messag:[1,4],meta:5,method:[3,4],migrat:5,min_doc_count:[1,4],min_healthy_tim:5,mind:3,minut:[1,4],mode:[1,5],more:[1,3,4],morn:3,morningconsult:[1,2,5],multipl:[1,3],must:[1,4],name:[3,4],navig:1,need:5,network:5,newli:1,next:[1,3],next_queri:3,nil:4,node:[4,5],nomad:[0,4],nomad_meta_go_elasticsearch_alerts_vers:5,non:1,note:[1,4],now:1,number:3,object:4,onc:[1,2,5],onli:[1,4,5],open:1,oper:[0,1,3,4],option:[4,5],order:5,org:3,out:[0,1],output:[1,2,3],over:1,overview:0,page:[2,5],pars:[3,4,5],part:[0,2],pass:4,password:4,past:3,path:4,paus:3,payload:1,pem:[4,5],per:[1,3],perform:1,permiss:3,pertain:4,pick:1,pleas:4,point:3,port:[1,4],post:1,potenti:4,preced:4,prefer:2,present:4,print:5,privat:4,process:[1,3,5],product:4,program:[3,4],project:[0,2],proper:4,provid:4,publish:4,purpos:0,queri:[1,3,4,5],query_str:4,quick:1,quickli:1,rang:[1,4],rather:3,read:4,receiv:[0,1,3,4],recommend:4,recommended:4,record:[3,4],refer:[3,4],regardless:5,region:[4,5],releas:[0,2,5],reload:0,render:4,repeat:3,report:1,repositori:2,repres:[1,3],request:[1,4],requir:[3,4,5],reserv:3,resourc:5,respect:1,respond:4,respons:[3,4],respositori:1,restart:[3,5],result:4,right:3,robfig:4,rule:[0,1,3],rule_nam:3,run:[1,2,4,5],runtim:3,sai:4,salient:3,same:4,schedul:[1,3,4,5],scheme:4,script:1,search:4,section:[1,3,4,5],see:[1,3,4,5],seen:1,send:[3,4,5],sent:4,server:1,server_nam:[4,5],servic:[4,5],service_nam:4,set:[1,4],setup:0,sever:3,sha256:5,should:[1,3,4],shown:[0,3,4],sighup:5,signal:5,similar:3,simpl:3,simpli:[2,5],simplic:3,sinc:[1,4,5],size:[1,4],slack:[0,3],small:1,smtp:4,sni:4,softwar:3,some:[0,1,4],soon:1,sort:1,sourc:[1,5],specif:[3,4,5],specifi:[1,3,4],ssl:4,start:[0,1,3,5],startup:0,statu:1,stdout:1,step:[0,4],sticki:5,still:[1,2],stop:[1,5],store:[1,3,5],string:4,stringifi:4,struct:4,structur:4,summar:3,summari:[3,4],support:4,sure:[1,4],synchron:[4,5],syslog:[1,4],system:[1,4],take:4,tar:5,target_goarch:2,target_goo:2,task:5,technic:4,templat:[4,5],ten:4,term:[1,4],termin:1,test:[1,4],text:4,thei:[4,5],them:1,themselv:3,therefor:4,thi:[0,1,2,3,4,5],those:1,three:[3,4],time:[1,3,5],timestamp:[1,3,4],tls_enabl:[4,5],tmp:[1,4],token:4,topic:4,topic_arn:4,transform:[1,3],trigger:[1,3,4],two:1,type:[1,4,5],unavail:1,under:3,understand:4,unencrypt:4,uniqu:5,unless:3,until:3,updat:[3,5],upon:4,uri:4,url:[4,5],usag:[0,4],usernam:4,valid:4,valu:[1,3,4],variabl:[2,4],variant:2,veri:1,verif:4,verifi:4,verify_incom:4,version:3,via:[2,3,4],volum:5,wait:[1,3],want:[1,4],warranti:3,web:1,webhook:4,were:1,what:4,when:[0,1,3,4,5],where:[3,4],whether:[4,5],which:[1,4],whose:3,window:2,wish:[2,4,5],within:2,without:[3,4,5],work:1,world:4,would:[1,4],write:[0,1,3,4],written:4,wrote:1,www:3,x86:2,you:[0,1,2,3,4,5],your:[0,1,2,3,4,5],yourself:0,zero:1},titles:["Go Elasticsearch Alerts","Demonstration","Installation","Introduction","Setup","Usage"],titleterms:{alert:0,architectur:3,cleanup:1,client:4,configur:4,consul:[1,4],demonstr:1,distribut:5,docker:2,download:2,elasticsearch:[0,1,4],email:4,exampl:[4,5],file:4,filter:4,get:2,guid:0,instal:2,introduct:3,licens:3,main:4,nomad:5,oper:5,output:4,overview:3,paramet:4,purpos:3,reload:5,rule:[4,5],server:4,setup:[1,4],slack:4,startup:5,state:3,usag:5,user:0}}) \ No newline at end of file +Search.setIndex({envversion:47,filenames:["index","user/demo","user/install","user/intro","user/setup","user/usage"],objects:{},objnames:{},objtypes:{},terms:{"00z":3,"10m":4,"10t10":3,"13t15":1,"471f879ed2f31c030832553c6d9cb878dac5d413892ecad9b05a7446bdf3c807":5,"798z":1,"_doc":1,"_linux_x86_64":5,"_search":[1,4],"_sourc":4,"boolean":4,"case":1,"default":4,"function":5,"import":4,"int":4,"new":[0,1,3,4,5],"return":3,"true":[4,5],"try":[0,1],"var":1,"while":[1,3],abc:4,about:0,abov:[3,4],access:4,accord:5,achiev:3,acl:4,acquir:[1,5],across:5,action:1,actual:3,addition:[3,4],address:[4,5],affili:3,after:[1,4],again:[1,3],agg:4,aggreg:[1,4],agre:3,alerts_:5,all:[3,4,5],allow:[4,5],alpin:5,also:[1,2,3,4,5],altern:3,alwai:4,alwya:4,amazon:4,amd64:2,ani:[1,3,4,5],announc:1,anoth:[1,3,5],apach:3,api:4,apm:5,app:4,appear:1,applic:[1,3,4,5],arrai:4,artifact:5,asdfasdf:4,assign:4,assum:4,attempt:[1,3,5],attr:5,authent:4,auto_revert:5,aux:5,avoid:5,awk:5,background:0,bar:4,base:[3,4],bash:1,basi:3,becaus:[1,5],becom:[1,5],befor:[3,4],begin:0,behavior:4,below:[0,3,4,5],between:4,bim:4,bin:[1,2],binari:[2,5],bit:2,block:5,bodi:4,body_field:[1,4],bool:[1,4],brief:4,broswer:1,browser:1,bucket:4,build:2,built:3,ca_cert:[4,5],cacert:4,call:[1,5],can:[0,1,2,4,5],canari:5,cat:1,cert:[4,5],certif:4,chain:5,chang:5,change_mod:5,change_sign:5,charact:4,check:[0,1,5],checksum:5,cleanup:0,client_cert:[4,5],client_kei:[4,5],clone:[1,2],code:[1,5],com:[1,2,4,5],come:4,command:[1,2,5],commun:4,communc:4,compat:5,compil:2,complianc:3,compon:3,compos:1,concaten:4,condit:3,config:[4,5],configur:[0,1,3],connect:4,consider:4,constraint:5,consul:0,consul_cacert:4,consul_capath:4,consul_client_cert:4,consul_client_kei:4,consul_http_addr:[4,5],consul_http_ssl:4,consul_http_ssl_verifi:4,consul_http_token:4,consul_lock_kei:[4,5],consul_tls_server_nam:4,consult:3,contain:[1,2,5],content:[1,4],continu:5,control:4,copi:3,copyright:3,correspond:4,count:[4,5],cover:[2,5],cpu:5,creat:[0,1,5],cron:4,cross:2,ctrl:1,curl:[1,4],current:[1,4,5],custom:[3,4,5],daemon:5,data:[0,1,3,4,5],datacent:5,date:1,dedic:3,def:4,defin:[1,3,4,5],definit:5,delai:5,delet:1,demonstr:0,depend:4,desc:1,destin:5,detail:4,dictat:4,differ:4,directori:[2,4],disk:[3,4],distinct:3,distinct_host:5,distribut:[0,1,3,4],dns_server:5,doc_count:4,docker:[0,1],document:[0,1,2,3],done:1,down:1,download:0,driver:5,duplic:5,each:[3,4,5],east:[4,5],either:3,elast:5,elastalert:3,elasticserach:5,element:4,elsewher:4,email:3,enabl:[4,5],encod:4,end:4,endpoint:4,enforc:4,ensur:3,env:5,environ:[2,4],eof:1,eoh:5,ephemeral_disk:5,epoch:1,equal:3,error:[1,4,5],etc:[4,5],even:4,everi:[1,4],exact:4,exampl:[1,2,3],example_error:3,except:3,execut:[3,4,5],exist:[3,4],exit:1,expos:4,express:3,extens:4,fail:1,fals:4,fashion:[4,5],featur:[1,3,4,5],field:[1,3,4],file:[0,1,3],filebeat:4,filter:[0,1,3],find:[0,3,4],finish:2,first:1,flexibl:3,focus:0,follow:[1,2,3,4,5],foo:4,format:4,found:[2,4],from:[1,2,3,4,5],further:4,gea:1,gener:[3,4],get:[0,1],ghi:4,git:[1,2],github:[1,2,4,5],given:[1,3,4,5],gmail:4,go_elasticsearch_alerts_config_fil:[4,5],go_elasticsearch_alerts_rules_dir:[4,5],go_elasticsearch_alerts_smtp_password:4,go_elasticsearch_alerts_smtp_usernam:4,go_elasticsearch_alerts_vers:5,goe:1,gopath:2,goroutin:3,govern:3,greater:3,grep:5,group:[4,5],gte:1,handler:[1,3,4,5],hashicorp:[4,5],have:[1,2,4,5],header:[1,4],health:1,health_check:5,healthi:1,healthy_deadlin:5,hello:4,henceforth:3,here:[1,4],highli:5,hit:[3,4],hits_count:3,hold:5,hook:4,host:[3,4],hostnam:[1,3,4],how:[1,3,4,5],howev:[1,5],http:[1,2,3,4,5],illustr:[1,4],imag:5,immedi:[1,3],impli:3,includ:[1,3],index:[1,3,4],info:1,inform:[0,4],insert:5,instal:[0,1],instanc:[1,4,5],instead:4,instruct:0,interpol:4,interv:[3,5],introduct:0,itself:1,job:[1,4,5],json:[1,4,5],just:0,keep:[3,4],kei:[1,4,5],kill:[3,5],kind:3,languag:3,latest:3,law:3,leader:[1,4,5],least:4,let:[0,3,4],licens:0,like:[0,1,4],limit:[3,4],list:4,live:[3,5],llc:3,local:[2,4,5],locat:[3,4],lock:[1,3,4,5],log:1,logic:4,longer:1,look:[1,4],lookup:3,machin:2,made:3,mai:3,main:[0,1,3],maintain:[3,5],make:[1,2,4],manual:4,map:1,match:[0,1,3,4],max_parallel:5,media:4,memori:5,messag:[1,4],meta:5,method:[3,4],migrat:5,min_doc_count:[1,4],min_healthy_tim:5,mind:3,minut:[1,4],mode:[1,5],more:[1,3,4],morn:3,morningconsult:[1,2,5],multipl:[1,3],must:[1,4],name:[3,4],navig:1,need:5,network:5,newli:1,next:[1,3],next_queri:3,nil:4,node:[4,5],nomad:[0,4],nomad_meta_go_elasticsearch_alerts_vers:5,non:1,note:[1,4],now:1,number:3,object:4,onc:[1,2,5],onli:[1,4,5],open:1,oper:[0,1,3,4],option:[4,5],order:5,org:3,out:[0,1],output:[1,2,3],over:1,overview:0,page:[2,5],pars:[3,4,5],part:[0,2],pass:4,password:4,past:3,path:4,paus:3,payload:1,pem:[4,5],per:[1,3],perform:1,permiss:3,pertain:4,pick:1,pleas:4,point:3,port:[1,4],post:1,potenti:4,preced:4,prefer:2,present:4,print:5,privat:4,process:[1,3,5],product:4,program:[3,4],project:[0,2],proper:4,provid:4,publish:4,purpos:0,queri:[1,3,4,5],query_str:4,quick:1,quickli:1,rang:[1,4],rather:3,read:4,receiv:[0,1,3,4],recommend:4,recommended:4,record:[3,4],refer:[3,4],regardless:5,region:[4,5],releas:[0,2,5],reload:0,render:4,repeat:3,report:1,repositori:2,repres:[1,3],request:[1,4],requir:[3,4,5],reserv:3,resourc:5,respect:1,respond:4,respons:[3,4],respositori:1,restart:[3,5],result:4,right:3,robfig:4,rule:[0,1,3],rule_nam:3,run:[1,2,4,5],runtim:3,sai:4,salient:3,same:4,schedul:[1,3,4,5],scheme:4,script:1,search:4,section:[1,3,4,5],see:[1,3,4,5],seen:1,send:[3,4,5],sent:4,server:1,server_nam:[4,5],servic:[4,5],service_nam:4,set:[1,4],setup:0,sever:3,sha256:5,should:[1,3,4],shown:[0,3,4],sighup:5,signal:5,similar:3,simpl:3,simpli:[2,5],simplic:3,sinc:[1,4,5],size:[1,4],slack:[0,3],small:1,smtp:4,sni:4,softwar:3,some:[0,1,4],soon:1,sort:1,sourc:[1,5],specif:[3,4,5],specifi:[1,3,4],ssl:4,start:[0,1,3,5],startup:0,statu:1,stdout:1,step:[0,4],sticki:5,still:[1,2],stop:[1,5],store:[1,3,5],strict:4,string:4,stringifi:4,struct:4,structur:4,summar:3,summari:[3,4],support:4,sure:[1,4],synchron:[4,5],syslog:[1,4],system:[1,4],take:4,tar:5,target_goarch:2,target_goo:2,task:5,technic:4,templat:[4,5],ten:4,term:[1,4],termin:1,test:[1,4],text:4,thei:[4,5],them:1,themselv:3,therefor:4,thi:[0,1,2,3,4,5],those:1,three:[3,4],time:[1,3,5],timestamp:[1,3,4],tls_enabl:[4,5],tmp:[1,4],token:4,topic:4,topic_arn:4,transform:[1,3],trigger:[1,3,4],two:1,type:[1,4,5],unavail:1,under:3,understand:4,unencrypt:4,uniqu:5,unless:3,until:3,updat:[3,5],upon:4,uri:4,url:[4,5],usag:[0,4],usernam:4,valid:4,valu:[1,3,4],variabl:[2,4],variant:2,veri:1,verif:4,verifi:4,verify_incom:4,version:3,via:[2,3,4],volum:5,wait:[1,3],want:[1,4],warranti:3,web:1,webhook:4,were:1,what:4,when:[0,1,3,4,5],where:[3,4],whether:[4,5],which:[1,4],whose:3,window:2,wish:[2,4,5],within:2,without:[3,4,5],work:1,world:4,would:[1,4],write:[0,1,3,4],written:4,wrote:1,www:3,x86:2,you:[0,1,2,3,4,5],your:[0,1,2,3,4,5],yourself:0,zero:1},titles:["Go Elasticsearch Alerts","Demonstration","Installation","Introduction","Setup","Usage"],titleterms:{alert:0,architectur:3,cleanup:1,client:4,configur:4,consul:[1,4],demonstr:1,distribut:5,docker:2,download:2,elasticsearch:[0,1,4],email:4,exampl:[4,5],file:4,filter:4,get:2,guid:0,instal:2,introduct:3,licens:3,main:4,nomad:5,oper:5,output:4,overview:3,paramet:4,purpos:3,reload:5,rule:[4,5],server:4,setup:[1,4],slack:4,startup:5,state:3,usag:5,user:0}}) \ No newline at end of file diff --git a/docs/build/html/user/setup.html b/docs/build/html/user/setup.html index 724fb37..2f853b2 100644 --- a/docs/build/html/user/setup.html +++ b/docs/build/html/user/setup.html @@ -380,6 +380,9 @@

AWS SNS Output Parameters
{
   "name": "Filebeat Errors",
diff --git a/docs/user/setup.rst b/docs/user/setup.rst
index 4fd4ba7..07e4942 100644
--- a/docs/user/setup.rst
+++ b/docs/user/setup.rst
@@ -362,11 +362,15 @@ AWS SNS Output Parameters
 - :code-no-background:`template` (string: ``""``) - The message template that will
   define what alert messages will look like. This template is based on `Go templates
   `__. It allows you to interpolate an array
-  of `alert records 
+  of `alert records
   `__ 
   into the template to expose custom message formatting for your alerts. This field is
   required.
 
+**IMPORTANT**: If sending SMS messages with your SMS topic, a strict 140-character
+limit is enforced. Please take this into consideration when writing your message
+template.
+
 As an example, let's say you have this output method in one of your rule files:
 
 .. code-block:: json