From 54479f389ce24b4c8a9a7a6f2dd232de38229db4 Mon Sep 17 00:00:00 2001 From: KOTungseth Date: Mon, 28 Nov 2022 14:05:52 -0600 Subject: [PATCH 1/5] Adds the VisEditor docs for 8.6 --- .../user/dashboard/aggregation-based.asciidoc | 21 +++++++++++++++++++ docs/user/dashboard/lens.asciidoc | 10 +++++++-- docs/user/dashboard/tsvb.asciidoc | 10 ++++++++- 3 files changed, 38 insertions(+), 3 deletions(-) diff --git a/docs/user/dashboard/aggregation-based.asciidoc b/docs/user/dashboard/aggregation-based.asciidoc index 4ca251b3a1936..bbba017736ebb 100644 --- a/docs/user/dashboard/aggregation-based.asciidoc +++ b/docs/user/dashboard/aggregation-based.asciidoc @@ -191,6 +191,27 @@ TIP: Aggregation-based panels support a maximum of three *Split series*. [role="screenshot"] image:images/aggBased_barChartTutorial2_8.4.png[Bar chart with sample logs data] +[float] +[[edit-agg-based-visualizations-in-lens]] +==== Open and edit aggregation-based visualizations in Lens + +When you open aggregation-based visualizations in *Lens*, all configuration options appear in the *Lens* visualization editor. + +You can open the following aggregation-based visualizations in *Lens*: + +* Area +* Gauge +* Goal +* Heat map +* Hortizontal bar +* Line +* Metric +* Vertical bar + +To get started, click *Edit visualization in Lens* in the toolbar. + +For more information, check out <>. + [float] [[save-the-aggregation-based-panel]] ===== Save and add the panel diff --git a/docs/user/dashboard/lens.asciidoc b/docs/user/dashboard/lens.asciidoc index de23c3a9962e0..2cd4b0fa34946 100644 --- a/docs/user/dashboard/lens.asciidoc +++ b/docs/user/dashboard/lens.asciidoc @@ -56,6 +56,8 @@ TIP: You can manually apply the changes you make, which is helpful when creating Change the fields list to display a different {data-source}, different time range, or add your own fields. * To create a visualization with fields in a different {data-source}, open the {data-source} dropdown, then select the {data-source}. ++ +For more information about {data-sources}, refer to <>. * If the fields list is empty, change the <>. @@ -201,7 +203,7 @@ image::images/lens_annotations_8.2.0.png[Lens annotations] . Select the {data-source}. -. To open the annotation options, click *Event*. +. Click *Event*, or drag a field to the *Add an annotation* field in the *Annotations* layer pane. . Specify the *Annotation date*. @@ -211,8 +213,12 @@ image::images/lens_annotations_8.2.0.png[Lens annotations] . Change the *Appearance* options for how you want the annotation to display. +. To add a field to the tooltip, click *Add field*, then select the field you want to display. + . To close, click *X*. +. To use global filters in the annotation, click image:dashboard/images/lens_layerActions_8.5.0.png[Actions menu for the annotations layer] in the *Annotations* layer pane, then select *Keep global filters* from the dropdown. + [float] [[add-reference-lines]] ==== Add reference lines @@ -240,7 +246,7 @@ image::images/lens_referenceLine_7.16.png[Lens drag and drop focus state] [[filter-the-data]] ==== Apply filters -You can use the <> to focus on a known set of data for the entire visualization, or use the filter options from the layer pane or legend. +You can use the <> to focus on a data set for the entire visualization, or use the filter options from the layer pane or legend. [float] [[filter-with-the-function]] diff --git a/docs/user/dashboard/tsvb.asciidoc b/docs/user/dashboard/tsvb.asciidoc index d9cd137978e9c..d725a82d74b65 100644 --- a/docs/user/dashboard/tsvb.asciidoc +++ b/docs/user/dashboard/tsvb.asciidoc @@ -136,7 +136,15 @@ The *Markdown* visualization supports Markdown with Handlebar (mustache) syntax [[edit-visualizations-in-lens]] ==== Open and edit TSVB visualizations in Lens -Open and edit Time Series and Top N *TSVB* visualizations in *Lens*. When you open *TSVB* visualizations in *Lens*, all configuration options and annotations appear in the *Lens* visualization editor. +When you open *TSVB* visualizations in *Lens*, all configuration options and annotations appear in the *Lens* visualization editor. + +You can open the following *TSVB* visualizations in *Lens*: + +* Time Series +* Metric +* Top N +* Gauge +* Table To get started, click *Edit visualization in Lens* in the toolbar. From 88f0771fc854d6fbe1b76618029bb799df53ee31 Mon Sep 17 00:00:00 2001 From: Kaarina Tungseth Date: Tue, 6 Dec 2022 10:07:55 -0600 Subject: [PATCH 2/5] Update docs/user/dashboard/aggregation-based.asciidoc Co-authored-by: Stratoula Kalafateli --- docs/user/dashboard/aggregation-based.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user/dashboard/aggregation-based.asciidoc b/docs/user/dashboard/aggregation-based.asciidoc index bbba017736ebb..86f55ad118c27 100644 --- a/docs/user/dashboard/aggregation-based.asciidoc +++ b/docs/user/dashboard/aggregation-based.asciidoc @@ -203,7 +203,7 @@ You can open the following aggregation-based visualizations in *Lens*: * Gauge * Goal * Heat map -* Hortizontal bar +* Horizontal bar * Line * Metric * Vertical bar From 6a0f64d065de9c005ec243b390f011605284ca5f Mon Sep 17 00:00:00 2001 From: KOTungseth Date: Tue, 6 Dec 2022 11:15:32 -0600 Subject: [PATCH 3/5] Review comments pt 1 --- docs/user/dashboard/aggregation-based.asciidoc | 2 ++ docs/user/dashboard/lens.asciidoc | 4 ++++ 2 files changed, 6 insertions(+) diff --git a/docs/user/dashboard/aggregation-based.asciidoc b/docs/user/dashboard/aggregation-based.asciidoc index 86f55ad118c27..7d5e4f93bba88 100644 --- a/docs/user/dashboard/aggregation-based.asciidoc +++ b/docs/user/dashboard/aggregation-based.asciidoc @@ -200,12 +200,14 @@ When you open aggregation-based visualizations in *Lens*, all configuration opti You can open the following aggregation-based visualizations in *Lens*: * Area +* Data table * Gauge * Goal * Heat map * Horizontal bar * Line * Metric +* Pie * Vertical bar To get started, click *Edit visualization in Lens* in the toolbar. diff --git a/docs/user/dashboard/lens.asciidoc b/docs/user/dashboard/lens.asciidoc index 2cd4b0fa34946..005fd29afba05 100644 --- a/docs/user/dashboard/lens.asciidoc +++ b/docs/user/dashboard/lens.asciidoc @@ -199,12 +199,16 @@ Annotations allow you to call out specific points in your visualizations that ar [role="screenshot"] image::images/lens_annotations_8.2.0.png[Lens annotations] +Create the annotation. + . In the layer pane, click *Add layer > Annotations*. . Select the {data-source}. . Click *Event*, or drag a field to the *Add an annotation* field in the *Annotations* layer pane. +. Choose the *Placement type*. + . Specify the *Annotation date*. . To display the annotation as a time range, select *Apply as range*, then specify the *From* and *To* time range. From 5dd947c428ef54e828e94dc3f66de29049ff4429 Mon Sep 17 00:00:00 2001 From: KOTungseth Date: Thu, 8 Dec 2022 13:52:55 -0600 Subject: [PATCH 4/5] Review comments pt 2 --- .../images/lens_annotationDateIcon_8.6.0.png | Bin 0 -> 5215 bytes docs/user/dashboard/lens.asciidoc | 42 +++++++++++++----- 2 files changed, 31 insertions(+), 11 deletions(-) create mode 100644 docs/user/dashboard/images/lens_annotationDateIcon_8.6.0.png diff --git a/docs/user/dashboard/images/lens_annotationDateIcon_8.6.0.png b/docs/user/dashboard/images/lens_annotationDateIcon_8.6.0.png new file mode 100644 index 0000000000000000000000000000000000000000..c268d14b68d0e4492230f534704b5759c946eca1 GIT binary patch literal 5215 zcmZ{n1yod9)PRQ$K|m0tWatnXy1N^s89Ih$h#9&OL_k7Nx{>aXknWH!DWyd~O1l5S z=l`DT{qMhboqP7(dw)C5Icwc@!_-t{aj{9U0RRB5yquIeVx~Y0GE8*DGhiV20RVs_ zVk0T3CNC)oRC95(w6TW(0CHjPbTD)^`iax^V`E}Qk+bBmnz5*x<*>5Q@MD-~Fy#Z( z%y3X23Nka-6KhJfzbp%9{75V|9nM%QU2)nS6ja5!m96U;hx~E(>0*ixY-2>!>IU|0 zA<26Wkm(oxlz1bP6tEWllddu=aPXj?Nokx@42||o15Jq)q&gTL7KU1Z^T8jq2St{e zHiE_2Tvy+=5-Ya=qcH#vP@G9cqZ95Om;&~h({*F<0MC0;R7W0tVk;5TM@9+uD8#X1 zbb5!A&$N%!pzOm!wn7ZhEHEgeMFD(p>*KuVL82yEif6_^V9batmWEYn4Bgcf=_cDC!tbGoRTDv1A3h3ywHfnGd zlxfnvPzeoWq*5v51P<)i`Z?oRMV-_>5l4r= z$41A%i-T`%%-gr8SNNBarsDMK{c@o~98;kzVeMT&v&Zbg))8b&e)V`yu*#7t1Xk1Q zKaUEv%o3&(2w+BI@nWV03u**Q$5LjK-xJ94d&Tj{W^n_#E+`r50o=VemBlgKh8uvg zi+x?;z1lM?DT+d0GC?Dekpr+D}w@ zCJAmj7e~|HK{!SVrwe;GtFuAIY?3Fh(SH=KBt0;du@s3zTf{`Bm+gX)_ru*>+|b2N z{GJQ7eC1f%!wq&mAk#Sl02bHU+uO|->*ebG@!UIi7B3^K%g_SckOK}QJk{j`gE}FP zkbM*iI@9v-UI+451Rgr0@3vu}2AJUA&lVSwLyt2(N^(k5Y=g6ru>iU=iAs>S+hi)x z>@gbKMV#=t0?e1V_%K)l-JDPsUKHowYeMy1qBsi%Vq#@c!KEnK#aRfvyGRbCu3}7R zAB0KAzR{#bA)r#X;HkoAk{*bO?BjWlevZZ;o+`r%r0AnqBN%_tBrcNuSV8*3bDBwP ziV&}C7B1vSS%xf_ohq%i1AG{iY8HCKO&WQlhscup&qx zA3p$KI-f?C^n!?+D+!d2(HZRBD3t3k_Xwb+0^Px z>P$MbIW7|GMFX&Rsus9abh9bs%HQIwVs&EOV^aEb`V7}piIl^+yAvL$_GhzXYN~B9 zS}~n6IcjNX4QV!O_7-AmZ4_%4JW&%azmPjd(TcE@g=jFS=T1JHG@R6!6r8N%A{`1R z7E{bxpU@t)wYIXxvq7nb6OvCwk%u~UE?n-jwOy=jwQErCcU}) zNVQ4ram#uPA{8QYNb9&RxHpq?xO2E++zEEOV@;W}rPAY7<6j#70nXkT4ufl+0uFKB%n!HD$ zN4!V5N7j(WFuqL8Jqen&tM%p7i{=RV2-S+%@--FMPz3uD`AyL{Sl)ZZk4Y=-1D zXCky>cBw>s4|9h=gvNtLL57^%`7=Iu4d-j_R7m}o{VLPeH$>W1>%mIy zmD-i=&5zn&Ipoc1&KuOx&3VmP&O@sl>Lhm-esJtC@088toa~-RTq>VX&|uLt%Y@5l zM>nmDxtj13@l6T{xmfVY2oUr0@U@Ua*qI@dThB{#S_B&S*ZFpwKJtR?;Ah{n$CPsx z`R4f#Q=g`lH;x)e7<_Bs`qh*@p$e|HxxmdZUQE!uoN2B+KH|5dIL~lF8yj8U7>EmtoAa=nXp#$#2^$Y0X z&XM^=?uEng_7U&##)ZzM=zTW4C5#_99>Y}-NaabD5t;y+0&+BJi;>h^#1M<%$(KhVA47(*g&)dbMquhwxJ8(EEj!!t`7S?MhIQyu7Z5lT zkkLGmos(9ePU*=u@9Zrj@fIE6P#~JZ$Ia#+v&*LJ((P4>ICmv?HW;iQa2_#}?H!JC zh|K9#4x1-DWffubgIqPErl8tLz_Ptoy1J6PPUXerA@XUfvXL2_H|ka5RcsCHA#Y<7 zt2lH0CH8||2|v<*RAx!{fW;oaCy8TK;z>;9JU=5kW?EnhRmUonFZ5Oyh2=C%E!=Ra zfVIGs(L?$p-u-w>q+Jjh$-Bk|LYoXu_T8S!7y#AE8pA*Y* zMb|)z4(}s!qp`2BneUb_~trVl00A8D$-I-Pftmq91o)BKYT^CL6HUI6l# zCmsiiTOeLM8FG7(HP3?GiuL6pnj;#zW4Y_Wi5p)`o^GF!PW8l)N=|8*k^UdOdpWyhnuiF0Is|x0gI^G(+iBW_)*X8Lg#PFR3 z*WqJD-fSp*L8;#Ja=J@Dt?s<8ac^zG)3N5aqAX!0A;T-;cJwM| z>)lXsr$73YXM>}U@n^gK?RMTzi(9Q^GH(}k6=0VEFG%a5#2Pw#jU~~rO`2h5%$?5moQVjP6sYn021-Q4LM3z@k09z{@2BE{YKVi8g_{;nzb}=|# z^x^~nevILq8}81xGssCrPtPi^9~JNWXz2HGCnA0*;vu^7mdeTiW`v9hKtp-}KtV`I zh#P=J3PAfM0{{w0WPi)*NQ}RIkO6>D8vyEWA24FRyJ8RnLI0jnVqXF<5O0XT7C>+& z^55PRnJ9nDWC$BTTtiY`9x-c}yFegNn6)GP>!4vELV@KZrw0Q7i0SSIlDs zmkZoZm|9m^4Jhg80s-={vazyJi(mtRK*U$TQb1iw<~NRb6Q;I?!<_^`Aa{3nR(DQT zM;9v)J3l`^h>Zip!SM{?@eJk(g`0XjgTiS33i7{kq#!VJ7aJ$IjUyCz7uVFx(G@OC zO?{W>@9VERAs#mWWP-wew}ogBbY}svv$BEy3xnHO{y*5A{{ppO5En^D2LuNf`Dd$s!+#q84gSig_eVyKKQsPe z_yfFaKtLS=bF_E8TR<(S4O|3){g?XRl-@s>2>V@kzo0+0|0Z<*llW8nZ$j0@2C)pL zccqE2|IYBI?zg`X=x*cxI0%28vR_)nF%!WS0{wktMX*i2c3J}fs8aG$;+k@}&Dx(F z-)a%v`W`awDA_oKss*~)=1)bM(uD=8AWyAyl;(kLNW#%`xa3|Zl5z?uVA8+pqIca! z!RZlgdzZDtx9h?3s$Kdi_S?$$%9Lyqo^DO8ht8qHP7H7LJUHr3(@*(N(_t;(BzxBA zTM}~BRZs?RuTGTF@JVv&_`A;KfcbTuo=>P2A&%oD&3c_Rto8Q)!RewbdaCn z?7!J!U}ylTN|o!_u#2&;5g!;XRI(GA+V>LD)zfRg_;~!?w-Lk8P%y&cLzE(A{h{sS z^)o4=#>U3|9rul~F@k`3!w~Bu_h8kimCwe*G%5WBPS2Rz*4=V0kNr|{D5cnD!j$ME z`}#eM-_HN^vYq5StEi~hPh`Q8$=Af(+3BoYt}bGpSbb$qKpnm^E3RpDg2sldb*yIiU+@6O49nTfO`5CyFE84PU%Q6j9C-$I^MicPD$RM+l5NeQ`h@ikq!;%?{7VA zblOx$t(?J`n*&b;V3uj~re}PAD@+k_9Z{@PZn{1FsJkz1)5hRApJ%Xs9dz~LSX9lh zxlF8@|68jnd?3iHctcr_tNl%Foqse-Wb5g!Si8VI)mFPeT^B|TIi+@1WKurAmA6e( zfu|S{9)FiL&h`eFcHD5?`vsa%H_C)F!W#QLx8vC)T%6$1iNlv4TS&FUJaO*(1zcZB z?iZ9Rs4PoL$~v9x18ti>xDetcWkG*OOuH$_aa<8 zz_)nO;P41KSd-fwje?L1}^P(*1cC%wN2cD~ZWCJ(jG zO1)Tn7c^Fw&U%%RuWk~!$)s)Dd6wtHz+7P5-A2u<(=L;Lq^Xj%!l=!3gCR|igfE&B RWpMXdl$TbKDw8k?`X3Q3UGo3{ literal 0 HcmV?d00001 diff --git a/docs/user/dashboard/lens.asciidoc b/docs/user/dashboard/lens.asciidoc index 005fd29afba05..814084220ae06 100644 --- a/docs/user/dashboard/lens.asciidoc +++ b/docs/user/dashboard/lens.asciidoc @@ -43,7 +43,7 @@ Edit and delete. . To delete a field, close the configuration options, then click *X* next to the field. -. To clone a layer, click image:dashboard/images/lens_layerActions_8.5.0.png[Actions menu to duplicate Lens visualization layers] in the layer pane, then select *Duplicate layer*. +. To duplicate a layer, click image:dashboard/images/lens_layerActions_8.5.0.png[Actions menu to duplicate Lens visualization layers] in the layer pane, then select *Duplicate layer*. . To clear the layer configuration, click image:dashboard/images/lens_layerActions_8.5.0.png[Actions menu to clear Lens visualization layers] in the layer pane, then select *Clear layer*. @@ -194,30 +194,50 @@ Note: this option is not available for mosaic charts. preview::[] -Annotations allow you to call out specific points in your visualizations that are important, such as a major change in the data. You can add annotations for any {data-source}, add text and icons, specify the line format and color, and more. +Annotations allow you to call out specific points in your visualizations that are important, such as significant changes in the data. You can add annotations for any {data-source}, add text and icons, specify the line format and color, and more. + +Annotations support two placement types: + +* *Static date* — Displays annotations for specific times or time ranges. + +* *Custom query* — Displays annotations based on custom {es} queries. For detailed information about queries, check <>. [role="screenshot"] image::images/lens_annotations_8.2.0.png[Lens annotations] -Create the annotation. +Create the annotation layer. . In the layer pane, click *Add layer > Annotations*. -. Select the {data-source}. +. Select the {data-source} for the annotation. + +. From the fields list, drag a field to the *Add an annotation* field. + +Create static annotations. -. Click *Event*, or drag a field to the *Add an annotation* field in the *Annotations* layer pane. +. Select *Static date*. -. Choose the *Placement type*. +. In the *Annotation date* field, click image:images/lens_annotationDateIcon_8.6.0.png[Annodation date icon in Lens], then select the date. + +. To display the annotation as a time range, select *Apply as range*, then specify the *From* and *To* dates. + +Create custom query annotations. + +. Select *Custom query*. + +. Enter the *Annotation query* for the data you want to display. ++ +For detailed information about queries and examples, check <>. -. Specify the *Annotation date*. +. Select the *Target date field*. -. To display the annotation as a time range, select *Apply as range*, then specify the *From* and *To* time range. +Specify the annotation appearance. . Enter the annotation *Name*. -. Change the *Appearance* options for how you want the annotation to display. +. Change the *Appearance* options for how you want the annotation to display on the visualization. -. To add a field to the tooltip, click *Add field*, then select the field you want to display. +. If you created a custom query annotation, click *Add field* to add a field to the annotation tooltip. . To close, click *X*. @@ -250,7 +270,7 @@ image::images/lens_referenceLine_7.16.png[Lens drag and drop focus state] [[filter-the-data]] ==== Apply filters -You can use the <> to focus on a data set for the entire visualization, or use the filter options from the layer pane or legend. +You can use the <> to create queries that filter all the data in a visualization, or use the layer pane and legend filters to apply filters based on field values. [float] [[filter-with-the-function]] From d811c16f9f42cda9edcd85cdaf21f64a97a9bae1 Mon Sep 17 00:00:00 2001 From: KOTungseth Date: Thu, 8 Dec 2022 14:03:27 -0600 Subject: [PATCH 5/5] Formatting --- docs/user/dashboard/lens.asciidoc | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/user/dashboard/lens.asciidoc b/docs/user/dashboard/lens.asciidoc index 814084220ae06..3467276ce236d 100644 --- a/docs/user/dashboard/lens.asciidoc +++ b/docs/user/dashboard/lens.asciidoc @@ -196,15 +196,15 @@ preview::[] Annotations allow you to call out specific points in your visualizations that are important, such as significant changes in the data. You can add annotations for any {data-source}, add text and icons, specify the line format and color, and more. +[role="screenshot"] +image::images/lens_annotations_8.2.0.png[Lens annotations] + Annotations support two placement types: * *Static date* — Displays annotations for specific times or time ranges. * *Custom query* — Displays annotations based on custom {es} queries. For detailed information about queries, check <>. -[role="screenshot"] -image::images/lens_annotations_8.2.0.png[Lens annotations] - Create the annotation layer. . In the layer pane, click *Add layer > Annotations*. @@ -213,6 +213,8 @@ 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. + Create static annotations. . Select *Static date*. @@ -241,8 +243,6 @@ Specify the annotation appearance. . To close, click *X*. -. To use global filters in the annotation, click image:dashboard/images/lens_layerActions_8.5.0.png[Actions menu for the annotations layer] in the *Annotations* layer pane, then select *Keep global filters* from the dropdown. - [float] [[add-reference-lines]] ==== Add reference lines