Merge pull request #2 from opensearch-project/opensearch-dashboards
OpenSearch Dashboards chapter fixes
This commit is contained in:
Andrew Etter
GitHub
commit
ac6ade448b
|
|
@ -1,26 +1,26 @@
|
|||
---
|
||||
layout: default
|
||||
title: Gantt Charts
|
||||
title: Gantt charts
|
||||
parent: OpenSearch Dashboards
|
||||
nav_order: 10
|
||||
---
|
||||
|
||||
# Gantt charts
|
||||
|
||||
OpenSearch includes a Gantt chart visualization. These charts show the start, end, and duration of unique events in a sequence. Gantt charts are useful in trace analytics, telemetry, and anomaly detection use cases, where you want to understand interactions and dependencies between various events in a schedule.
|
||||
OpenSearch Dashboards includes a Gantt chart visualization. Gantt charts show the start, end, and duration of unique events in a sequence. Gantt charts are useful in trace analytics, telemetry, and anomaly detection use cases, where you want to understand interactions and dependencies between various events in a schedule.
|
||||
|
||||
For example, consider an index of log data. The fields in a typical set of log data, especially audit logs, contain a specific operation or event with a start time and duration.
|
||||
|
||||
To create a Gantt chart, do the following:
|
||||
To create a Gantt chart, perform the following steps:
|
||||
|
||||
1. In the visualizations menu, choose **Create visualization** and **Gantt Chart**.
|
||||
1. Choose a source for chart (e.g. some log data).
|
||||
1. Choose a source for the chart (e.g. some log data).
|
||||
1. Under **Metrics**, choose **Event**. For log data, each log is an event.
|
||||
1. Select the `**Start Time**` and the **Duration** fields from your data set. The start time is the timestamp for the begining of an event. The duration is the amount of time to add to the start time.
|
||||
1. Under **Results**, choose the number of events that you want to display on the chart. Gantt charts sequence events from earliest to latest based on start time.
|
||||
1. Select the **Start Time** and **Duration** fields from your data set. The start time is the timestamp for the begining of an event. The duration is the amount of time to add to the start time.
|
||||
1. Under **Results**, choose the number of events to display on the chart. Gantt charts sequence events from earliest to latest based on start time.
|
||||
1. Choose **Panel settings** to adjust axis labels, time format, and colors.
|
||||
1. Choose **Update**.
|
||||
|
||||
|
||||
|
||||
This Gantt chart the ID for each log on the Y axis. Each bar is a unique event that spans some amount of time. Hover over a bar to see the duration of that event.
|
||||
This Gantt chart displays the ID of each log on the y-axis. Each bar is a unique event that spans some amount of time. Hover over a bar to see the duration of that event.
|
||||
|
|
|
|||
|
|
@ -28,20 +28,6 @@ You *can* start OpenSearch Dashboards using `docker run` after [creating a Docke
|
|||
|
||||
1. When finished, run `docker-compose down`.
|
||||
|
||||
|
||||
## Run OpenSearch Dashboards using the RPM or Debian package
|
||||
|
||||
1. If you haven't already, add the `yum` repositories specified in steps 1--2 in [RPM](../install/rpm) or the `apt` repositories in steps 2--3 of [Debian package](../install/deb).
|
||||
1. `sudo yum install opensearch-dashboards` or `sudo apt install opensearch-dashboards`
|
||||
1. Modify `/etc/opensearch-dashboards/opensearch_dashboards.yml` to use `opensearch.hosts` rather than `opensearch.url`.
|
||||
1. `sudo systemctl start opensearch-dashboards.service`
|
||||
1. To stop OpenSearch Dashboards:
|
||||
|
||||
```bash
|
||||
sudo systemctl stop opensearch-dashboards.service
|
||||
```
|
||||
|
||||
|
||||
### Configuration
|
||||
|
||||
To run OpenSearch Dashboards when the system starts:
|
||||
|
|
@ -108,39 +94,6 @@ You can also modify the values in `/etc/opensearch-dashboards/opensearch_dashboa
|
|||
./bin/opensearch-dashboards
|
||||
```
|
||||
|
||||
|
||||
## Run OpenSearch Dashboards on Windows (ZIP)
|
||||
|
||||
1. Download the ZIP.
|
||||
|
||||
1. Extract [the ZIP file](https://d3g5vo6xdbdb9a.cloudfront.net/downloads/opensearch-windows/ode-windows-zip/opensearch-dashboards-{{site.opensearch_version}}-windows-x64.zip) to a directory and open that directory at the command prompt.
|
||||
|
||||
1. If desired, modify `config/opensearch_dashboards.yml`.
|
||||
|
||||
1. Run OpenSearch Dashboards:
|
||||
|
||||
```
|
||||
.\bin\opensearch-dashboards.bat
|
||||
```
|
||||
|
||||
|
||||
## Run OpenSearch Dashboards on Windows (EXE)
|
||||
|
||||
1. Download [the EXE file](https://d3g5vo6xdbdb9a.cloudfront.net/downloads/opensearch-windows/opensearch-executables/opensearch-dashboards-{{site.opensearch_version}}-windows-x64.exe), run it, and click through the steps.
|
||||
|
||||
1. Open the command prompt.
|
||||
|
||||
1. Navigate to the OpenSearch Dashboards install directory.
|
||||
|
||||
1. If desired, modify `config/opensearch_dashboards.yml`.
|
||||
|
||||
1. Run OpenSearch Dashboards:
|
||||
|
||||
```
|
||||
.\bin\opensearch-dashboards.bat
|
||||
```
|
||||
|
||||
|
||||
## Get started with OpenSearch Dashboards
|
||||
|
||||
1. After starting OpenSearch Dashboards, you can access it at port 5601. For example, http://localhost:5601.
|
||||
|
|
|
|||
|
|
@ -1,20 +1,19 @@
|
|||
---
|
||||
layout: default
|
||||
title: WMS Map Server
|
||||
title: WMS map server
|
||||
parent: OpenSearch Dashboards
|
||||
nav_order: 5
|
||||
---
|
||||
|
||||
# Configure WMS map server
|
||||
|
||||
Due to licensing restrictions, the default installation of OpenSearch Dashboards does in OpenSearch doesn't include a map server for tile map visualizations. To configure OpenSearch Dashboards to use a WMS map server:
|
||||
Due to licensing restrictions, the default installation of OpenSearch Dashboards doesn't include a map server for tile map visualizations. To configure OpenSearch Dashboards to use a WMS map server:
|
||||
|
||||
1. Open OpenSearch Dashboards at `https://<host>:<port>`. For example, [https://localhost:5601](https://localhost:5601).
|
||||
1. If necessary, log in.
|
||||
1. **Management**.
|
||||
1. **Advanced Settings**.
|
||||
1. Choose **Management** and **Advanced Settings**.
|
||||
1. Locate `visualization:tileMap:WMSdefaults`.
|
||||
1. Change `enabled` to true, and add the URL of a valid WMS map server.
|
||||
1. Change `enabled` to true and add the URL of a valid WMS map server:
|
||||
|
||||
```json
|
||||
{
|
||||
|
|
@ -27,5 +26,5 @@ Due to licensing restrictions, the default installation of OpenSearch Dashboards
|
|||
}
|
||||
```
|
||||
|
||||
Map services often have licensing fees or restrictions. You are responsible for all such considerations on any map server that you specify.
|
||||
Map services often have licensing fees or restrictions. You're responsible for all such considerations on any map server that you specify.
|
||||
{: .note }
|
||||
|
|
|
|||
|
|
@ -14,16 +14,16 @@ Notebooks have a known issue with [tenants](../../security/access-control/multi-
|
|||
|
||||
An OpenSearch Dashboards notebook is an interface that lets you easily combine live visualizations and narrative text in a single notebook interface.
|
||||
|
||||
With OpenSearch Dashboards notebooks, you can interactively explore data by running different visualizations and share your work with team members to collaborate on a project.
|
||||
Notebooks let you interactively explore data by running different visualizations that you can share with team members to collaborate on a project.
|
||||
|
||||
A notebook is a document composed of two elements: OpenSearch Dashboards visualizations and paragraphs (Markdown). Choose multiple timelines to compare and contrast visualizations.
|
||||
|
||||
Common use cases include creating postmortem reports, designing runbooks, building live infrastructure reports, and writing documentation.
|
||||
|
||||
|
||||
## Get Started with Notebooks
|
||||
## Get Started with notebooks
|
||||
|
||||
To get started, choose **OpenSearch Dashboards Notebooks** in OpenSearch Dashboards.
|
||||
To get started, choose **OpenSearch Dashboards Notebooks** within OpenSearch Dashboards.
|
||||
|
||||
|
||||
### Step 1: Create a notebook
|
||||
|
|
@ -52,11 +52,8 @@ Paragraphs combine text and visualizations for describing data.
|
|||
#### Add a visualization paragraph
|
||||
|
||||
1. To add a visualization, choose **Add OpenSearch Dashboards visualization paragraph**.
|
||||
1. In **Title**, select your visualization and choose a date range.
|
||||
|
||||
You can choose multiple timelines to compare and contrast visualizations.
|
||||
|
||||
To run and save a paragraph, choose **Run**.
|
||||
1. In **Title**, select your visualization and choose a date range. You can choose multiple timelines to compare and contrast visualizations.
|
||||
1. To run and save a paragraph, choose **Run**.
|
||||
|
||||
You can perform the following actions on paragraphs:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
layout: default
|
||||
title: Standalone OpenSearch Dashboards Plugin Install
|
||||
title: Standalone OpenSearch Dashboards plugin install
|
||||
parent: OpenSearch Dashboards
|
||||
nav_order: 1
|
||||
---
|
||||
|
|
@ -156,17 +156,19 @@ sudo bin/opensearch-dashboards-plugin list
|
|||
|
||||
## Remove plugins
|
||||
|
||||
To remove a plugin:
|
||||
|
||||
```bash
|
||||
sudo bin/opensearch-dashboards-plugin remove <plugin-name>
|
||||
```
|
||||
|
||||
For certain plugins, you must also remove the "optimze" bundle. Here is a sample command for the Anomaly Detection plugin:
|
||||
For certain plugins, you must also remove the "optimze" bundle. This is a sample command for the Anomaly Detection plugin:
|
||||
|
||||
```bash
|
||||
sudo rm /usr/share/opensearch-dashboards/optimize/bundles/opensearch-anomaly-detection-opensearch-dashboards.*
|
||||
```
|
||||
|
||||
Then restart OpenSearch Dashboards. After the removal of any plugin, OpenSearch Dashboards performs an optimize operation the next time you start it. This operation takes several minutes even on fast machines, so be patient.
|
||||
Then restart OpenSearch Dashboards. After you remove any plugin, OpenSearch Dashboards performs an optimize operation the next time you start it. This operation takes several minutes even on fast machines, so be patient.
|
||||
|
||||
|
||||
## Update plugins
|
||||
|
|
|
|||
|
|
@ -8,15 +8,15 @@ nav_order: 20
|
|||
|
||||
# Reporting
|
||||
|
||||
The OpenSearch Dashboards reports feature lets you create PNG, PDF, and CSV reports. To use reports, you must have the correct permissions. For summaries of the predefined roles and the permissions they grant, see the [security plugin](../../security/access-control/users-roles/#predefined-roles).
|
||||
You can use OpenSearch Dashboards to create PNG, PDF, and CSV reports. To create reports, you must have the correct permissions. For a summary of the predefined roles and the permissions they grant, see the [security plugin](../../security/access-control/users-roles/#predefined-roles).
|
||||
|
||||
|
||||
## Create reports from Discovery, Visualize, or Dashboard
|
||||
|
||||
On-demand reports let you quickly generate a report from the current view.
|
||||
Quickly generate an on-demand report from the current view.
|
||||
|
||||
1. From the top bar, choose **Reporting**.
|
||||
1. For dashboards or visualizations, **Download PDF** or **Download PNG**. From the Discover page, choose **Download CSV**.
|
||||
1. From the top menu bar, choose **Reporting**.
|
||||
1. For dashboards or visualizations, choose **Download PDF** or **Download PNG**. From the Discover page, choose **Download CSV**.
|
||||
|
||||
Reports generate asynchronously in the background and might take a few minutes, depending on the size of the report. A notification appears when your report is ready to download.
|
||||
|
||||
|
|
@ -25,18 +25,18 @@ On-demand reports let you quickly generate a report from the current view.
|
|||
|
||||
## Create reports using a definition
|
||||
|
||||
Definitions let you schedule reports for periodic creation.
|
||||
Definitions let you generate reports on a periodic schedule.
|
||||
|
||||
1. From the left navigation panel, choose **Reporting**.
|
||||
1. From the navigation panel, choose **Reporting**.
|
||||
1. Choose **Create**.
|
||||
1. Under **Report settings**, enter a name and optional description for your report.
|
||||
1. Choose the **Report Source** (i.e. the page from which the report is generated). You can generate reports from the **Dashboard**, **Visualize** or **Discover** pages.
|
||||
1. Choose your dashboard, visualization, or saved search. Then choose a time range for the report.
|
||||
1. Choose the **Report Source** (i.e. the page from which the report is generated). You can generate reports from the **Dashboard**, **Visualize**, or **Discover** pages.
|
||||
1. Select your dashboard, visualization, or saved search. Then choose a time range for the report.
|
||||
1. Choose an appropriate file format for the report.
|
||||
1. (Optional) Add a header or footer for the report. Headers and footers are only available for dashboard or visualization reports.
|
||||
1. (Optional) Add a header or footer to the report. Headers and footers are only available for dashboard or visualization reports.
|
||||
1. Under **Report trigger**, choose either **On-demand** or **Schedule**.
|
||||
|
||||
For scheduled reports, choose either **Recurring** or **Cron based**. You can receive reports daily or at some other time interval. Cron expressions give you even more flexiblity. See [Cron expression reference](../../alerting/cron/) for more information.
|
||||
For scheduled reports, select either **Recurring** or **Cron based**. You can receive reports daily or at some other time interval. Cron expressions give you even more flexiblity. See [Cron expression reference](../../alerting/cron/) for more information.
|
||||
|
||||
1. Choose **Create**.
|
||||
|
||||
|
|
@ -44,12 +44,12 @@ Definitions let you schedule reports for periodic creation.
|
|||
|
||||
### Chromium fails to launch with OpenSearch Dashboards
|
||||
|
||||
While creating a report for dashboards or visualizations, you might see a `Download error`:
|
||||
While creating a report for dashboards or visualizations, you might see a the following error:
|
||||
|
||||
|
||||
|
||||
This problem occurs due to two reasons:
|
||||
This problem can occur for two reasons:
|
||||
|
||||
1. You don't have the correct version of `headless-chrome` to match the operating system on which OpenSearch Dashboards is running. Download the correct version of `headless-chrome` from [here](https://github.com/opensearch-project/opensearch-dashboards-reports/releases/tag/chromium-1.12.0.0).
|
||||
- You don't have the correct version of `headless-chrome` to match the operating system on which OpenSearch Dashboards is running. Download the correct version [here](https://github.com/opensearch-project/dashboards-reports/releases/tag/chromium-1.12.0.0).
|
||||
|
||||
2. You're missing additional dependencies. Install the required dependencies for your operating system from the [additional libraries](https://github.com/opensearch-project/opensearch-dashboards-reports/blob/dev/opensearch-dashboards-reports/rendering-engine/headless-chrome/README.md#additional-libaries) section.
|
||||
- You're missing additional dependencies. Install the required dependencies for your operating system from the [additional libraries](https://github.com/opensearch-project/dashboards-reports/blob/main/dashboards-reports/rendering-engine/headless-chrome/README.md#additional-libaries) section.
|
||||
|
|
|
|||
Loading…
Reference in New Issue