Skip to content

Commit 748bb26

Browse files
committed
Added observability plugin
Signed-off-by: keithhc2 <[email protected]>
1 parent 4cc5509 commit 748bb26

22 files changed

+99
-15
lines changed

_config.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,9 @@ collections:
4848
replication-plugin:
4949
permalink: /:collection/:path/
5050
output: true
51+
observability-plugins:
52+
permalink: /:collection/:path/
53+
output: true
5154
monitoring-plugins:
5255
permalink: /:collection/:path/
5356
output: true
@@ -87,6 +90,9 @@ just_the_docs:
8790
replication-plugin:
8891
name: Replication plugin
8992
nav_fold: true
93+
observability-plugins:
94+
name: Observability plugins
95+
nav_fold: true
9096
monitoring-plugins:
9197
name: Monitoring plugins
9298
nav_fold: true
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
layout: default
3+
title: Event analytics
4+
nav_order: 10
5+
---
6+
7+
# Event analytics
8+
9+
Event analytics in observability is where you can use [Piped Processing Language]({{site.url}}{{site.baseurl}}/observability-plugins/ppl/index) (PPL) queries to build and view different visualizations of your data.
10+
11+
## Get started with event analytics
12+
13+
To get started, choose **Observability** in OpenSearch Dashboards, and then choose **Event analytics**. If you want to start exploring without adding any of your own data, choose **Add sample Events Data**, and Dashboards adds some sample visualizations you can interact with.
14+
15+
## Build a query
16+
17+
To generate custom visualizations, you must first specify a PPL query. OpenSearch Dashboards then automatically creates a visualization based on the results of your query.
18+
19+
For example, the following PPL query returns a count of how many host addresses are currently in your data.
20+
21+
```
22+
source = opensearch_dashboards_sample_data_logs | fields host | stats count()
23+
```
24+
25+
By default, Dashboards shows results from the last 15 minutes of your data. To see data from a different timeframe, use the date and time selector.
26+
27+
For more information about building PPL queries, see [Piped Processing Language]({{site.url}}{{site.baseurl}}/observability-plugins/ppl/index).
28+
29+
## Save a visualization
30+
31+
After Dashboards generates a visualization, you must save it if you want to return to it at a later time or if you want to add it to an [operational panel]({{site.url}}{{site.baseurl}}/observability-plugins/operational-panels).
32+
33+
To save a visualization, expand the save dropdown menu next to **Run**, enter a name for your visualization, then choose **Save**. You can reopen any saved visualizations on the event analytics page.

_observability-plugins/index.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
layout: default
3+
title: About Observability
4+
nav_order: 1
5+
has_children: false
6+
redirect_from:
7+
- /observability-plugins/
8+
---
9+
10+
# About Observability
11+
OpenSearch Dashboards
12+
{: .label .label-yellow :}
13+
14+
The Observability plugins are a collection of plugins that let you visualize data-driven events by using Piped Processing Language to explore, discover, and query data stored in OpenSearch.
15+
16+
Your experience of exploring data might differ, but if you're new to exploring data to create visualizations, we recommend trying a work flow like the following:
17+
18+
1. Explore data over a certain timeframe using [Piped Processing Language]({{site.url}}{{site.baseurl}}/observability-plugins/ppl/index).
19+
1. Use [event analytics]({{site.url}}{{site.baseurl}}/observability-plugins/event-analytics) to turn data-driven events into visualizations.
20+
1. Create [operational panels]({{site.url}}{{site.baseurl}}/observability-plugins/plugins/operational-panels) and add visualizations to compare data the way you like.
21+
1. Use [trace analytics]({{site.url}}{{site.baseurl}}/observability-plugins/plugins/trace/index) to create traces and dive deep into your data.
22+
1. Leverage [notebooks]({{site.url}}{{site.baseurl}}/observability-plugins/plugins/notebooks) to combine different visualizations and code blocks that you can share with team members.
File renamed without changes.
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
layout: default
3+
title: Operational panels
4+
nav_order: 30
5+
---
6+
7+
# Operational panels
8+
9+
Operational panels in OpenSearch Dashboards are collections of visualizations generated using [Piped Processing Language]({{site.url}}{{site.baseurl}}/observability-plugins/ppl/index) (PPL) queries.
10+
11+
## Get started with operational panels
12+
13+
If you want to start using operational panels without adding any data, expand the **Action** menu, choose **Add samples**, and Dashboards adds a set of operational panels with saved visualizations for you to explore.
14+
15+
## Create an operational panel
16+
17+
To create an operational panel and add visualizations:
18+
19+
1. From the **Add Visualization** dropdown menu, choose **Select Existing Visualization** or **Create New Visualization**, which takes you to the [event analytics]({{site.url}}{{site.baseurl}}/observability-plugins/event-analytics) explorer, where you can use PPL to create visualizations.
20+
1. If you're adding already existing visualizations, choose a visualization from the dropdown menu.
21+
1. Choose **Add**.
22+
23+
![Sample operational panel]({{site.url}}{{site.baseurl}}/images/operational-panel.png)
24+
25+
To search for a particular visualization in your operation panels, use PPL queries to search for data you've already added to your panel.

0 commit comments

Comments
 (0)