From a5f0adf37d565da92f96ef368061e5f07273cefa Mon Sep 17 00:00:00 2001 From: Kaarina Tungseth Date: Tue, 23 May 2023 10:41:42 -0500 Subject: [PATCH] [DOCS] Adds 8.8 Viz docs (#157215) ## Summary Adds the 8.8 documentation for the following: - Enable report sharing: https://github.com/elastic/kibana/pull/153429 Docs preview: https://kibana_157215.docs-preview.app.elstc.co/guide/en/kibana/master/reporting-getting-started.html - Random sampling feature: https://github.com/elastic/kibana/pull/143221 Docs preview: https://kibana_157215.docs-preview.app.elstc.co/guide/en/kibana/master/lens.html#improve-visualization-loading-time - Improve Ignore global filters UI: https://github.com/elastic/kibana/pull/154441 and https://github.com/elastic/kibana/pull/155280 Docs preview: https://kibana_157215.docs-preview.app.elstc.co/guide/en/kibana/master/lens.html#add-annotations --------- Co-authored-by: Tim Sullivan --- .../dashboard/images/formula_reference.png | Bin 1463 -> 1615 bytes .../lens_visualizationModifierPopup_8.8.0.png | Bin 0 -> 5670 bytes docs/user/dashboard/lens.asciidoc | 34 ++++++++++--- docs/user/reporting/index.asciidoc | 47 ++++++++---------- 4 files changed, 47 insertions(+), 34 deletions(-) create mode 100644 docs/user/dashboard/images/lens_visualizationModifierPopup_8.8.0.png diff --git a/docs/user/dashboard/images/formula_reference.png b/docs/user/dashboard/images/formula_reference.png index dff574120c2a1608a249d53b75d63abecb31f806..7b385e774988015f745dabf54dc8586f198dbb61 100644 GIT binary patch delta 175 zcmdnaeV%87Ars@}%|=WWjFTTTn@nEHY*}BDnU-c1lv2oqmNCP sO92LKz|xTjZFc4`J;;LS8X_c`ArqtZW+SEw#>tPFO(y3sb4^~)tUq}@OBBmpqhzhkysS=)01q_`k^lez diff --git a/docs/user/dashboard/images/lens_visualizationModifierPopup_8.8.0.png b/docs/user/dashboard/images/lens_visualizationModifierPopup_8.8.0.png new file mode 100644 index 0000000000000000000000000000000000000000..d3252fa9c16f03c1c713bbaa82ddc6c58a6a19ee GIT binary patch literal 5670 zcmZ`-by!qev>!@Z8iwxfxa3IJNcVs=3@}48Lk}UH(p>@y;zbDs6r@8+KvF?Mx*1zSfx5R{V=k}eg)qV;9 z;Jtz=Dd~chl$dnA+#O&pPyj$ZHX{q$&|rf!bZzb^d4!aOiT#K}oij9@*bIQRVa>{h zrid#{Y`EROi1!kUf`pH^k*CDEG=?6(UZuv`SAmkm+k)?tu0NGz#B9)7v+rEKsAG%f zYEjNj;Z3Wf0HA<7xlcsTJCqOh5+u@_L|>HL%W(`~$d<<-{e&AKCE}*6473)3-v}^H zqfys3xI}whUEbUni77AAF#|{+de(BOWk(+9X15chW-#l5$X_k{@K67kdNpCqg`NyI!ib3l5oz{^fOCB zO`~;ecdrmb|1kJkqj0=+Mbmhd97jI`RGVePe5v7OpA+VPv$k|LpPEqtd|~s5n_r88 zF4nYCaM@DT=UM90K7$T5Qx=*>jH_ZQ9)n!?2*21;KGL&jo+$@yT-p_KFq2gdXBOkV z{>A*zXL^~AYCO(Qd;P!YQTD#y-=|IE7RuN@{e95>dJN^71X=9lz^CMw6;uSUJ7^7aWHY!74mrtWss^5 zv-tBkv!0Z#)V}@1Pxk6uzjzk2zO=cNtZk%#UW#-N(&~v z!dTEH1=P6>I!a;4H)Ai1;ub3wN-WYgYRdz7p4seS&`sxcpUV4Cb>TH%Be<3u~D zhvqOvi1l_z7h&LAbCW9yS4Jl4-kq`G+>XTX0MaaA=10bRP`I_x`{B@!5DFF($+iK) znAjp72@%tG5eqB15UWLm`>~>_14(1qn84~hEGp!^==M_j3F%BLy?3ABNkz~p4Y6dU zh%d{I#vZY_rwDT0eOjz($oPjEX9-<;d{oKDbpkPpg2dHQtabQnf)~oCrN`^0M?3-8 zJMvZ~SCVZN3lK@xeEvt_OJ6%YW8aYH(>36jMDTVSEy6vt-cWwwH^<(k*cB~|aa{Q9 z_uw6;ERZprYSD3t>Z{4ufrG$<V?F0(~yTiTlVPdY3qNOf^GL48TEd_Oxy zs(9K-ns%C7Y9qL)m&abImQ^Y_Up+H5D@CL4vbVffqVL`^TAXxu!lD9hc?{Pfmorxr zmsa{#x?4ZMC>*YET%u|)R-sV=9jDpE+GO37p`f6!qwvkB;33Um=YjHI8wpe(pQFlP zqm?kwG%`1=KDR#FC(5Vjbg?h5xRjYnxhJEMw6-=fm2*sLnR z;JA)P<%4G8pW+7mRxb>9Vy3<8Og72A5#EK3@0)xS& zoV(#4CZ3N-S4^~b)C`)Uj5(YMw}k#IIELn5OYTY@yvbOC_sr6r>IJ^5ud0VMsW%y4 zK02YIuh$OMjvA6KxKr@H(a*wpwxSV%Y}l|I3HqZ@Y7X(v1NHH&bBS@iIAAg$CE)Pb zXVYSAYf55-Xf$iXeNwLcrau(A;GFDM-M)~nP{rIiGNWtzrhWhQSNwX)yn!M6teW9h zmkCD+VTt6bG6`mhcM|v$>=Lr5r)cEFi*r3R^)01crc{lm`@_^$XZDlIB?-K-joPm@+$2JR2c7%THWGK!io{*!j{SzWw$ zu6N|IH|==OgsSbUi85Doo3KmFjfj3+UsqVY`3z_VKBFy@X^}lE(sZY3icE`>L)%=U z2D<1QNOh@sX>meCFGjCOmnkJC_0IdX54p6lut%7!L74$iPwafrTxh26E5PgfC_jzlI&=1H9lApz3? z4t~3bDA_*SRKL-eU<=D0OY|ywOZqvNJ+{4~W*Jlh3R5;iRwqacrP9(A6!^yY3vxGj z*I6!5?yXh9yjmf)JM&(G+>l&vYj5ix@}f)}k3kFI$DY=3Yj10-WQ~#Uk44)f7Dg7l z+kMY3P|U4y^HhtJwL;4%E`Bkd*PtUFR3hBD@7ZI6YUXvcCr7S zgp%YH>mwa@?Zj*|;bYS$O3PurnOv&lmCu6o7)!27rj+FpY7+Fi#NI#e)=qj6cLiKy zG$EZLkrNKK`96U;iwRb=W8oGS_w=>Bc^wL)E%(;(&9Rhh4vOkdcq=L}JYJ9^b-2t| zXBuXzmWl)R1Yf4M;B{bSgk9SQf6H8!W!8BEKGR?3oo3pk2#nR}y2owF&CWe+(5ydI zeo}V+B%`c3b)Rh|Rbr!kV`fawA;NLH4>*`GQ2BwyksV5(2EQ-*WbGAU?V3YFpNoBD z?W4~OuOx0P>}o&8cth>G)G>jSvfm)=K-& zmn)tFd3Z1MGdM9q>x;n=?KXsm&Itiw?m~ZvmXKPnr?#eX@sq=oWw|VW)FVCN!Z0tNRNHpes z9(bxVAF>pB^RS0zCYQdha(Xe`L)UY^yZDLHPP7t{1mjn_3Mse`QiHzqRu~hn1_* zYm39PvU10$t;iAlEP*?gps5a5si3~C(bxfotR#!C=CC)L0d?2819gp77Qru^y0tap;yJx=7nCxl39h+nr3*Os3YN9_?J}sOdes{B~Fc-{#)#aOS zmk!CAA2v%^Y6gD1(m(N9F#5_!6XN3UdVaB9)DmL36~DI?%o-wk<})Ev;2St6)9SvP zv>x(}d8@PSeTj~A(Mj+s%I%!=^r@rukjdy&t-JAjZcB7PSy9Q$H zSPMH0fBYSyU(Nj5o0;qRX$aDyrDjR-eiwSD@ z_7jTC@!E1}&!05lo^)=wD#xQ|Brx2%uG^~(nx0EmVGFn{@& z-SQtR`Ic_czc@x}6af47i}aQv9;5&5&H5PQZ<*=V22e0i0)ub4ft?o=>V|M~M+W6J zuG}hcJ=9GR001TX4?+X$v+V-_=o2tQ2oj>DDQ)NODqv&pZVMIgbM^QU2LSSuz7<`e zNE;?UR~I*gwBJ3JpB~b;@(;Bj3)4>*r1L!%h?XvslDij_NnAikK!`;akBNy1@D&ws_i_{zmXeYZ6cP~>5#hh};79noA#MEl-4LvQ z1^M4N%20%z7t8|*b9ZC<5!c4n-5Yt2h2=-0zt>-NLj7R>WO76NYU{Q^!5o_;29PjHdr&6qo!x<8OxFfIk|L)`ue8UA%v6pphF4DJudJ{4e#t zQKtXEWQE0UyZZ_HUHfkYn_Bt&G0DzqdR#q^C;MSQq>!uq4gEO%xJ>I_JtBwzS+%qBaQFW{@ zjN}h;eNJ#Kltft(KiRjg{nn4Y@Q6UXgUETqvrkpHI9P(lu16=`Td`MfZdDh&i z#qb5c1b2DocEfxjV(w6O&A)2B$7#Vb+$Z7V{8{nXMvuT2Fj)ml|e z?JJU0La`*Cx!IDaAdBkVZgr>g>A?7FYly;3(ay7%EeS&}-HuLvo|Iy6NQRGXL{QBJI62{1p-iJ1d|HyKljRR`A2YGK-Av%;?TCN> z{w}3SoHkE<)lOUS9poSwpw&-+@wIr&pP7p*CKUM5eNV}4m!{JEZJ0dJqv=u{4&T~8 zu3%ih5+o;g=?Y6grd(DLU2Tb#kxp(k6WidaIjIW;H|l~16Il59u{Mr!?#WOdt`0@E zFT{`9SuI=~t9HGA&(iNwxcMe=yPtTOFshN?vn0f#7Pzi}7A6&(u&0EvDq=CNOFjz2Dy#s&Cz|6uPY`?&!!c z!nCsbbVen%F-Yj)hneK?)m6&4*V@V|ITliZw$<8z^1%(Xs6#$pM>$AV6J;OKU?(E7 zs_p%QBtqJ6#PTg89>+wW^vuwrmaC< z#=%WCK9X^L$yRw(NWe)knJ1B_(sE@SovoRp7g6r#7i#lR%JA&lWR;5G?1_gbw}3?p zi(b1koXdyq5t^Rg(Rz7@wn95ctn|r?O^rVwEf@aj=?rPM1GT5<%PB`^nXIbOZIgvM6RVyyX9T8TkFP!@`^}&88{{BcfeznU6X;+u>fb_uO8V6QKG`3t%U+v!h;3{f)ZG~kLPBQkb z+ds+2PqNxdha7%x12ibgf0- z?XQlG*YKz*p@|ozx-Zzt^wy=iQooIP=;Qe!eq_32v*+XWm`Vzlxd@zo6#`2c4y;mf z;D*o;G?Rzs`Jl#i%fWQ+GB^dbwrszYkyT$> zUasbK_f%={*^5_cG#9PiNZ*?)&$qppqFP5Z{FqZs=)Iv3G%Cn$d=c*#McIX}-5_jx zR!)W83^0XM6B#|d`1s`YeU%A?!&i|M-jw(_z@3PEkzL{0#!Tkj5Xq|j5Q@MPJ=Z@g zJDwZ8444=lRsAqc&BK^g9dNv~DA$rcaV`Sl$cE9~A<|)N?P;Y@$BHSC$st`3_kvr_ zoS%?vhF{AocDTHrul*Wecl*C!8T_Dwuo=B%XjHGn>wzl0tmT2>A-u?^0L?S(^=Fqi zDilpm>x{mUn4p#_O|x~jJ)KJc&qU7@rQxEp*5hFplRSEe>Aj7~r&+~m*y~n|C)9HT zai}0vADge~M4<#XP(iH&RAwM~EG=P8{=DnXJY;8SeTk@OJ2!*>. [float] -[[multi-metric-partition-chart]] -==== Build a partition chart from multiple metrics +[[create-partition-charts-with-multiple-metrics]] +==== Create partition charts with multiple metrics -By default, partition charts (e.g. pie) are built from one or more "slice-by" dimensions to define the partitions and a single metric dimension to define their size. However, you can also build a partition chart from multiple metric dimensions. +To create partition charts, such as pie charts, configure one or more *Slice by* dimensions to define the partitions, and a *Metric* dimension to define the size. +To create partition charts with multiple metrics, use the layer settings. Multiple metrics are unsupported for mosaic visualizations. -. Open the layer context menu at the top right of the layer panel. +. In the layer pane, click image:dashboard/images/lens_layerActions_8.5.0.png[Actions menu for the partition visualization layer], then select *Layer settings*. -. Click *Layer settings*. +. Select *Multiple metrics*. -. Click the switch labeled *Multiple metrics*. +. Click *X*. -Note: this option is not available for mosaic charts. +[float] +[[improve-visualization-loading-time]] +=== Improve visualization loading time + +preview::[] + +Data sampling allows you to improve the visualization loading time. To decrease the loading time, use a lower sampling percentage, which also decreases the accuracy. +Use low sampling percentages on large datasets. + +. In the layer pane, click image:dashboard/images/lens_layerActions_8.5.0.png[Actions menu for the partition visualization layer], then select *Layer settings*. + +. To select the *Sampling* percentage, use the slider. + +. Click *X*. ++ +When you add the visualization to dashboards, image:dashboard/images/lens_visualizationModifierPopup_8.8.0.png[Visualization modifier popup] appears, +which allows you to view settings changes to the visualization. [float] [[add-annotations]] @@ -214,6 +231,9 @@ Create the annotation layer. . From the fields list, drag a field to the *Add an annotation* field. . To use global filters in the annotation, click image:dashboard/images/lens_layerActions_8.5.0.png[Actions menu for the annotations layer], then select *Keep global filters* from the dropdown. ++ +When you add the visualization to dashboards, image:dashboard/images/lens_visualizationModifierPopup_8.8.0.png[Visualization modifier popup] appears, +which allows you to view settings changes to the visualization. Create static annotations. diff --git a/docs/user/reporting/index.asciidoc b/docs/user/reporting/index.asciidoc index e85c46d04ed383..6529352f7bc1e1 100644 --- a/docs/user/reporting/index.asciidoc +++ b/docs/user/reporting/index.asciidoc @@ -13,19 +13,21 @@ You access the options from the *Share* menu in the toolbar. The sharing options include the following: -* *PDF Reports* — Generate and download a PDF file of a dashboard, visualization, or *Canvas* workpad. PDF reports are a link:https://www.elastic.co/subscriptions[subscription feature]. +* *PDF Reports* — Generate and download PDF files of dashboards, visualizations, and *Canvas* workpads. PDF reports are a link:https://www.elastic.co/subscriptions[subscription feature]. -* *PNG Reports* — Generate and download a PNG file of a dashboard or visualization. PNG reports are a link:https://www.elastic.co/subscriptions[subscription feature]. +* *PNG Reports* — Generate and download PNG files of dashboards and visualizations. PNG reports are a link:https://www.elastic.co/subscriptions[subscription feature]. -* *CSV Reports* — Generate and download a CSV file of a *Discover* saved search. +* *CSV Reports* — Generate and download CSV files of saved searches. -* *Get links* — Share a direct link to a *Discover* saved search, dashboard, or visualization. +* *CSV Download* — Generate and download CSV files of *Lens* visualizations. -* *Download as JSON* — Generate and download a JSON file of a *Canvas* workpad. +* *Get links* — Share direct links to saved searches, dashboards, and visualizations. + +* *Download as JSON* — Generate and download JSON files of *Canvas* workpads. * beta[] *Share on a website* — Download and securely share *Canvas* workpads on any website. -* *Embed code* — Embed a fully interactive dashboard as an iframe on a web page. +* *Embed code* — Embed fully interactive dashboards as an iframe on web pages. [[reporting-on-cloud-resource-requirements]] NOTE: For Elastic Cloud deployments, {kib} instances require a minimum of 2GB RAM to generate PDF or PNG reports. To @@ -51,19 +53,13 @@ image::user/reporting/images/shareable-container.png["Shareable Container"] . Open the main menu, then open the saved search, dashboard, visualization, or workpad you want to share. -. From the toolbar, click *Share*, then select one of the following options: - -** **PDF Reports** — Generates a PDF file of the dashboard, visualization, or workpad. - -** **PNG Reports** — Generates a PNG file of the dashboard or visualization. +. From the toolbar, click *Share*, then select the report option. -** **CSV Reports** — Generates a CSV report of the saved search. - -. If you are creating a PDF report of a dashboard, select *Optimize for printing* to create a printer-friendly PDF with multiple A4 portrait pages and two visualizations per page. +* If you are creating dashboard PDFs, select *Optimize for printing* to create printer-friendly PDFs with multiple A4 portrait pages and two visualizations per page. + NOTE: When you create a dashboard report that includes a data table or saved search, the PDF includes only the visible data. -. If you are creating a PDF report of a workpad, select *Full page layout* to create a PDF without margins that surround the workpad. +* If you are creating workpad PDFs, select *Full page layout* to create PDFs without margins that surround the workpad. . Generate the report. @@ -78,9 +74,9 @@ more about {ilm-init} policies, refer to the {es} [float] [[share-a-direct-link]] -== Share a direct link +== Share direct links -Share a direct link to a saved search, dashboard, or visualization. To access the shared object, authentication is required. +Create and share direct links to saved searches, dashboards, and visualizations. To access the shared object, authentication is required. . Open the main menu, then open the saved search, dashboard, or visualization you want to share. @@ -105,9 +101,9 @@ NOTE: *Public URL* is available only when anonymous access is configured and you [float] [[download-as-json]] -== Create a JSON file +== Create JSON files -Create a JSON file for a workpad. +Create and share JSON files for workpads. . Open the main menu, then click *Canvas*. @@ -119,8 +115,7 @@ Create a JSON file for a workpad. [[add-workpad-website]] == Share workpads on a website -beta[] *Canvas* allows you to create _shareables_, which are workpads that you download and securely share on a website. -To customize the behavior of the workpad on your website, you can choose to autoplay the pages or hide the workpad toolbar. +beta[] Create and securely share static *Canvas* workpads on a website. To customize the behavior of the workpad on your website, you can choose to autoplay the pages or hide the workpad toolbar. . Open the main menu, then click *Canvas*. @@ -128,8 +123,6 @@ To customize the behavior of the workpad on your website, you can choose to auto . Click *Share > Share on a website*. -. Follow the instructions. - . To customize the workpad behavior to autoplay the pages or hide the toolbar, use the inline parameters. + To make sure that your data remains secure, the data in the JSON file is not connected to {kib}. *Canvas* does not display elements that manipulate the data on the workpad. @@ -142,9 +135,9 @@ NOTE: Shareable workpads encode the current state of the workpad in a JSON file. [[embed-code]] == Embed code -Display your dashboard on an internal company website or personal web page with an iframe. Embedding other {kib} objects is generally supported, but you might need to manually craft the proper HTML code. +Display your dashboards on an internal company website or personal web page with an iframe. To embed other {kib} objects, manually create the HTML code. -Some users might not have access to the dashboard or visualization. For more information, refer to <> and <>. +For information about granting access to embedded dashboards, refer to <>. . Open the main menu, then open the dashboard you want to share. @@ -152,11 +145,11 @@ Some users might not have access to the dashboard or visualization. For more inf . Specify how you want to generate the code: -* To display only the current state, select *Snapshot*. +* To display the current state, select *Snapshot*. * To display up-to-date changes, select *Saved object*. -* Select the dashboard components you want to include. +* Select the dashboard components you want to share. * To generate a shortened link, select *Short URL*.