From 43d87118415bb75d7bb107683e79cd6d69186f67 Mon Sep 17 00:00:00 2001 From: "Jonathan A. Sternberg" Date: Mon, 11 Apr 2016 14:05:24 -0400 Subject: [PATCH] Adding docker documentation for the TICK stack --- chronograf/README-short.txt | 1 + chronograf/content.md | 45 ++++++++++ chronograf/license.md | 1 + chronograf/logo.png | Bin 0 -> 8599 bytes influxdb/README-short.txt | 1 + influxdb/content.md | 123 +++++++++++++++++++++++++ influxdb/license.md | 1 + influxdb/logo.png | Bin 0 -> 8599 bytes kapacitor/README-short.txt | 1 + kapacitor/content.md | 132 +++++++++++++++++++++++++++ kapacitor/license.md | 1 + kapacitor/logo.png | Bin 0 -> 8599 bytes telegraf/README-short.txt | 1 + telegraf/content.md | 173 ++++++++++++++++++++++++++++++++++++ telegraf/license.md | 1 + telegraf/logo.png | Bin 0 -> 8599 bytes update.sh | 4 + 17 files changed, 485 insertions(+) create mode 100644 chronograf/README-short.txt create mode 100644 chronograf/content.md create mode 100644 chronograf/license.md create mode 100644 chronograf/logo.png create mode 100644 influxdb/README-short.txt create mode 100644 influxdb/content.md create mode 100644 influxdb/license.md create mode 100644 influxdb/logo.png create mode 100644 kapacitor/README-short.txt create mode 100644 kapacitor/content.md create mode 100644 kapacitor/license.md create mode 100644 kapacitor/logo.png create mode 100644 telegraf/README-short.txt create mode 100644 telegraf/content.md create mode 100644 telegraf/license.md create mode 100644 telegraf/logo.png diff --git a/chronograf/README-short.txt b/chronograf/README-short.txt new file mode 100644 index 000000000..dfa53c766 --- /dev/null +++ b/chronograf/README-short.txt @@ -0,0 +1 @@ +Chronograf is a visualization tool for time series data in InfluxDB. diff --git a/chronograf/content.md b/chronograf/content.md new file mode 100644 index 000000000..272af3f48 --- /dev/null +++ b/chronograf/content.md @@ -0,0 +1,45 @@ +# Chronograf + +Chronograf is a simple to install graphing and visualization application that you deploy behind your firewall to perform ad-hoc exploration of your InfluxDB data. It includes support for templates and a library of intelligent, pre-configured dashboards for common data sets. + +%%LOGO%% + +## Using this image + +By default, Chronograf listens on port `10000` and stores its data in a volume at `/var/lib/chronograf`. You can start an instance with: + +```console +$ docker run -p 10000:10000 chronograf +``` + +You can also use a custom configuration file or environment variables to modify Chronograf settings. + +### Using a custom config file + +A sample configuration file can be obtained by: + +```console +$ docker run --rm chronograf -sample-config > chronograf.toml +``` + +Once you've customized `chronograf.conf`, you can run the Chronograf container with it mounted in the expected location (note the name change!): + +```console +$ docker run -d \ + -p 10000:10000 \ + -v /path/to/chronograf.toml:/opt/chronograf/config.toml +``` + +### Using environment variables (preferred) + +You may have noticed that the default `Bind` value in the configuration is set to `127.0.0.1:10000`, though the container will listen on `0.0.0.0:10000` instead. This is due to a `CHRONOGRAF_BIND` environment variable being set in the Dockerfile to provide a sensible default within the Docker context. Other environment variables can override configuration settings following the `CamelCase` to `CHRONOGRAF_CAMEL_CASE` pattern: + +| SETTING | ENV VAR | +|-------------------------|---------------------------------------| +| Bind | CHRONOGRAF_BIND | +| LocalDatabase | CHRONOGRAF_LOCAL_DATABASE | +| QueryResponseBytesLimit | CHRONOGRAF_QUERY_RESPONSE_BYTES_LIMIT | + +## Official Documentation + +See the [official docs](https://docs.influxdata.com/chronograf/latest/introduction/getting_started/) for information on creating visualizations. diff --git a/chronograf/license.md b/chronograf/license.md new file mode 100644 index 000000000..08ddef497 --- /dev/null +++ b/chronograf/license.md @@ -0,0 +1 @@ +View [license information](https://github.com/influxdata/chronograf/blob/master/LICENSE) for the software contained in this image. diff --git a/chronograf/logo.png b/chronograf/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..814b2d78b59678c586d53bca63c727b7cfe7d007 GIT binary patch literal 8599 zcmV;IA!y!-P)PY|qAOJ~3 zK~#9!?VWj;A4QqRKQo!hK@xHiLI|XDG>MQjM<86XXyjg0kktitQQTd1*IQsw*9%-w zkjGU)-CdV;0ReSc6i`4SAOb?jNkWB?qjEHmKpCEWs8w)PW* z(MVu6Fuohx)C}AX+$yGH2i~hP9V@A%0<2mztfPVZfUzlmei3*MI2G6**a~a}#+7`` zD|F<&R=B)ZZwD^7jg`4uNhP&Qec8n)zfS?~%>b(xfOp4Qy$85h%)Xt#mw@*JKLAz~ zeB@~0?|?gj`+@s{FuFbnqZzK2m9%YNgOe+kHaaK>qdvV6tb#D=mj3hIqc@DtTTQI> zR&_>M4a?%JPQno7gHpb>5SS5bwaL2fbl_n?0Ve^wfdRk-j7RYjU`&ZNw*uRN&7ytX z9&7b@Z_%WJFdB*p={N$I0vrxZ67ZcIYqh4gYJfo)O##jWrpsnDL^icIfeoTLuf&9? z%#O8Mn{m%6z%&f6c{uPlu~r+ar`wfEmEGvJh4me2<~PPl1o^ zi%zrv=&w9qTMq2(O(vnVM~y1g!p2%$K8q77TgcNN29=Ea3b5U`!`TTeDlj}HS*$oXok{M5-$eGQL$roy1opm0=g0(?s&ACK|c9|7DMYjw{)1uUy!1A!ZX ze@MAzH*ig?)ipJ8CM`i2T>%^bTpNT@tC*GBfdet#wDG`+!mCV^%Qpit@M~bc4CILd zfVP~tF9tIQu$nNrl)c6r1Wp46d%n65<6zk=?=?imXBdVv9A^FBH|9$#D5_b*+8t}P zwim_j{SY`u{{8!X(SU{&u<8fg0(>Cjnvcg?{n(lOWf#nrAdLP&Z1rzqxT;M8RENo+ zZ4ywr784S&28d&=)?2rGCL zT?c$L)@okH7!DP%8jh*NF)rgi&(}In{v1Wt-!SP{WMl44b7riiJgnMhfMtPIJtjOM z%~WW?ge^SWl}TuYJG>Eu(K3uXJbB*zqS-wTtQXFwIo7HrO?8&%&lEM)ey0;Kk@kB_ zYiYm`?&~ozN=q=_o#$m>w~Ln5TTGArfxz>Xm*gE%`&{DeHp%CsJ@=WHM;BDmNshDr zy`Z=BUl2xPX^*|!f{Dr7H-Kf8hxr30Rw&J+xj5G9;RL8^=|ub5AdJotUMi6<#9G~u zV!GsUVlH4c3Siy57fq}^q9x{;VLinyl)e9OF}<^7eXP}XPoF2xABCT{n_uBi={a$t z3t0PLex%8GOc)E8RJ#}VLSJ-}dbwZ{#`~5AR%?L|##+tn3fkKqg&>SRfGO`7_hX1^_xcg?oj`ssjdYD2*}aXiMmJ(l)Nj$N`zzb4ws zidd`Xf-q{rI5oD)HLHrQxgd-V6b)@MaFC35J*EQ6M&M;x(~Ip?DQA5qYbub4m{>FEBH2(FY4-h(0MZNNHMI=sgLOWN=@jJI;Cm|Kmq*c)ZgAIIe2 zxz~l5Shl0AiQG@Pu(>jD34iceF*}FJ;P#_E%%BapEC{3fVy!Mr*~O*_01dFrW*<%P zH32O0<;QwUdw`Euz7sy88o9`dSB>j)H z-qj7h-Xq|(GYF$?0#+p4r*F+U)qcMxeKSbjw;^Q%*)8j9M-WCYi;{4=tV7#ExlU-7 zomM+-a5@)wC+VquZL*eEW&q-`n7Ga(t@++3Wz*ax&us;w0+V9Dj?10m9no%bM|JOknJsoRxqcd)Y;*Y|2B`cV8jwXII}T@7*Ha?!O>C*6?uo+x;oe=>uGbNz~8MK)(=cwKA)8kZ6uS!URaW zfYEA=SrXf}pUheN-Bw|8HS@UO6U9Or;DF#x3v83;Gzypv!Nfuy3tSz9(P^<(zjJuB zK@LdS;MAY=An7^**_9ap?rP+%($?LM_F6CZ-%mE^gMoJeUu($VGIWBF-2hhoWYK+I zI`%!WR@F|^bq`eFrH0Yeu~MEn2-U; zrv+j35U|G~rq2Mb@U-K{u~t7$+sLhhSpLHTt7eQd>oMV^UYGXnC#Fy!02+#>eLx;y zSz|Cm)|B1ne-MjhwV0LlGM^5XXG|3WeTsm2TMAe9Td{&#toeAZfJiGQQNA%_Ei6g_ z)jHq{4p==4JSvvNTIr{L0@{a&cKbH@os8jA4H)>%lHKZN(cOLNBnv>xPd7Hx#xeKb+l$jAh7>%$v ziasghTZ^m&)?4p!82(hGm9bX4ozHwG)+3#wcAE7=vs zdcO8dhNgNL{*ZvK$Z%)Z>kh!04ZLZ+hYvuS6993>b9$aemZr6cj3YZWXp_tVSFW*4 zFjvL_CpjTHw^E;!<<_OCqoRzmmZLpH|{xj_!#+zfUzM2PC*8L~j8h939H3|3fR1ii} zY}b83uo@|v(mQ~k#9DpWEj{DB;6|CSlY%hnTUH|y@-(d!&9uD`bQcv^=xGBnsfPfo z%~ItPPGF)%V(!VgerL)Lz%x#4mM_`6Nj4#Ok%c)LTyw^}+8=+B$4xdsT3Xf)vg?z9 z@q8uE_%x=Zcbe=F?In*Ux!f|9?vV9^?;2}ujk2`rEm?pi-#swd+y#)ol~hZ~dzP4I z_MFYDrjeSAU1VKZ4uOlUx%J5s%0R-WC9=9+Y)DsTi7LARcv@WP6!cgGz|X~taDA-R zr5PrXyMPzU?=xyJ%MzP-m-FW{_X6*pmq0u(V<0AG5W-oq9ur9TOdhvENAJ}R;O%1O z`@$I#Ia$7I{~Qba#8&z7N6I(38jsA2{&^(5htu-`)_Rw#wEFo5ht#!YMi540gD{%x zfQ>7+##;TXz!;rxEzJ94t(r@0m=i2ca5MhE%tJ6C0RT<0R(F)-n~!z@C`YtXG zzi*1Q+FjCuI>NG|wkG9ompEUVgbDh)MAZJfgD^TgP0O;%!4QPeR7^3ycLAS`wfYwy zSUH_MPZn1xv(UPJehSHZW{oCh8Sy1suZy+XmC|SXQM@elW5SEPPu}M&{2Bb)?V!F` ztJYYn1+i9hW33ipasabrxqNq?^RpnoL7D)_EfVNMz)u;H6iOW zf@U}2uikOBa5m#S8uDd%^C$=-n=pUb-KYv|xOOD@CQpo4ozNW#|9N-GIqqsqvkSD% z1~^sny=?FKePw`EDiPONCi%8{+QR}|1fL|)?PrTN@XH{KhNN*?R;~93orYsU3|OLj=gR^Yv{ zRyzvJ<0%$T^O_qdTtFs@hSi3@N^6~H%!%Av6a?gcZCDjhVy)iD8Sh5gE6J`(+kkWC z%CVM)w63J`V2Av~iH5Z+#VqWPNpAt;HoXMn)p{}rqXrwa+c0#duK8jkTIj=eV>6{3QCEti>yu z-SAog%h7mzsXdD`_^W;%z*^_gC?NT66ySw?*Sk`y=dp-P zFQ7H1iBH375k4+UJIzZt_Hhiym*LwyGLr0CTActyV$KfD;k;hX_*;DrK<|mQdcMGB z_)8B*mL}H$PZR+whtq3I_}CI_V2IN{i#+qZ4<<@H(d4$5oZEIl?6V~)kA)@IhYdKZ zF^;@4>p20-J&D#{Z`s^0r7XsNmZo$aCjI18;PxPlrUzm42~kP6W6mP{oeXfTl{IJ5 zULK|vkV!iv{3+#UNqHUMac!uY2 zUK{PB;ZgwWNYAya3(l3hDSoKQQ@{gM~?#!=YZrk%` ze#!3_svhCdkjmrg#c(=No=RH%v?`)+~Z-HEAAvZ=&|In)81MJ1=y{+5RIh6lV| z4QW9QbJhl+7fOEr#e(b5HC=a6z8uYXixb@1LBo>NkyTlpV>O@+_% z&bcKto@cu-XEy+weI=1ZlI)Q+MNK++uK~1sO}7-$-ko_f&Y~UKH7x53X$1|=V|W<{59NHtfo(Xga{$NudXdB3vfFuHM3vvM}%1l(Q$ww1IRj&-=dJOHYRG`BRQ1aP)t zg}M|}JjT%;$h$BZ&wA^NX&Tn}AdCh(l?w*~r(=>tpOC=9n+3Fv#Y9TqPWy>AzXp~B zVRTCnMyD4T%w*R%Qo;txN?I=1AyQqSJH?k;vzzSHioCqOIbF~;7UZxYsnWN2>Ce1TUx);+DxpU0Pz%_kit^Qad85_wQIo|{+Zcq==pc+f6ok>w zNDploME4&UI@tqQ8_7P_t8{3A_5MCD-&UZ>v&eiJ)*EERL8XXK<7tbvdfCy)^8m|z z-})eo1_WVrQ4mJ!WCQeGn^iSb*MiDXv~*eEJ{*#-YntW~Rr@SUE+LHS7Yab$;5NLyD zUyuX9u7=cH6hNeUN)mvZd+LpRe`L|`JJ${*B`&Q9uu6MJ(_VnHCDv+j2f(uAAv$Nb z&#(q(ASS8#7qM2W3!toB$m=Og_Ie-b_-UA`k7ojxV#xcagD_esrsW{u^FbK>78Ca~ z6;tT!2n(Q=VIuM8U>Acx6{#NJGch;108q<juH)^vBXf!^DNMh0RQN@b{XwunmbVlz(?apZT1MnY{wbmuDEp6kFJiy8r)I-V6#rva%mGQSczg=sKB0fAHM@V&H%RbH>)-7M56;*T|fo zP=te&fa5V1;Jj2sTM-z2wR`ynTN-j(tksHwTHvQJPP3D;IMFnZ(_;?N z*;gjhuY`x%CYo3+ft~LEn`LKTE0gCll0=$O&?(S+UrVQqr2nbN=$}@t4$2Rlt<1AIoS<- zCe~_c5Jq1oo7A5IoEmHOi=4S*b1kvQ^h-XQfJw$qGw+|znR7{BHj5dbW=FMqGR=lb!mkQJ^$|~8xfeYNSS9O3J{OPcxT^dZAJ-w(IHGG4X|dW0M>Cq z7(F5jZgs3xw;#K1b^5FzjDC#qFkTpIbyvpDQ7>G_e`MV94guJnILLIQXF=@oOuW1W zzs$2M`@E7{Je*n5-Ylm>USz#3z8J9Wz=o8*Uf+X&)$A;WI!x8j!#&qsB_LE6YxPtR zMo*JX>|ZVPhp!!tPCut<4nr}?(SHxv<%ORVx??1!MEF+ET~w=4TANSc017JH7$-T5Rm$+^**ZvjE^g-VLhDE zQIq7x14WJPb`VI=S6<`^}M?@Bz;~ zza49JomFN9Ox4jW&30-KM(4&_J>Z!~w)5#@K^UzOJ~26DWU7q&sa7BCkvaNh+RNT} z!xUnz)(2s<%c3MMmynGnF~KHcyn1h^qm$z)dCoiJ@0rygJV1O@5Jr)VV}pRpNWq2U zWWC;KDG$wDaVSiK(WP)tYd{Wq-gwvK!mQ!=)thmMGE!0)DSaWzn@4S5TGXGT@l2Kwq-f2%MBTrv1UL14nfynI`IKb>@3MHSOE70QX35={)0;YM zkit97#CXHgL(mmg9YyOLQA|XK>2?8+vUPF zw~BT+(BT(X%Gf^CX;7jtkvs1QL4qdXEJe~P8yp`Fqvex zc);qPVy(U@T0>7&Xt0U%7Uw770DVWqw`5#5$1`CE%e8G8*RM>gP+2hdZ;7Y9_PvJ6 z`D7}XIwij2%~d7b9Rd?%s1tI`iTZKTr`nZSyK;T&KNi&)@r_Z9}ltm zV@XyZr`4Zd#1zR)`fq=E))1MOtz!Ot5f~F|^&oRuptLbDcT79=CP{86L9uigaEZe&vp#-;KygO}9+qVOk#ajJW4{25IBpoOksO$2sO9Cf7 z2W$?^Fw0)cIo4@^(sKdZfLF8Pw`8)u;UT|&5Nq}6f@3oxgZST#Ie*dD{(6k3>QqeB z`I}+}KLnJY(cWj;^FW3ViUv;#I;W367vqcOz1%Btkr?5oTv*N?`WML1Q! zp;_K<0r0zo-*L%j@w~Rk`?M6`c#~A4bA)GVl<{3I{Ww44nnBXe; z#3<30U&nampT{|vB#l@P!sud5D9?ccUh9Q|cr>Z%;j|NJ=U~y)+H%)(5Jn#e!l*6f z=kGJLqV58N{_>n(IiDXCgwby@+SD9`(cjREBr8>^sTF9@S3qu-LB3ya*l*7n!> z4qbU(Pq(eszR7#PBBxT-(vP0XAKm(_p1=n8K6M#iIsp^L;2v18Nry!s$;B!f1kc`ihp5u}R(IF`3;`fT& zKoJ>_@s`|xIXH1q5JumZlp9}Y|7p^m5u)9tfz>S0tQHj|JO51ONKB?c7Fe}lf+(A+ zuBzlMtzmi03xY73hDk5Dkn}=%d6JO!w_sv0+9V#W672v00T@X{K~x%jlz^MB^vWZc zLq)e$W?&&L>ncoWN?Jnk{g^ZNTC1L_YcQg2dOLZ>{l?+$M<8h zv%liuTYe2(8f(>5fmQxkS=`~51+?t6nB~AJNdR!wmzDg<0alLIRVSL!@$&m5+K;yG z4!H#rrM#tDU^Ri(2QjHGLooSj=ZaIK>dQ+0^Z_deypp8I37ClVi|8E7RYtA`u8+0a zSuL>gW0PpbK^UEd$>qB;)=E`;xHs17r influxdb.conf +``` + +Modify the default configuration, which will now be available under `$PWD`. Then start the InfluxDB container. + +```console +$ docker run -p 8083:8083 -p 8086:8086 \ + -v $PWD:/etc/influxdb:ro \ + influxdb -config /etc/influxdb/influxdb.conf +``` + +Modify `$PWD` to the directory where you want to store the configuration file. + +For environment variables, the format is `INFLUXDB_$SECTION_$NAME`. All dashes (`-`) are replaced with underscores (`_`). If the variable isn't in a section, then omit that part. + +Examples: + +```console +INFLUXDB_REPORTING_DISABLED=true +INFLUXDB_META_DIR=/path/to/metadir +INFLUXDB_DATA_QUERY_LOG_ENABLED=false +``` + +Find more about configuring InfluxDB [here](https://docs.influxdata.com/influxdb/latest/introduction/installation/) + +### Graphite + +InfluxDB supports the Graphite line protocol, but the service and ports are not exposed by default. To run InfluxDB with Graphite support enabled, you can either use a configuration file or set the appropriate environment variables. + +### HTTP API + +Creating a DB named mydb: + +```console +$ curl -G http://localhost:8086/query --data-urlencode "q=CREATE DATABASE mydb" +``` + +Inserting into the DB: + +```console +$ curl -i -XPOST 'http://localhost:8086/write?db=mydb' --data-binary 'cpu_load_short,host=server01,region=us-west value=0.64 1434055562000000000' +``` + +Read more about this in the [official documentation](https://docs.influxdata.com/influxdb/latest/guides/writing_data/) + +### CLI / SHELL + +Start the container: + +```console +$ docker run --name=influxdb -d -p 8083:8083 -p 8086:8086 influxdb +``` + +Run the influx client in another container: + +```console +$ docker run --rm --link=influxdb -it influxdb influx -host influxdb +``` + +Alternatively, jump directly into the container: + +```console +$ docker exec -it influxdb influx +``` + +### Web Administrator Interface + +Navigate to [localhost:8083](http://localhost:8083) with your browser while running the container. + +See more about using the web admin [here](https://docs.influxdata.com/influxdb/latest/tools/web_admin/). diff --git a/influxdb/license.md b/influxdb/license.md new file mode 100644 index 000000000..ff1be876c --- /dev/null +++ b/influxdb/license.md @@ -0,0 +1 @@ +View [license information](https://github.com/influxdata/influxdb/blob/master/LICENSE) for the software contained in this image. diff --git a/influxdb/logo.png b/influxdb/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..814b2d78b59678c586d53bca63c727b7cfe7d007 GIT binary patch literal 8599 zcmV;IA!y!-P)PY|qAOJ~3 zK~#9!?VWj;A4QqRKQo!hK@xHiLI|XDG>MQjM<86XXyjg0kktitQQTd1*IQsw*9%-w zkjGU)-CdV;0ReSc6i`4SAOb?jNkWB?qjEHmKpCEWs8w)PW* z(MVu6Fuohx)C}AX+$yGH2i~hP9V@A%0<2mztfPVZfUzlmei3*MI2G6**a~a}#+7`` zD|F<&R=B)ZZwD^7jg`4uNhP&Qec8n)zfS?~%>b(xfOp4Qy$85h%)Xt#mw@*JKLAz~ zeB@~0?|?gj`+@s{FuFbnqZzK2m9%YNgOe+kHaaK>qdvV6tb#D=mj3hIqc@DtTTQI> zR&_>M4a?%JPQno7gHpb>5SS5bwaL2fbl_n?0Ve^wfdRk-j7RYjU`&ZNw*uRN&7ytX z9&7b@Z_%WJFdB*p={N$I0vrxZ67ZcIYqh4gYJfo)O##jWrpsnDL^icIfeoTLuf&9? z%#O8Mn{m%6z%&f6c{uPlu~r+ar`wfEmEGvJh4me2<~PPl1o^ zi%zrv=&w9qTMq2(O(vnVM~y1g!p2%$K8q77TgcNN29=Ea3b5U`!`TTeDlj}HS*$oXok{M5-$eGQL$roy1opm0=g0(?s&ACK|c9|7DMYjw{)1uUy!1A!ZX ze@MAzH*ig?)ipJ8CM`i2T>%^bTpNT@tC*GBfdet#wDG`+!mCV^%Qpit@M~bc4CILd zfVP~tF9tIQu$nNrl)c6r1Wp46d%n65<6zk=?=?imXBdVv9A^FBH|9$#D5_b*+8t}P zwim_j{SY`u{{8!X(SU{&u<8fg0(>Cjnvcg?{n(lOWf#nrAdLP&Z1rzqxT;M8RENo+ zZ4ywr784S&28d&=)?2rGCL zT?c$L)@okH7!DP%8jh*NF)rgi&(}In{v1Wt-!SP{WMl44b7riiJgnMhfMtPIJtjOM z%~WW?ge^SWl}TuYJG>Eu(K3uXJbB*zqS-wTtQXFwIo7HrO?8&%&lEM)ey0;Kk@kB_ zYiYm`?&~ozN=q=_o#$m>w~Ln5TTGArfxz>Xm*gE%`&{DeHp%CsJ@=WHM;BDmNshDr zy`Z=BUl2xPX^*|!f{Dr7H-Kf8hxr30Rw&J+xj5G9;RL8^=|ub5AdJotUMi6<#9G~u zV!GsUVlH4c3Siy57fq}^q9x{;VLinyl)e9OF}<^7eXP}XPoF2xABCT{n_uBi={a$t z3t0PLex%8GOc)E8RJ#}VLSJ-}dbwZ{#`~5AR%?L|##+tn3fkKqg&>SRfGO`7_hX1^_xcg?oj`ssjdYD2*}aXiMmJ(l)Nj$N`zzb4ws zidd`Xf-q{rI5oD)HLHrQxgd-V6b)@MaFC35J*EQ6M&M;x(~Ip?DQA5qYbub4m{>FEBH2(FY4-h(0MZNNHMI=sgLOWN=@jJI;Cm|Kmq*c)ZgAIIe2 zxz~l5Shl0AiQG@Pu(>jD34iceF*}FJ;P#_E%%BapEC{3fVy!Mr*~O*_01dFrW*<%P zH32O0<;QwUdw`Euz7sy88o9`dSB>j)H z-qj7h-Xq|(GYF$?0#+p4r*F+U)qcMxeKSbjw;^Q%*)8j9M-WCYi;{4=tV7#ExlU-7 zomM+-a5@)wC+VquZL*eEW&q-`n7Ga(t@++3Wz*ax&us;w0+V9Dj?10m9no%bM|JOknJsoRxqcd)Y;*Y|2B`cV8jwXII}T@7*Ha?!O>C*6?uo+x;oe=>uGbNz~8MK)(=cwKA)8kZ6uS!URaW zfYEA=SrXf}pUheN-Bw|8HS@UO6U9Or;DF#x3v83;Gzypv!Nfuy3tSz9(P^<(zjJuB zK@LdS;MAY=An7^**_9ap?rP+%($?LM_F6CZ-%mE^gMoJeUu($VGIWBF-2hhoWYK+I zI`%!WR@F|^bq`eFrH0Yeu~MEn2-U; zrv+j35U|G~rq2Mb@U-K{u~t7$+sLhhSpLHTt7eQd>oMV^UYGXnC#Fy!02+#>eLx;y zSz|Cm)|B1ne-MjhwV0LlGM^5XXG|3WeTsm2TMAe9Td{&#toeAZfJiGQQNA%_Ei6g_ z)jHq{4p==4JSvvNTIr{L0@{a&cKbH@os8jA4H)>%lHKZN(cOLNBnv>xPd7Hx#xeKb+l$jAh7>%$v ziasghTZ^m&)?4p!82(hGm9bX4ozHwG)+3#wcAE7=vs zdcO8dhNgNL{*ZvK$Z%)Z>kh!04ZLZ+hYvuS6993>b9$aemZr6cj3YZWXp_tVSFW*4 zFjvL_CpjTHw^E;!<<_OCqoRzmmZLpH|{xj_!#+zfUzM2PC*8L~j8h939H3|3fR1ii} zY}b83uo@|v(mQ~k#9DpWEj{DB;6|CSlY%hnTUH|y@-(d!&9uD`bQcv^=xGBnsfPfo z%~ItPPGF)%V(!VgerL)Lz%x#4mM_`6Nj4#Ok%c)LTyw^}+8=+B$4xdsT3Xf)vg?z9 z@q8uE_%x=Zcbe=F?In*Ux!f|9?vV9^?;2}ujk2`rEm?pi-#swd+y#)ol~hZ~dzP4I z_MFYDrjeSAU1VKZ4uOlUx%J5s%0R-WC9=9+Y)DsTi7LARcv@WP6!cgGz|X~taDA-R zr5PrXyMPzU?=xyJ%MzP-m-FW{_X6*pmq0u(V<0AG5W-oq9ur9TOdhvENAJ}R;O%1O z`@$I#Ia$7I{~Qba#8&z7N6I(38jsA2{&^(5htu-`)_Rw#wEFo5ht#!YMi540gD{%x zfQ>7+##;TXz!;rxEzJ94t(r@0m=i2ca5MhE%tJ6C0RT<0R(F)-n~!z@C`YtXG zzi*1Q+FjCuI>NG|wkG9ompEUVgbDh)MAZJfgD^TgP0O;%!4QPeR7^3ycLAS`wfYwy zSUH_MPZn1xv(UPJehSHZW{oCh8Sy1suZy+XmC|SXQM@elW5SEPPu}M&{2Bb)?V!F` ztJYYn1+i9hW33ipasabrxqNq?^RpnoL7D)_EfVNMz)u;H6iOW zf@U}2uikOBa5m#S8uDd%^C$=-n=pUb-KYv|xOOD@CQpo4ozNW#|9N-GIqqsqvkSD% z1~^sny=?FKePw`EDiPONCi%8{+QR}|1fL|)?PrTN@XH{KhNN*?R;~93orYsU3|OLj=gR^Yv{ zRyzvJ<0%$T^O_qdTtFs@hSi3@N^6~H%!%Av6a?gcZCDjhVy)iD8Sh5gE6J`(+kkWC z%CVM)w63J`V2Av~iH5Z+#VqWPNpAt;HoXMn)p{}rqXrwa+c0#duK8jkTIj=eV>6{3QCEti>yu z-SAog%h7mzsXdD`_^W;%z*^_gC?NT66ySw?*Sk`y=dp-P zFQ7H1iBH375k4+UJIzZt_Hhiym*LwyGLr0CTActyV$KfD;k;hX_*;DrK<|mQdcMGB z_)8B*mL}H$PZR+whtq3I_}CI_V2IN{i#+qZ4<<@H(d4$5oZEIl?6V~)kA)@IhYdKZ zF^;@4>p20-J&D#{Z`s^0r7XsNmZo$aCjI18;PxPlrUzm42~kP6W6mP{oeXfTl{IJ5 zULK|vkV!iv{3+#UNqHUMac!uY2 zUK{PB;ZgwWNYAya3(l3hDSoKQQ@{gM~?#!=YZrk%` ze#!3_svhCdkjmrg#c(=No=RH%v?`)+~Z-HEAAvZ=&|In)81MJ1=y{+5RIh6lV| z4QW9QbJhl+7fOEr#e(b5HC=a6z8uYXixb@1LBo>NkyTlpV>O@+_% z&bcKto@cu-XEy+weI=1ZlI)Q+MNK++uK~1sO}7-$-ko_f&Y~UKH7x53X$1|=V|W<{59NHtfo(Xga{$NudXdB3vfFuHM3vvM}%1l(Q$ww1IRj&-=dJOHYRG`BRQ1aP)t zg}M|}JjT%;$h$BZ&wA^NX&Tn}AdCh(l?w*~r(=>tpOC=9n+3Fv#Y9TqPWy>AzXp~B zVRTCnMyD4T%w*R%Qo;txN?I=1AyQqSJH?k;vzzSHioCqOIbF~;7UZxYsnWN2>Ce1TUx);+DxpU0Pz%_kit^Qad85_wQIo|{+Zcq==pc+f6ok>w zNDploME4&UI@tqQ8_7P_t8{3A_5MCD-&UZ>v&eiJ)*EERL8XXK<7tbvdfCy)^8m|z z-})eo1_WVrQ4mJ!WCQeGn^iSb*MiDXv~*eEJ{*#-YntW~Rr@SUE+LHS7Yab$;5NLyD zUyuX9u7=cH6hNeUN)mvZd+LpRe`L|`JJ${*B`&Q9uu6MJ(_VnHCDv+j2f(uAAv$Nb z&#(q(ASS8#7qM2W3!toB$m=Og_Ie-b_-UA`k7ojxV#xcagD_esrsW{u^FbK>78Ca~ z6;tT!2n(Q=VIuM8U>Acx6{#NJGch;108q<juH)^vBXf!^DNMh0RQN@b{XwunmbVlz(?apZT1MnY{wbmuDEp6kFJiy8r)I-V6#rva%mGQSczg=sKB0fAHM@V&H%RbH>)-7M56;*T|fo zP=te&fa5V1;Jj2sTM-z2wR`ynTN-j(tksHwTHvQJPP3D;IMFnZ(_;?N z*;gjhuY`x%CYo3+ft~LEn`LKTE0gCll0=$O&?(S+UrVQqr2nbN=$}@t4$2Rlt<1AIoS<- zCe~_c5Jq1oo7A5IoEmHOi=4S*b1kvQ^h-XQfJw$qGw+|znR7{BHj5dbW=FMqGR=lb!mkQJ^$|~8xfeYNSS9O3J{OPcxT^dZAJ-w(IHGG4X|dW0M>Cq z7(F5jZgs3xw;#K1b^5FzjDC#qFkTpIbyvpDQ7>G_e`MV94guJnILLIQXF=@oOuW1W zzs$2M`@E7{Je*n5-Ylm>USz#3z8J9Wz=o8*Uf+X&)$A;WI!x8j!#&qsB_LE6YxPtR zMo*JX>|ZVPhp!!tPCut<4nr}?(SHxv<%ORVx??1!MEF+ET~w=4TANSc017JH7$-T5Rm$+^**ZvjE^g-VLhDE zQIq7x14WJPb`VI=S6<`^}M?@Bz;~ zza49JomFN9Ox4jW&30-KM(4&_J>Z!~w)5#@K^UzOJ~26DWU7q&sa7BCkvaNh+RNT} z!xUnz)(2s<%c3MMmynGnF~KHcyn1h^qm$z)dCoiJ@0rygJV1O@5Jr)VV}pRpNWq2U zWWC;KDG$wDaVSiK(WP)tYd{Wq-gwvK!mQ!=)thmMGE!0)DSaWzn@4S5TGXGT@l2Kwq-f2%MBTrv1UL14nfynI`IKb>@3MHSOE70QX35={)0;YM zkit97#CXHgL(mmg9YyOLQA|XK>2?8+vUPF zw~BT+(BT(X%Gf^CX;7jtkvs1QL4qdXEJe~P8yp`Fqvex zc);qPVy(U@T0>7&Xt0U%7Uw770DVWqw`5#5$1`CE%e8G8*RM>gP+2hdZ;7Y9_PvJ6 z`D7}XIwij2%~d7b9Rd?%s1tI`iTZKTr`nZSyK;T&KNi&)@r_Z9}ltm zV@XyZr`4Zd#1zR)`fq=E))1MOtz!Ot5f~F|^&oRuptLbDcT79=CP{86L9uigaEZe&vp#-;KygO}9+qVOk#ajJW4{25IBpoOksO$2sO9Cf7 z2W$?^Fw0)cIo4@^(sKdZfLF8Pw`8)u;UT|&5Nq}6f@3oxgZST#Ie*dD{(6k3>QqeB z`I}+}KLnJY(cWj;^FW3ViUv;#I;W367vqcOz1%Btkr?5oTv*N?`WML1Q! zp;_K<0r0zo-*L%j@w~Rk`?M6`c#~A4bA)GVl<{3I{Ww44nnBXe; z#3<30U&nampT{|vB#l@P!sud5D9?ccUh9Q|cr>Z%;j|NJ=U~y)+H%)(5Jn#e!l*6f z=kGJLqV58N{_>n(IiDXCgwby@+SD9`(cjREBr8>^sTF9@S3qu-LB3ya*l*7n!> z4qbU(Pq(eszR7#PBBxT-(vP0XAKm(_p1=n8K6M#iIsp^L;2v18Nry!s$;B!f1kc`ihp5u}R(IF`3;`fT& zKoJ>_@s`|xIXH1q5JumZlp9}Y|7p^m5u)9tfz>S0tQHj|JO51ONKB?c7Fe}lf+(A+ zuBzlMtzmi03xY73hDk5Dkn}=%d6JO!w_sv0+9V#W672v00T@X{K~x%jlz^MB^vWZc zLq)e$W?&&L>ncoWN?Jnk{g^ZNTC1L_YcQg2dOLZ>{l?+$M<8h zv%liuTYe2(8f(>5fmQxkS=`~51+?t6nB~AJNdR!wmzDg<0alLIRVSL!@$&m5+K;yG z4!H#rrM#tDU^Ri(2QjHGLooSj=ZaIK>dQ+0^Z_deypp8I37ClVi|8E7RYtA`u8+0a zSuL>gW0PpbK^UEd$>qB;)=E`;xHs17r kapacitor.conf +``` + +Modify the default configuration, which will now be available under `$PWD`. Then start the Kapacitor container. + +```console +$ docker run -p 9092:9092 \ + -v $PWD:/etc/kapacitor:ro \ + kapacitord -config /etc/kapacitor/kapacitor.conf +``` + +Modify `$PWD` to the directory where you want to store the configuration file. + +For environment variables, the format is `KAPACITOR_$SECTION_$NAME`. All dashes (`-`) are replaced with underscores (`_`). If the variable isn't in a section, then omit that part. If the config section is an array, use a number to set the nth value in the configuration file. + +Examples: + +```console +KAPACITOR_HOSTNAME=kapacitor +KAPACITOR_LOGGING_LEVEL=INFO +KAPACITOR_REPORTING_ENABLED=false +KAPACITOR_INFLUXDB_0_URLS_0=http://influxdb:8086 +``` + +Find more about configuring Kapacitor [here](https://docs.influxdata.com/kapacitor/latest/introduction/installation/) + +### Exposed Ports + +- 9092 TCP -- HTTP API endpoint + +#### Subscriptions + +Subscriptions allow InfluxDB to push data to Kapacitor for faster alerting instead of requiring Kapacitor to pull data from InfluxDB. + +These examples assume you are using a custom configuration file that takes advantage of Docker's built-in service discovery capability. In order to do so, we'll first create a new network: + +```console +$ docker network create influxdb +``` + +Next, we'll start our InfluxDB container named `influxdb`: + +```console +$ docker run -d --name=influxdb \ + --net=influxdb \ + influxdb +``` + +Start the Kapacitor container with the container hostname matching the container name so Kapacitor can automatically create subscriptions correctly and with the `KAPACITOR_INFLUXDB_0_URLS_0` value set to point at InfluxDB. + +```console +$ docker run -p 9092:9092 \ + --name=kapacitor \ + -h kapacitor \ + --net=influxdb \ + -e KAPACITOR_INFLUXDB_0_URLS_0=http://influxdb:8086 \ + kapacitor +``` + +You can also start Kapacitor sharing the same network interface of the InfluxDB container. If you do this, Docker will act as if both processes were being run on the same machine. + +```console +$ docker run -p 9092:9092 \ + --name=kapacitor \ + --net=container:influxdb \ + kapacitor +``` + +When run like this, InfluxDB can be communicated with over `localhost`. + +### CLI / SHELL + +Start the container: + +```console +$ docker run --name=kapacitor -d -p 9092:9092 kapacitor +``` + +Run another container linked to the `kapacitor` container for using the client. Set the env `KAPACITOR_URL` so the client knows how to connect to Kapacitor. Mount in your current directory for accessing TICKscript files. + +```console +$ docker run --rm --net=container:kapacitor \ + -v $PWD:/root -w=/root -it \ + kapacitor bash -l +``` + +Then, from within the container, you can use the `kapacitor` command to interact with the daemon. + +See [this](https://docs.influxdata.com/kapacitor/latest/introduction/getting_started/) for a more detailed getting started guide with Kapacitor. diff --git a/kapacitor/license.md b/kapacitor/license.md new file mode 100644 index 000000000..7ca2b1c8a --- /dev/null +++ b/kapacitor/license.md @@ -0,0 +1 @@ +View [license information](https://github.com/influxdata/kapacitor/blob/master/LICENSE) for the software contained in this image. diff --git a/kapacitor/logo.png b/kapacitor/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..814b2d78b59678c586d53bca63c727b7cfe7d007 GIT binary patch literal 8599 zcmV;IA!y!-P)PY|qAOJ~3 zK~#9!?VWj;A4QqRKQo!hK@xHiLI|XDG>MQjM<86XXyjg0kktitQQTd1*IQsw*9%-w zkjGU)-CdV;0ReSc6i`4SAOb?jNkWB?qjEHmKpCEWs8w)PW* z(MVu6Fuohx)C}AX+$yGH2i~hP9V@A%0<2mztfPVZfUzlmei3*MI2G6**a~a}#+7`` zD|F<&R=B)ZZwD^7jg`4uNhP&Qec8n)zfS?~%>b(xfOp4Qy$85h%)Xt#mw@*JKLAz~ zeB@~0?|?gj`+@s{FuFbnqZzK2m9%YNgOe+kHaaK>qdvV6tb#D=mj3hIqc@DtTTQI> zR&_>M4a?%JPQno7gHpb>5SS5bwaL2fbl_n?0Ve^wfdRk-j7RYjU`&ZNw*uRN&7ytX z9&7b@Z_%WJFdB*p={N$I0vrxZ67ZcIYqh4gYJfo)O##jWrpsnDL^icIfeoTLuf&9? z%#O8Mn{m%6z%&f6c{uPlu~r+ar`wfEmEGvJh4me2<~PPl1o^ zi%zrv=&w9qTMq2(O(vnVM~y1g!p2%$K8q77TgcNN29=Ea3b5U`!`TTeDlj}HS*$oXok{M5-$eGQL$roy1opm0=g0(?s&ACK|c9|7DMYjw{)1uUy!1A!ZX ze@MAzH*ig?)ipJ8CM`i2T>%^bTpNT@tC*GBfdet#wDG`+!mCV^%Qpit@M~bc4CILd zfVP~tF9tIQu$nNrl)c6r1Wp46d%n65<6zk=?=?imXBdVv9A^FBH|9$#D5_b*+8t}P zwim_j{SY`u{{8!X(SU{&u<8fg0(>Cjnvcg?{n(lOWf#nrAdLP&Z1rzqxT;M8RENo+ zZ4ywr784S&28d&=)?2rGCL zT?c$L)@okH7!DP%8jh*NF)rgi&(}In{v1Wt-!SP{WMl44b7riiJgnMhfMtPIJtjOM z%~WW?ge^SWl}TuYJG>Eu(K3uXJbB*zqS-wTtQXFwIo7HrO?8&%&lEM)ey0;Kk@kB_ zYiYm`?&~ozN=q=_o#$m>w~Ln5TTGArfxz>Xm*gE%`&{DeHp%CsJ@=WHM;BDmNshDr zy`Z=BUl2xPX^*|!f{Dr7H-Kf8hxr30Rw&J+xj5G9;RL8^=|ub5AdJotUMi6<#9G~u zV!GsUVlH4c3Siy57fq}^q9x{;VLinyl)e9OF}<^7eXP}XPoF2xABCT{n_uBi={a$t z3t0PLex%8GOc)E8RJ#}VLSJ-}dbwZ{#`~5AR%?L|##+tn3fkKqg&>SRfGO`7_hX1^_xcg?oj`ssjdYD2*}aXiMmJ(l)Nj$N`zzb4ws zidd`Xf-q{rI5oD)HLHrQxgd-V6b)@MaFC35J*EQ6M&M;x(~Ip?DQA5qYbub4m{>FEBH2(FY4-h(0MZNNHMI=sgLOWN=@jJI;Cm|Kmq*c)ZgAIIe2 zxz~l5Shl0AiQG@Pu(>jD34iceF*}FJ;P#_E%%BapEC{3fVy!Mr*~O*_01dFrW*<%P zH32O0<;QwUdw`Euz7sy88o9`dSB>j)H z-qj7h-Xq|(GYF$?0#+p4r*F+U)qcMxeKSbjw;^Q%*)8j9M-WCYi;{4=tV7#ExlU-7 zomM+-a5@)wC+VquZL*eEW&q-`n7Ga(t@++3Wz*ax&us;w0+V9Dj?10m9no%bM|JOknJsoRxqcd)Y;*Y|2B`cV8jwXII}T@7*Ha?!O>C*6?uo+x;oe=>uGbNz~8MK)(=cwKA)8kZ6uS!URaW zfYEA=SrXf}pUheN-Bw|8HS@UO6U9Or;DF#x3v83;Gzypv!Nfuy3tSz9(P^<(zjJuB zK@LdS;MAY=An7^**_9ap?rP+%($?LM_F6CZ-%mE^gMoJeUu($VGIWBF-2hhoWYK+I zI`%!WR@F|^bq`eFrH0Yeu~MEn2-U; zrv+j35U|G~rq2Mb@U-K{u~t7$+sLhhSpLHTt7eQd>oMV^UYGXnC#Fy!02+#>eLx;y zSz|Cm)|B1ne-MjhwV0LlGM^5XXG|3WeTsm2TMAe9Td{&#toeAZfJiGQQNA%_Ei6g_ z)jHq{4p==4JSvvNTIr{L0@{a&cKbH@os8jA4H)>%lHKZN(cOLNBnv>xPd7Hx#xeKb+l$jAh7>%$v ziasghTZ^m&)?4p!82(hGm9bX4ozHwG)+3#wcAE7=vs zdcO8dhNgNL{*ZvK$Z%)Z>kh!04ZLZ+hYvuS6993>b9$aemZr6cj3YZWXp_tVSFW*4 zFjvL_CpjTHw^E;!<<_OCqoRzmmZLpH|{xj_!#+zfUzM2PC*8L~j8h939H3|3fR1ii} zY}b83uo@|v(mQ~k#9DpWEj{DB;6|CSlY%hnTUH|y@-(d!&9uD`bQcv^=xGBnsfPfo z%~ItPPGF)%V(!VgerL)Lz%x#4mM_`6Nj4#Ok%c)LTyw^}+8=+B$4xdsT3Xf)vg?z9 z@q8uE_%x=Zcbe=F?In*Ux!f|9?vV9^?;2}ujk2`rEm?pi-#swd+y#)ol~hZ~dzP4I z_MFYDrjeSAU1VKZ4uOlUx%J5s%0R-WC9=9+Y)DsTi7LARcv@WP6!cgGz|X~taDA-R zr5PrXyMPzU?=xyJ%MzP-m-FW{_X6*pmq0u(V<0AG5W-oq9ur9TOdhvENAJ}R;O%1O z`@$I#Ia$7I{~Qba#8&z7N6I(38jsA2{&^(5htu-`)_Rw#wEFo5ht#!YMi540gD{%x zfQ>7+##;TXz!;rxEzJ94t(r@0m=i2ca5MhE%tJ6C0RT<0R(F)-n~!z@C`YtXG zzi*1Q+FjCuI>NG|wkG9ompEUVgbDh)MAZJfgD^TgP0O;%!4QPeR7^3ycLAS`wfYwy zSUH_MPZn1xv(UPJehSHZW{oCh8Sy1suZy+XmC|SXQM@elW5SEPPu}M&{2Bb)?V!F` ztJYYn1+i9hW33ipasabrxqNq?^RpnoL7D)_EfVNMz)u;H6iOW zf@U}2uikOBa5m#S8uDd%^C$=-n=pUb-KYv|xOOD@CQpo4ozNW#|9N-GIqqsqvkSD% z1~^sny=?FKePw`EDiPONCi%8{+QR}|1fL|)?PrTN@XH{KhNN*?R;~93orYsU3|OLj=gR^Yv{ zRyzvJ<0%$T^O_qdTtFs@hSi3@N^6~H%!%Av6a?gcZCDjhVy)iD8Sh5gE6J`(+kkWC z%CVM)w63J`V2Av~iH5Z+#VqWPNpAt;HoXMn)p{}rqXrwa+c0#duK8jkTIj=eV>6{3QCEti>yu z-SAog%h7mzsXdD`_^W;%z*^_gC?NT66ySw?*Sk`y=dp-P zFQ7H1iBH375k4+UJIzZt_Hhiym*LwyGLr0CTActyV$KfD;k;hX_*;DrK<|mQdcMGB z_)8B*mL}H$PZR+whtq3I_}CI_V2IN{i#+qZ4<<@H(d4$5oZEIl?6V~)kA)@IhYdKZ zF^;@4>p20-J&D#{Z`s^0r7XsNmZo$aCjI18;PxPlrUzm42~kP6W6mP{oeXfTl{IJ5 zULK|vkV!iv{3+#UNqHUMac!uY2 zUK{PB;ZgwWNYAya3(l3hDSoKQQ@{gM~?#!=YZrk%` ze#!3_svhCdkjmrg#c(=No=RH%v?`)+~Z-HEAAvZ=&|In)81MJ1=y{+5RIh6lV| z4QW9QbJhl+7fOEr#e(b5HC=a6z8uYXixb@1LBo>NkyTlpV>O@+_% z&bcKto@cu-XEy+weI=1ZlI)Q+MNK++uK~1sO}7-$-ko_f&Y~UKH7x53X$1|=V|W<{59NHtfo(Xga{$NudXdB3vfFuHM3vvM}%1l(Q$ww1IRj&-=dJOHYRG`BRQ1aP)t zg}M|}JjT%;$h$BZ&wA^NX&Tn}AdCh(l?w*~r(=>tpOC=9n+3Fv#Y9TqPWy>AzXp~B zVRTCnMyD4T%w*R%Qo;txN?I=1AyQqSJH?k;vzzSHioCqOIbF~;7UZxYsnWN2>Ce1TUx);+DxpU0Pz%_kit^Qad85_wQIo|{+Zcq==pc+f6ok>w zNDploME4&UI@tqQ8_7P_t8{3A_5MCD-&UZ>v&eiJ)*EERL8XXK<7tbvdfCy)^8m|z z-})eo1_WVrQ4mJ!WCQeGn^iSb*MiDXv~*eEJ{*#-YntW~Rr@SUE+LHS7Yab$;5NLyD zUyuX9u7=cH6hNeUN)mvZd+LpRe`L|`JJ${*B`&Q9uu6MJ(_VnHCDv+j2f(uAAv$Nb z&#(q(ASS8#7qM2W3!toB$m=Og_Ie-b_-UA`k7ojxV#xcagD_esrsW{u^FbK>78Ca~ z6;tT!2n(Q=VIuM8U>Acx6{#NJGch;108q<juH)^vBXf!^DNMh0RQN@b{XwunmbVlz(?apZT1MnY{wbmuDEp6kFJiy8r)I-V6#rva%mGQSczg=sKB0fAHM@V&H%RbH>)-7M56;*T|fo zP=te&fa5V1;Jj2sTM-z2wR`ynTN-j(tksHwTHvQJPP3D;IMFnZ(_;?N z*;gjhuY`x%CYo3+ft~LEn`LKTE0gCll0=$O&?(S+UrVQqr2nbN=$}@t4$2Rlt<1AIoS<- zCe~_c5Jq1oo7A5IoEmHOi=4S*b1kvQ^h-XQfJw$qGw+|znR7{BHj5dbW=FMqGR=lb!mkQJ^$|~8xfeYNSS9O3J{OPcxT^dZAJ-w(IHGG4X|dW0M>Cq z7(F5jZgs3xw;#K1b^5FzjDC#qFkTpIbyvpDQ7>G_e`MV94guJnILLIQXF=@oOuW1W zzs$2M`@E7{Je*n5-Ylm>USz#3z8J9Wz=o8*Uf+X&)$A;WI!x8j!#&qsB_LE6YxPtR zMo*JX>|ZVPhp!!tPCut<4nr}?(SHxv<%ORVx??1!MEF+ET~w=4TANSc017JH7$-T5Rm$+^**ZvjE^g-VLhDE zQIq7x14WJPb`VI=S6<`^}M?@Bz;~ zza49JomFN9Ox4jW&30-KM(4&_J>Z!~w)5#@K^UzOJ~26DWU7q&sa7BCkvaNh+RNT} z!xUnz)(2s<%c3MMmynGnF~KHcyn1h^qm$z)dCoiJ@0rygJV1O@5Jr)VV}pRpNWq2U zWWC;KDG$wDaVSiK(WP)tYd{Wq-gwvK!mQ!=)thmMGE!0)DSaWzn@4S5TGXGT@l2Kwq-f2%MBTrv1UL14nfynI`IKb>@3MHSOE70QX35={)0;YM zkit97#CXHgL(mmg9YyOLQA|XK>2?8+vUPF zw~BT+(BT(X%Gf^CX;7jtkvs1QL4qdXEJe~P8yp`Fqvex zc);qPVy(U@T0>7&Xt0U%7Uw770DVWqw`5#5$1`CE%e8G8*RM>gP+2hdZ;7Y9_PvJ6 z`D7}XIwij2%~d7b9Rd?%s1tI`iTZKTr`nZSyK;T&KNi&)@r_Z9}ltm zV@XyZr`4Zd#1zR)`fq=E))1MOtz!Ot5f~F|^&oRuptLbDcT79=CP{86L9uigaEZe&vp#-;KygO}9+qVOk#ajJW4{25IBpoOksO$2sO9Cf7 z2W$?^Fw0)cIo4@^(sKdZfLF8Pw`8)u;UT|&5Nq}6f@3oxgZST#Ie*dD{(6k3>QqeB z`I}+}KLnJY(cWj;^FW3ViUv;#I;W367vqcOz1%Btkr?5oTv*N?`WML1Q! zp;_K<0r0zo-*L%j@w~Rk`?M6`c#~A4bA)GVl<{3I{Ww44nnBXe; z#3<30U&nampT{|vB#l@P!sud5D9?ccUh9Q|cr>Z%;j|NJ=U~y)+H%)(5Jn#e!l*6f z=kGJLqV58N{_>n(IiDXCgwby@+SD9`(cjREBr8>^sTF9@S3qu-LB3ya*l*7n!> z4qbU(Pq(eszR7#PBBxT-(vP0XAKm(_p1=n8K6M#iIsp^L;2v18Nry!s$;B!f1kc`ihp5u}R(IF`3;`fT& zKoJ>_@s`|xIXH1q5JumZlp9}Y|7p^m5u)9tfz>S0tQHj|JO51ONKB?c7Fe}lf+(A+ zuBzlMtzmi03xY73hDk5Dkn}=%d6JO!w_sv0+9V#W672v00T@X{K~x%jlz^MB^vWZc zLq)e$W?&&L>ncoWN?Jnk{g^ZNTC1L_YcQg2dOLZ>{l?+$M<8h zv%liuTYe2(8f(>5fmQxkS=`~51+?t6nB~AJNdR!wmzDg<0alLIRVSL!@$&m5+K;yG z4!H#rrM#tDU^Ri(2QjHGLooSj=ZaIK>dQ+0^Z_deypp8I37ClVi|8E7RYtA`u8+0a zSuL>gW0PpbK^UEd$>qB;)=E`;xHs17r telegraf.conf +``` + +Once you've customized `telegraf.conf`, you can run the Telegraf container with it mounted in the expected location: + +```console +$ docker run -v /path/to/telegraf.conf:/etc/telegraf/telegraf.conf:ro telegraf +``` + +Read more about the Telegraf configuration [here](https://docs.influxdata.com/telegraf/latest/introduction/configuration/). + +### Using the container with input plugins + +These examples assume you are using a custom configuration file that takes advantage of Docker's built-in service discovery capability. In order to do so, we'll first create a new network: + +```console +$ docker network create telegraf_nw +``` + +Next, we'll start our InfluxDB container named `influxdb`: + +```console +$ docker run -d --name influxdb \ + --net=telegraf_nw \ + -p 8083:8083 -p 8086:8086 \ + influxdb +``` + +The `telegraf.conf` configuration can now resolve the `influxdb` container by name: + +```toml +[[outputs.influxdb]] + urls = ["http://influxdb:8086"] +``` + +Finally, we start our Telegraf container and verify functionality: + +```console +$ docker run -d --name telegraf \ + --net=telegraf_nw \ + -v /path/to/telegraf.conf:/etc/telegraf/telegraf.conf:ro \ + telegraf +... +$ docker logs -f telegraf +``` + +#### Aerospike + +Start an instance of aerospike: + +```console +$ docker run -d --name aerospike \ + --net=telegraf_nw \ + -p 3000-3003:3000-3003 \ + aerospike +``` + +Edit your Telegraf config file and set the correct connection parameter for Aerospike: + +```toml +[[inputs.aerospike]] + servers = ["aerospike:3000"] +``` + +Restart your `telegraf` container to pick up the changes: + +```console +$ docker restart telegraf +``` + +#### Nginx + +Create an `nginx_status.conf` configuration file to expose metric data: + +```nginx +server { + listen 8090; + location /nginx_status { + stub_status on; + access_log on; + } +} +``` + +Start an Nginx container utilizing it: + +```console +$ docker run -d --name=nginx \ + --net=telegraf_nw \ + -p 8090:8090 -p 8080:80 \ + -v /path/to/nginx_status.conf:/etc/nginx/conf.d/nginx_status.conf:ro \ + nginx +``` + +Verify the status page: [http://localhost:8090/nginx_status](http://localhost:8090/nginx_status). + +Configure the nginx input plugin in your Telegraf configuration file: + +```toml +[[inputs.nginx]] + urls = ["http://nginx:8090/nginx_status"] +``` + +Restart your `telegraf` container to pick up the changes: + +```console +$ docker restart telegraf +``` + +#### StatsD + +Telegraf has a StatsD plugin, allowing Telegraf to run as a StatsD server that metrics can be sent to. In order for this to work, you must first configure the [StatsD plugin](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/statsd) in your config file. + +Run Telegraf with the UDP port 8125 exposed: + +```console +$ docker run -d --name telegraf \ + --net=telegraf_nw \ + -p 8125:8125/udp \ + -v /path/to/telegraf.conf:/etc/telegraf/telegraf.conf:ro \ + telegraf +``` + +Send Mock StatsD data: + +```console +$ for i in {1..50}; do echo $i;echo "foo:1|c" | nc -u -w0 127.0.0.1 8125; done +``` + +Check that the measurement `foo` is added in the DB. + +### Supported Plugins Reference + +- [Input Plugins](https://docs.influxdata.com/telegraf/latest/outputs/) + +- [Output Plugins](https://docs.influxdata.com/telegraf/latest/outputs/) diff --git a/telegraf/license.md b/telegraf/license.md new file mode 100644 index 000000000..587ef1108 --- /dev/null +++ b/telegraf/license.md @@ -0,0 +1 @@ +View [license information](https://github.com/influxdata/telegraf/blob/master/LICENSE) for the software contained in this image. diff --git a/telegraf/logo.png b/telegraf/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..814b2d78b59678c586d53bca63c727b7cfe7d007 GIT binary patch literal 8599 zcmV;IA!y!-P)PY|qAOJ~3 zK~#9!?VWj;A4QqRKQo!hK@xHiLI|XDG>MQjM<86XXyjg0kktitQQTd1*IQsw*9%-w zkjGU)-CdV;0ReSc6i`4SAOb?jNkWB?qjEHmKpCEWs8w)PW* z(MVu6Fuohx)C}AX+$yGH2i~hP9V@A%0<2mztfPVZfUzlmei3*MI2G6**a~a}#+7`` zD|F<&R=B)ZZwD^7jg`4uNhP&Qec8n)zfS?~%>b(xfOp4Qy$85h%)Xt#mw@*JKLAz~ zeB@~0?|?gj`+@s{FuFbnqZzK2m9%YNgOe+kHaaK>qdvV6tb#D=mj3hIqc@DtTTQI> zR&_>M4a?%JPQno7gHpb>5SS5bwaL2fbl_n?0Ve^wfdRk-j7RYjU`&ZNw*uRN&7ytX z9&7b@Z_%WJFdB*p={N$I0vrxZ67ZcIYqh4gYJfo)O##jWrpsnDL^icIfeoTLuf&9? z%#O8Mn{m%6z%&f6c{uPlu~r+ar`wfEmEGvJh4me2<~PPl1o^ zi%zrv=&w9qTMq2(O(vnVM~y1g!p2%$K8q77TgcNN29=Ea3b5U`!`TTeDlj}HS*$oXok{M5-$eGQL$roy1opm0=g0(?s&ACK|c9|7DMYjw{)1uUy!1A!ZX ze@MAzH*ig?)ipJ8CM`i2T>%^bTpNT@tC*GBfdet#wDG`+!mCV^%Qpit@M~bc4CILd zfVP~tF9tIQu$nNrl)c6r1Wp46d%n65<6zk=?=?imXBdVv9A^FBH|9$#D5_b*+8t}P zwim_j{SY`u{{8!X(SU{&u<8fg0(>Cjnvcg?{n(lOWf#nrAdLP&Z1rzqxT;M8RENo+ zZ4ywr784S&28d&=)?2rGCL zT?c$L)@okH7!DP%8jh*NF)rgi&(}In{v1Wt-!SP{WMl44b7riiJgnMhfMtPIJtjOM z%~WW?ge^SWl}TuYJG>Eu(K3uXJbB*zqS-wTtQXFwIo7HrO?8&%&lEM)ey0;Kk@kB_ zYiYm`?&~ozN=q=_o#$m>w~Ln5TTGArfxz>Xm*gE%`&{DeHp%CsJ@=WHM;BDmNshDr zy`Z=BUl2xPX^*|!f{Dr7H-Kf8hxr30Rw&J+xj5G9;RL8^=|ub5AdJotUMi6<#9G~u zV!GsUVlH4c3Siy57fq}^q9x{;VLinyl)e9OF}<^7eXP}XPoF2xABCT{n_uBi={a$t z3t0PLex%8GOc)E8RJ#}VLSJ-}dbwZ{#`~5AR%?L|##+tn3fkKqg&>SRfGO`7_hX1^_xcg?oj`ssjdYD2*}aXiMmJ(l)Nj$N`zzb4ws zidd`Xf-q{rI5oD)HLHrQxgd-V6b)@MaFC35J*EQ6M&M;x(~Ip?DQA5qYbub4m{>FEBH2(FY4-h(0MZNNHMI=sgLOWN=@jJI;Cm|Kmq*c)ZgAIIe2 zxz~l5Shl0AiQG@Pu(>jD34iceF*}FJ;P#_E%%BapEC{3fVy!Mr*~O*_01dFrW*<%P zH32O0<;QwUdw`Euz7sy88o9`dSB>j)H z-qj7h-Xq|(GYF$?0#+p4r*F+U)qcMxeKSbjw;^Q%*)8j9M-WCYi;{4=tV7#ExlU-7 zomM+-a5@)wC+VquZL*eEW&q-`n7Ga(t@++3Wz*ax&us;w0+V9Dj?10m9no%bM|JOknJsoRxqcd)Y;*Y|2B`cV8jwXII}T@7*Ha?!O>C*6?uo+x;oe=>uGbNz~8MK)(=cwKA)8kZ6uS!URaW zfYEA=SrXf}pUheN-Bw|8HS@UO6U9Or;DF#x3v83;Gzypv!Nfuy3tSz9(P^<(zjJuB zK@LdS;MAY=An7^**_9ap?rP+%($?LM_F6CZ-%mE^gMoJeUu($VGIWBF-2hhoWYK+I zI`%!WR@F|^bq`eFrH0Yeu~MEn2-U; zrv+j35U|G~rq2Mb@U-K{u~t7$+sLhhSpLHTt7eQd>oMV^UYGXnC#Fy!02+#>eLx;y zSz|Cm)|B1ne-MjhwV0LlGM^5XXG|3WeTsm2TMAe9Td{&#toeAZfJiGQQNA%_Ei6g_ z)jHq{4p==4JSvvNTIr{L0@{a&cKbH@os8jA4H)>%lHKZN(cOLNBnv>xPd7Hx#xeKb+l$jAh7>%$v ziasghTZ^m&)?4p!82(hGm9bX4ozHwG)+3#wcAE7=vs zdcO8dhNgNL{*ZvK$Z%)Z>kh!04ZLZ+hYvuS6993>b9$aemZr6cj3YZWXp_tVSFW*4 zFjvL_CpjTHw^E;!<<_OCqoRzmmZLpH|{xj_!#+zfUzM2PC*8L~j8h939H3|3fR1ii} zY}b83uo@|v(mQ~k#9DpWEj{DB;6|CSlY%hnTUH|y@-(d!&9uD`bQcv^=xGBnsfPfo z%~ItPPGF)%V(!VgerL)Lz%x#4mM_`6Nj4#Ok%c)LTyw^}+8=+B$4xdsT3Xf)vg?z9 z@q8uE_%x=Zcbe=F?In*Ux!f|9?vV9^?;2}ujk2`rEm?pi-#swd+y#)ol~hZ~dzP4I z_MFYDrjeSAU1VKZ4uOlUx%J5s%0R-WC9=9+Y)DsTi7LARcv@WP6!cgGz|X~taDA-R zr5PrXyMPzU?=xyJ%MzP-m-FW{_X6*pmq0u(V<0AG5W-oq9ur9TOdhvENAJ}R;O%1O z`@$I#Ia$7I{~Qba#8&z7N6I(38jsA2{&^(5htu-`)_Rw#wEFo5ht#!YMi540gD{%x zfQ>7+##;TXz!;rxEzJ94t(r@0m=i2ca5MhE%tJ6C0RT<0R(F)-n~!z@C`YtXG zzi*1Q+FjCuI>NG|wkG9ompEUVgbDh)MAZJfgD^TgP0O;%!4QPeR7^3ycLAS`wfYwy zSUH_MPZn1xv(UPJehSHZW{oCh8Sy1suZy+XmC|SXQM@elW5SEPPu}M&{2Bb)?V!F` ztJYYn1+i9hW33ipasabrxqNq?^RpnoL7D)_EfVNMz)u;H6iOW zf@U}2uikOBa5m#S8uDd%^C$=-n=pUb-KYv|xOOD@CQpo4ozNW#|9N-GIqqsqvkSD% z1~^sny=?FKePw`EDiPONCi%8{+QR}|1fL|)?PrTN@XH{KhNN*?R;~93orYsU3|OLj=gR^Yv{ zRyzvJ<0%$T^O_qdTtFs@hSi3@N^6~H%!%Av6a?gcZCDjhVy)iD8Sh5gE6J`(+kkWC z%CVM)w63J`V2Av~iH5Z+#VqWPNpAt;HoXMn)p{}rqXrwa+c0#duK8jkTIj=eV>6{3QCEti>yu z-SAog%h7mzsXdD`_^W;%z*^_gC?NT66ySw?*Sk`y=dp-P zFQ7H1iBH375k4+UJIzZt_Hhiym*LwyGLr0CTActyV$KfD;k;hX_*;DrK<|mQdcMGB z_)8B*mL}H$PZR+whtq3I_}CI_V2IN{i#+qZ4<<@H(d4$5oZEIl?6V~)kA)@IhYdKZ zF^;@4>p20-J&D#{Z`s^0r7XsNmZo$aCjI18;PxPlrUzm42~kP6W6mP{oeXfTl{IJ5 zULK|vkV!iv{3+#UNqHUMac!uY2 zUK{PB;ZgwWNYAya3(l3hDSoKQQ@{gM~?#!=YZrk%` ze#!3_svhCdkjmrg#c(=No=RH%v?`)+~Z-HEAAvZ=&|In)81MJ1=y{+5RIh6lV| z4QW9QbJhl+7fOEr#e(b5HC=a6z8uYXixb@1LBo>NkyTlpV>O@+_% z&bcKto@cu-XEy+weI=1ZlI)Q+MNK++uK~1sO}7-$-ko_f&Y~UKH7x53X$1|=V|W<{59NHtfo(Xga{$NudXdB3vfFuHM3vvM}%1l(Q$ww1IRj&-=dJOHYRG`BRQ1aP)t zg}M|}JjT%;$h$BZ&wA^NX&Tn}AdCh(l?w*~r(=>tpOC=9n+3Fv#Y9TqPWy>AzXp~B zVRTCnMyD4T%w*R%Qo;txN?I=1AyQqSJH?k;vzzSHioCqOIbF~;7UZxYsnWN2>Ce1TUx);+DxpU0Pz%_kit^Qad85_wQIo|{+Zcq==pc+f6ok>w zNDploME4&UI@tqQ8_7P_t8{3A_5MCD-&UZ>v&eiJ)*EERL8XXK<7tbvdfCy)^8m|z z-})eo1_WVrQ4mJ!WCQeGn^iSb*MiDXv~*eEJ{*#-YntW~Rr@SUE+LHS7Yab$;5NLyD zUyuX9u7=cH6hNeUN)mvZd+LpRe`L|`JJ${*B`&Q9uu6MJ(_VnHCDv+j2f(uAAv$Nb z&#(q(ASS8#7qM2W3!toB$m=Og_Ie-b_-UA`k7ojxV#xcagD_esrsW{u^FbK>78Ca~ z6;tT!2n(Q=VIuM8U>Acx6{#NJGch;108q<juH)^vBXf!^DNMh0RQN@b{XwunmbVlz(?apZT1MnY{wbmuDEp6kFJiy8r)I-V6#rva%mGQSczg=sKB0fAHM@V&H%RbH>)-7M56;*T|fo zP=te&fa5V1;Jj2sTM-z2wR`ynTN-j(tksHwTHvQJPP3D;IMFnZ(_;?N z*;gjhuY`x%CYo3+ft~LEn`LKTE0gCll0=$O&?(S+UrVQqr2nbN=$}@t4$2Rlt<1AIoS<- zCe~_c5Jq1oo7A5IoEmHOi=4S*b1kvQ^h-XQfJw$qGw+|znR7{BHj5dbW=FMqGR=lb!mkQJ^$|~8xfeYNSS9O3J{OPcxT^dZAJ-w(IHGG4X|dW0M>Cq z7(F5jZgs3xw;#K1b^5FzjDC#qFkTpIbyvpDQ7>G_e`MV94guJnILLIQXF=@oOuW1W zzs$2M`@E7{Je*n5-Ylm>USz#3z8J9Wz=o8*Uf+X&)$A;WI!x8j!#&qsB_LE6YxPtR zMo*JX>|ZVPhp!!tPCut<4nr}?(SHxv<%ORVx??1!MEF+ET~w=4TANSc017JH7$-T5Rm$+^**ZvjE^g-VLhDE zQIq7x14WJPb`VI=S6<`^}M?@Bz;~ zza49JomFN9Ox4jW&30-KM(4&_J>Z!~w)5#@K^UzOJ~26DWU7q&sa7BCkvaNh+RNT} z!xUnz)(2s<%c3MMmynGnF~KHcyn1h^qm$z)dCoiJ@0rygJV1O@5Jr)VV}pRpNWq2U zWWC;KDG$wDaVSiK(WP)tYd{Wq-gwvK!mQ!=)thmMGE!0)DSaWzn@4S5TGXGT@l2Kwq-f2%MBTrv1UL14nfynI`IKb>@3MHSOE70QX35={)0;YM zkit97#CXHgL(mmg9YyOLQA|XK>2?8+vUPF zw~BT+(BT(X%Gf^CX;7jtkvs1QL4qdXEJe~P8yp`Fqvex zc);qPVy(U@T0>7&Xt0U%7Uw770DVWqw`5#5$1`CE%e8G8*RM>gP+2hdZ;7Y9_PvJ6 z`D7}XIwij2%~d7b9Rd?%s1tI`iTZKTr`nZSyK;T&KNi&)@r_Z9}ltm zV@XyZr`4Zd#1zR)`fq=E))1MOtz!Ot5f~F|^&oRuptLbDcT79=CP{86L9uigaEZe&vp#-;KygO}9+qVOk#ajJW4{25IBpoOksO$2sO9Cf7 z2W$?^Fw0)cIo4@^(sKdZfLF8Pw`8)u;UT|&5Nq}6f@3oxgZST#Ie*dD{(6k3>QqeB z`I}+}KLnJY(cWj;^FW3ViUv;#I;W367vqcOz1%Btkr?5oTv*N?`WML1Q! zp;_K<0r0zo-*L%j@w~Rk`?M6`c#~A4bA)GVl<{3I{Ww44nnBXe; z#3<30U&nampT{|vB#l@P!sud5D9?ccUh9Q|cr>Z%;j|NJ=U~y)+H%)(5Jn#e!l*6f z=kGJLqV58N{_>n(IiDXCgwby@+SD9`(cjREBr8>^sTF9@S3qu-LB3ya*l*7n!> z4qbU(Pq(eszR7#PBBxT-(vP0XAKm(_p1=n8K6M#iIsp^L;2v18Nry!s$;B!f1kc`ihp5u}R(IF`3;`fT& zKoJ>_@s`|xIXH1q5JumZlp9}Y|7p^m5u)9tfz>S0tQHj|JO51ONKB?c7Fe}lf+(A+ zuBzlMtzmi03xY73hDk5Dkn}=%d6JO!w_sv0+9V#W672v00T@X{K~x%jlz^MB^vWZc zLq)e$W?&&L>ncoWN?Jnk{g^ZNTC1L_YcQg2dOLZ>{l?+$M<8h zv%liuTYe2(8f(>5fmQxkS=`~51+?t6nB~AJNdR!wmzDg<0alLIRVSL!@$&m5+K;yG z4!H#rrM#tDU^Ri(2QjHGLooSj=ZaIK>dQ+0^Z_deypp8I37ClVi|8E7RYtA`u8+0a zSuL>gW0PpbK^UEd$>qB;)=E`;xHs17r