Add remote repository exporter to query insights dashboards configuration page#12554
Conversation
…tion docs Signed-off-by: Emily Guo <35637792+LilyCaroline17@users.noreply.github.com>
LilyCaroline17
requested review from
cwperks,
dlvenable,
epugh,
kolchfa-aws,
mgodwan,
peterzhuamazon and
sumobrian
as code owners
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Merged. Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer. When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). |
|
|
||
| The **Remote repository exporter settings** panel lets you export top N query insights data to a remote Amazon Simple Storage Service (Amazon S3) repository for cheaper, long-term storage. This exporter operates independently of the local exporter and data retention settings and appears below them on the configuration page. Because it's independent, you can run the remote repository exporter alongside the local index exporter, exporting data to both destinations at the same time. | ||
|
|
||
| The remote repository exporter requires the [`repository-s3` plugin]({{site.url}}{{site.baseurl}}/tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore/#amazon-s3) to be installed on the cluster. If the plugin isn't installed, the panel displays a callout titled **The repository-s3 plugin is not installed** with a link to the setup guide. To set up the exporter, install the plugin on all nodes (which requires restarting each node) and configure your AWS credentials in the OpenSearch keystore. |
There was a problem hiding this comment.
If the plugin isn't installed, the panel displays a callout titled The repository-s3 plugin is not installed with a link to the setup guide
Do we need to call out this at all?
I think in this doc if we have a link that points to the set up guide on repository-s3, it should be good.
3 participants
Description
Documents the remote repository exporter added to the query insights dashboards configuration page in. It covers the repository-s3 plugin prerequisite, the steps for registering an S3 repository, and the steps for enabling the exporter.
Issues Resolved
References PR: opensearch-project/query-insights-dashboards#512
Version
3.7
Frontend features
If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.