Skip to content

Commit 88f2959

Browse files
authored
[E&A] Amends E&A overview. (#418)
1 parent 4234f79 commit 88f2959

File tree

9 files changed

+214
-253
lines changed

9 files changed

+214
-253
lines changed

explore-analyze/index.md

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -27,23 +27,19 @@ The Elasticsearch platform and its UI, also known as Kibana, provide a comprehen
2727

2828
Elastic is committed to ensuring digital accessibility for people with disabilities. We are continually improving the user experience, and strive toward ensuring our tools are usable by everyone.
2929

30-
3130
**Measures to support accessibility**
3231
Elastic takes the following measures to ensure accessibility of Kibana:
3332

3433
* Maintains and incorporates an [accessible component library](https://elastic.github.io/eui/).
3534
* Provides continual accessibility training for our staff.
3635
* Employs a third-party audit.
3736

38-
3937
**Conformance status**
4038
Kibana aims to meet [WCAG 2.1 level AA](https://www.w3.org/WAI/WCAG21/quickref/?currentsidebar=%23col_customize&levels=aaa&technologies=server%2Csmil%2Cflash%2Csl) compliance. Currently, we can only claim to partially conform, meaning we do not fully meet all of the success criteria. However, we do try to take a broader view of accessibility, and go above and beyond the legal and regulatory standards to provide a good experience for all of our users.
4139

42-
4340
**Feedback**
4441
We welcome your feedback on the accessibility of Kibana. Please let us know if you encounter accessibility barriers on Kibana by either emailing us at `[email protected]` or opening [an issue on GitHub](https://github.com/elastic/kibana/issues/new?labels=Project%3AAccessibility&template=Accessibility.md&title=%28Accessibility%29).
4542

46-
4743
**Technical specifications**
4844
Accessibility of Kibana relies on the following technologies to work with your web browser and any assistive technologies or plugins installed on your computer:
4945

@@ -52,7 +48,6 @@ Accessibility of Kibana relies on the following technologies to work with your w
5248
* JavaScript
5349
* WAI-ARIA
5450

55-
5651
**Limitations and alternatives**
5752
Despite our best efforts to ensure accessibility of Kibana, there are some limitations. Please [open an issue on GitHub](https://github.com/elastic/kibana/issues/new?labels=Project%3AAccessibility&template=Accessibility.md&title=%28Accessibility%29) if you observe an issue not in this list.
5853

@@ -65,7 +60,6 @@ Known limitations are in the following areas:
6560

6661
To see individual tickets, view our [GitHub issues with label "`Project:Accessibility`"](https://github.com/elastic/kibana/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3AProject%3AAccessibility).
6762

68-
6963
**Assessment approach**
7064
Elastic assesses the accessibility of Kibana with the following approaches:
7165

@@ -81,40 +75,46 @@ Manual testing largely focuses on screen reader support and is done on:
8175
:::
8276

8377
## Querying and filtering
78+
8479
Elasticsearch’s robust query capabilities enable you to retrieve specific data from your datasets. Using the Query DSL (Domain Specific Language), you can build powerful, flexible queries that support:
8580

86-
- Full-text search
87-
- Boolean logic
88-
- Fuzzy matching
89-
- Proximity searches
90-
- Semantic search
91-
- …and more.
81+
* Full-text search
82+
* Boolean logic
83+
* Fuzzy matching
84+
* Proximity searches
85+
* Semantic search
86+
* …and more.
9287

9388
These tools simplify refining searches and pinpointing relevant information in real-time.
9489

95-
## Scripting
96-
Scripting makes custom data manipulation and transformation possible during search and aggregation processes. Using scripting languages like Painless, you can calculate custom metrics, perform conditional logic, or adjust data dynamically in search time. This flexibility ensures tailored insights specific to your needs.
90+
### Aggregations
9791

98-
## Aggregations
9992
Aggregations provide advanced data analysis, enabling you to extract actionable insights. With aggregations, you can calculate statistical metrics (for example, sums, averages, medians), group data into buckets (histograms, terms, and so on), or perform nested and multi-level analyses. Aggregations transform raw data into structured insights with ease.
10093

10194
## Geospatial Analysis
95+
10296
The geospatial capabilities enable analysis of location-based data, including distance calculations, polygon and bounding box queries, and geohash grid aggregations. This functionality is necessary for logistics, real estate, and IoT industries, where location matters.
10397

10498
## Machine Learning
99+
105100
Elasticsearch integrates machine learning for proactive analytics, helping you to:
106-
- Detect anomalies in time-series data
107-
- Forecast future trends
108-
- Analyze seasonal patterns
109-
- Perform powerful NLP operations such as semantic search
110-
- Machine learning models simplify complex predictive tasks, unlocking new opportunities for optimization.
101+
* Detect anomalies in time-series data
102+
* Forecast future trends
103+
* Analyze seasonal patterns
104+
* Perform powerful NLP operations such as semantic search
105+
* Machine learning models simplify complex predictive tasks, unlocking new opportunities for optimization.
106+
107+
## Scripting
108+
109+
Scripting makes custom data manipulation and transformation possible during search and aggregation processes. Using scripting languages like Painless, you can calculate custom metrics, perform conditional logic, or adjust data dynamically in search time. This flexibility ensures tailored insights specific to your needs.
111110

112111
## Explore with Discover [explore-the-data]
113112

114113
[Discover](/explore-analyze/discover.md) lets you interact directly with raw data. Use Discover to:
115-
- Browse documents in your indices
116-
- Apply filters and search queries
117-
- Visualize results in real-time
114+
115+
* Browse documents in your indices
116+
* Apply filters and search queries
117+
* Visualize results in real-time
118118

119119
It’s the starting point for exploratory analysis.
120120

@@ -124,21 +124,25 @@ Create a variety of visualizations and add them to a dashboard.
124124

125125
### Dashboards
126126
[Dashboards](/explore-analyze/dashboards.md) serve as centralized hubs for visualizing and monitoring data insights. With Dashboards, you can:
127-
- Combine multiple visualizations into a single, unified view
128-
- Display data from multiple indices or datasets for comprehensive analysis
129-
- Customize layouts to suit specific workflows and preferences
127+
128+
* Combine multiple visualizations into a single, unified view
129+
* Display data from multiple indices or datasets for comprehensive analysis
130+
* Customize layouts to suit specific workflows and preferences
130131

131132
Dashboards provide an interactive and cohesive environment with filtering capabilities and controls to explore trends and metrics at a glance.
132133

133134
### Panels and visualizations
135+
134136
[Panels and visualizations](/explore-analyze/visualize.md) are the core elements that populate your dashboards, enabling dynamic data representation. They support diverse chart types, Interactive filtering, and drill-down capabilities to explore data further. These building blocks transform raw data into clear, actionable visuals, allowing users to analyze and interpret results effectively.
135137

136138
## Reporting and sharing
139+
137140
You can share your work and findings with colleagues and stakeholders or generate reports. Report generation can be scheduled or on-demand. You can choose from multiple formats (for example, PDF, CSV). These tools ensure that actionable insights reach the right people at the right time.
138141
Alerting
139142
You can set up alerts to monitor your data continuously. Alerts notify you when specific conditions are met. This ensures timely action on critical issues.
140143

141144
## Bringing it all together
145+
142146
Elasticsearch's features integrate seamlessly, offering an end-to-end solution for exploring, analyzing, and acting on data. If you want to explore any of the listed features in greater depth, refer to their respective documentation pages and check the provided hands-on examples and tutorials.
143147

144148
If you'd like to explore some features but don't have data ready yet, some sample data sets are available in {{kib}} for you to install and play with.
@@ -153,7 +157,3 @@ Sample data sets come with sample visualizations, dashboards, and more to help y
153157
4. Install the sample data sets that you want.
154158

155159
Once installed, you can access the sample data in the various {{kib}} apps available to you.
156-
157-
158-
159-

explore-analyze/machine-learning/anomaly-detection/ml-ad-run-jobs.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,6 @@ If the estimated model memory limit for an {{anomaly-job}} is greater than the m
105105

106106
* If you are using the default value for the `model_memory_limit` and the {{ml}} nodes in the cluster have lots of memory, the best course of action might be to simply increase the job’s `model_memory_limit`. Before doing this, however, double-check that the chosen analysis makes sense. The default `model_memory_limit` is relatively low to avoid accidentally creating a job that uses a huge amount of memory.
107107
* If the {{ml}} nodes in the cluster do not have sufficient memory to accommodate a job of the estimated size, the only options are:
108-
109108
* Add bigger {{ml}} nodes to the cluster, or
110109
* Accept that the job will hit its memory limit and will not necessarily find all the anomalies it could otherwise find.
111110

explore-analyze/machine-learning/anomaly-detection/ml-ad-troubleshooting.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,17 @@ If an {{anomaly-job}} fails, try to restart the job by following the procedure d
1818
If an {{anomaly-job}} has failed, do the following to recover from `failed` state:
1919

2020
1. *Force* stop the corresponding {{dfeed}} by using the [Stop {{dfeed}} API](https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-stop-datafeed.html) with the `force` parameter being `true`. For example, the following request force stops the `my_datafeed` {{dfeed}}.
21-
22-
```console
23-
POST _ml/datafeeds/my_datafeed/_stop
21+
```console
22+
POST _ml/datafeeds/my_datafeed/_stop
2423
{
2524
"force": "true"
2625
}
27-
```
26+
```
2827

2928
2. *Force* close the {{anomaly-job}} by using the [Close {{anomaly-job}} API](https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-close-job.html) with the `force` parameter being `true`. For example, the following request force closes the `my_job` {{anomaly-job}}:
30-
31-
```console
32-
POST _ml/anomaly_detectors/my_job/_close?force=true
33-
```
29+
```console
30+
POST _ml/anomaly_detectors/my_job/_close?force=true
31+
```
3432

3533
3. Restart the {{anomaly-job}} on the **Job management** pane in {{kib}}.
3634

explore-analyze/machine-learning/anomaly-detection/ml-configuring-populations.md

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,25 +14,22 @@ This type of analysis is most effective when the behavior within a group is gene
1414

1515
Population analysis is resource-efficient and scales well, enabling the analysis of populations consisting of hundreds of thousands or even millions of entities with a lower resource footprint than analyzing each series individually.
1616

17-
1817
## Recommendations [population-recommendations]
1918

2019
* Use population analysis when the behavior within a group is mostly homogeneous, as it helps identify anomalous patterns effectively.
2120
* Leverage population analysis when dealing with large-scale datasets.
2221
* Avoid using population analysis when members of the population exhibit vastly different behaviors, as it may not be effective.
2322

24-
2523
## Creating population jobs [creating-population-jobs]
2624

2725
1. In {{kib}}, navigate to **Jobs**. To open **Jobs**, find **{{ml-app}} > Anomaly Detection** in the main menu, or use the [global search field](https://www.elastic.co/guide/en/kibana/current/kibana-concepts-analysts.html#_finding_your_apps_and_objects).
2826
2. Click **Create job**, select the {{data-source}} you want to analyze.
2927
3. Select the **Population** wizard from the list.
3028
4. Choose a population field - it’s the `clientip` field in this example - and the metric you want to use for the analysis - `Mean(bytes)` in this example.
31-
32-
:::{image} ../../../images/machine-learning-ml-population-wizard.png
33-
:alt: Creating a population job in Kibana
34-
:class: screenshot
35-
:::
29+
:::{image} ../../../images/machine-learning-ml-population-wizard.png
30+
:alt: Creating a population job in Kibana
31+
:class: screenshot
32+
:::
3633

3734
5. Click **Next**.
3835
6. Provide a job ID and click **Next**.
@@ -68,11 +65,8 @@ PUT _ml/anomaly_detectors/population
6865

6966
1. This `over_field_name` property indicates that the metrics for each client (as identified by their IP address) are analyzed relative to other clients in each bucket.
7067

71-
7268
::::
7369

74-
75-
7670
### Viewing the job results [population-job-results]
7771

7872
Use the **Anomaly Explorer** in {{kib}} to view the analysis results:

0 commit comments

Comments
 (0)