This article describes how to access and use OpenSearch-dashboards.
OpenSearch Dashboards is an open-source, integrated visualization tool that makes it easy for users to explore their data in OpenSearch.
| Table of Contents |
|---|
By default, environment deploys with Shared OpenSearch server in AWS (folio-opensearch name). For this server already created a Dashboard https://folio-opensearch-dashboards.ci.folio.org/
If you deploy env with embedded OpenSearch, automatically deploys the dashboard in your environment (https://<cluster-name>-<project-name>-opensearch-dashboards.ci.folio.org)
Authentication
Authentication is the same for the shared dashboard and embedded dashboard.
To get OpenSearch-dashboards username and password(if it's needed), follow steps:
- Log in to Rancher
- Select cluster
- Select namespace
- Navigate to Storage → Secrets → db-connect-modules
- Copy ELASTICSEARCH_USERNAME and ELASTICSEARCH_PASSWORD values
OpenSearch Dashboards
Dashboards page shows common information about existing OpenSearch cluster and provides tools for creating and managing dashboard.
From real-time application monitoring, threat detection, and incident management to personalized search, OpenSearch Dashboards gives you the data visualizations needed to graphically represent trends, outliers, and patterns in your data.
| Info | ||
|---|---|---|
| ||
Each page has a hint in order to get started using OpenSearch-Dashboards. |
Discover in OpenSearch Dashboards helps you extract insights and get value out of data assets across your organization. You can quickly ingest and query your data, display that data in visualizations and interactive dashboards, and deliver insights to your organization.
For creating visualization or dashboards it should be created index pattern.
To create index pattern, follow steps:
- Go to Stack Management/Index patterns page
- Press Create index pattern
- Enter/Choose index pattern name
- Enter/Skip Time field
- Submit
By visualizing your data, you translate complex, high-volume, or numerical data into a visual representation that is easier to process. OpenSearch Dashboards gives you data visualization tools to improve and automate the visual communication process.
OpenSearch Plugins
There are different plugins that can be installed in OpenSearch service.
In current case OpenSearch Plugins page has the following plugins:
| Plugins | Action/Purpose |
| Query Workbench | Lets you write the SQL and PPL query to search for data and visualizations. |
| Reporting | Used to create PNG, PDF, and CSV reports. |
| Alerting | Alerts, Monitors and Destinations. Monitor your data and create alert notifications that trigger when conditions occur in one or more indexes. |
| Anomaly Detection | Automatically detects anomalies in your data in near real-time. An anomaly in OpenSearch is any unusual behavior change in your time-series data. |
| Observability | Collection of plugins and applications that let you visualize data-driven events by using Piped Processing Language to explore, discover, and query data stored in OpenSearch. |
| Index Management | Lets you automate recurring index management activities and reduce storage costs. |
Management
OpenSearch DevTools Console is used for sending queries to OpenSearch.
In Stack Management page there are 3 subpage
- Index Patterns - Create and manage the index patterns.
- Saved Objects - Manage and share your saved objects.
- Advanced settings - Advanced settings of OpenSearch Dashboards (for advanced users).
| Info | ||
|---|---|---|
| ||
For detailed information please follow apache Opensearch documentation |