Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Whats new page for 8.9 #162271

Merged
merged 10 commits into from
Jul 20, 2023
Binary file added docs/user/images/annotation.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/user/images/globalfilter.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/user/images/logratespikes.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/user/images/logratespikes1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/user/images/newwayhighlighted.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/user/images/oldwayhighlighted.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/user/images/significant-terms.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/user/images/stepcurve.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/user/images/tagcloud.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/user/images/timefunctions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/user/images/wildcard-search.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
81 changes: 81 additions & 0 deletions docs/user/whats-new.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,87 @@ image::images/case-notification.png[Example email with case name, description, t

To learn more, check out cases in the {observability-guide}/create-cases.html[{observability}], <<cases,{stack-manage-app}>>, or {security-guide}/cases-overview.html[{security-app}].

[discrete]
=== Dashboard

[discrete]
==== Wildcard search in dashboard controls
**Dashboard** now supports searching for strings that are found within the values shown in a control. Previously, it was required for the string to be located at the start of the value in order to be found. However this is a more expensive option then just searching for the prefix, so it’s disabled by default. To enable it in **Dashboard** select Edit control > Options list settings > Contains.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This paragraph could use a rewrite. For example, we could rephrase:

Dashboard now supports searching for strings that are found within the values shown in a control.

to something like:

You can now search for strings anywhere within a control.

We should almost never use phrases like "in order to".


[role="screenshot"]
image::images/wildcard-search.png[Example of new string search]

[discrete]
=== Lens

[discrete]
==== Stacked bar chart legend

The order of stacked bar chart legends is now based on popularity with the most important element displayed on top. You no longer need to scroll to the bottom of the legend to find the most popular data in the chart.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The order of stacked bar chart legends is now based on popularity with the most important element displayed on top.

"Popularity" seems like odd phrasing here. We're basically saying "ranked by value in descending order."

Instead of "most popular element," I think it's more accurate to say the "segment with the highest total value."

You no longer need to scroll to the bottom of the legend to find the most popular data in the chart.

Do we need this sentence?


Previously:
[role="screenshot"]
image::images/oldwayhighlighted.png[Example of the old ordering of the chart legend, width=80%]

New in 8.9:
[role="screenshot"]
image::images/newwayhighlighted.png[Example of the new ordering of the chart legend, width=80%]
Comment on lines +60 to +66
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should avoid using phrases with colons to set off images. Generally, we treat images as "enriching but optional." In this case, I'd only include a screenshot of the new image.

We may also want to crop the photo so the legend is more in focus. It's difficult to read right now.


[discrete]
==== Step curve

**Lens** now supports three new options for line charts. The three options are straight, smooth, and step. Step curve line charts help users see clearly when data changes at irregular intervals, which helps to avoid misinterpretation. When creating visualizations select **Line** in the visualization type dropdown. Then use the visual options menu to choose between straight, smooth, or step in the Line interpolation dropdown.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This also needs a rewrite. We should call this out as a line interpolation option. I'm also not sure why we're mentioning in the existing "straight" or "smooth" options.


[role="screenshot"]
image::images/stepcurve.gif[An short video displaying the three new chart options]

[discrete]
==== Significance (significant terms)

This new ranking method in the top values breakdown displays data by significance (significant terms). It permits us to get the terms that are important and likely the most critical for a given query. It’s a powerful way to find anomalies in your data with multiple use cases. Read more {ref}/search-aggregations-bucket-significantterms-aggregation.html[here].
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It permits us to get the terms that are important and likely the most critical for a given query.

Unless providing a recommendation, avoid first person in the docs. In this case, "us" refers to the user should you should use "you" (second person).

This is not just based on the most popular terms in a set. When calculating significant terms, Elasticsearch looks for significant changes in popularity of a specific term between two sets of data. A foreground set (the data returned by a query) and a background set (the data in our indices). This is supported on all charts.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Elasticsearch

{es}


[role="screenshot"]
image::images/significant-terms.png[Example of a donut chart organized by significant terms, width=70%]

[discrete]
==== Tag cloud

You can now create a word cloud in **Lens** using Tag cloud, which is currently in technical preview. When creating new visualizations, select **Tag cloud** in the visualization type dropdown. From the available fields drag and drop the desired field into the workspace to visualize keywords.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For items in technical preview, we should include a preview:[] admonition, similar to the ML one below.


[role="screenshot"]
image::images/tagcloud.png[Example of a tag cloud, width=70%]

[discrete]
==== Save annotation groups as a Kibana saved object

Group annotations and save them to the visualize library, so the content can be reused across multiple visualizations. This saves time for users with complicated annotations. From the main menu select Visualize Library, then select the tab **Annotation groups**. Here you can create new annotation groups in **Lens**, or select from a list of previously created annotation groups.

[role="screenshot"]
image::images/annotation.gif[Example of how to save an annotation group to the visualize library]
Comment on lines +98 to +99
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we bump up the size of the GIF here? It's hard for me to see?


[discrete]
==== New time functions in Lens formula

The **Lens** formula now supports customizing the histogram interval and defining the desired time range. This was already available in TSVB charts and it was important to facilitate the conversion to **Lens**.

[role="screenshot"]
image::images/timefunctions.png[Example of customizing the histogram interval and defining the desired time range]

[discrete]
==== Ignore global filters in Lens

We now offer users the ability to ignore global filters per data layer in **Lens**. This allows users to easily compare different time frames in the same chart. This functionality previously only existed in the annotations layer.

[role="screenshot"]
image::images/globalfilter.png[Example of the new global filter slider]

[discrete]
=== Machine learning

[discrete]
==== Explain log rate spikes
preview:[] The AIOps Labs **Explain Log Rate Spikes** feature is now embeddable into other pages. This reusable component has been picked up by the Observability team and added the analysis to their log threshold alert details page. This is a new view introduced in 8.9. It is the starting point for troubleshooting log alerts. The log rate spike analysis helps find the reason behind a particular change possibly in millions of log events across multiple fields and values in seconds. Additionally, users can trigger the AI assistant from here to get remediation and troubleshooting suggestions.

[role="screenshot"]
image::images/logratespikes1.png[Example of the new log rates spikes dashboard]