Add managing, monitoring, and tuning sections by Naarcha-AWS · Pull Request #2605 · opensearch-project/documentation-website

Naarcha-AWS · 2023-02-03T00:43:26Z

Signed-off-by: Naarcha-AWS naarcha@amazon.com

Description

Fixes merge conflicts from #2353

Issues Resolved

List any issues this PR will resolve, e.g. Closes [...].

Checklist

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

hdhalter

Looks good, Nate! I did some random link checking and didn't find any issues.

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

cwillum

With some comments.

cwillum · 2023-02-03T17:43:20Z

_observing-your-data/notebooks.md

-redirect_from: /notebooks/
+redirect_from: 
+  - /notebooks/
+  - /observing-your-data/notebooks/


I'm probably wrong here. But would the second redirect here be "_observability-plugin/notebooks/"?

_tuning-your-cluster/availability-and-recovery/snapshots/index.md

_tuning-your-cluster/cluster-manager-task-throttling.md

_tuning-your-cluster/availability-and-recovery/snapshots/sm-api.md

cwillum · 2023-02-03T19:39:57Z

about.md

 Unsurprisingly, people often use search engines like OpenSearch as the backend for a search application---think [Wikipedia](https://en.wikipedia.org/wiki/Wikipedia:FAQ/Technical#What_software_is_used_to_run_Wikipedia?) or an online store. It offers excellent performance and can scale up and down as the needs of the application grow or shrink.

-An equally popular, but less obvious use case is log analytics, in which you take the logs from an application, feed them into OpenSearch, and use the rich search and visualization functionality to identify issues. For example, a malfunctioning web server might throw a 500 error 0.5% of the time, which can be hard to notice unless you have a real-time graph of all HTTP status codes that the server has thrown in the past four hours. You can use [OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/dashboards/) to build these sorts of visualizations from data in OpenSearch.
+An equally popular, but less obvious use case is log analytics, in which you take the logs from an application, feed them into OpenSearch, and use the rich search and visualization functionality to identify issues. For example, a malfunctioning web server might throw a 500 error 0.5% of the time, which can be hard to notice unless you have a real-time graph of all HTTP status codes that the server has thrown in the past four hours. You can use [OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/dashboards/index/) to build these sorts of visualizations from data in OpenSearch.


I can't find this file.
I don't see the /dashboards/index/ link.

This original index URL redirects to here: https://opensearch.org/docs/latest/dashboards/quickstart-dashboards/

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

Signed-off-by: natebower <102320899+natebower@users.noreply.github.com>

* Add Peer forwarder to doc site repo. Signed-off-by: carolxob <carolxob@amazon.com> * Minor updates. Signed-off-by: carolxob <carolxob@amazon.com> * Minor updates to header section. Signed-off-by: carolxob <carolxob@amazon.com> * Minor copyedits and heading adjustements. Signed-off-by: carolxob <carolxob@amazon.com> * Minor copyedits and heading updates. Additional of Optional section to simplify wording. Signed-off-by: carolxob <carolxob@amazon.com> * Minor copyedits and heading adjustments. Signed-off-by: carolxob <carolxob@amazon.com> * Changed capitalization in title. Signed-off-by: carolxob <carolxob@amazon.com> * Minor changes from doc review feedback. Signed-off-by: carolxob <carolxob@amazon.com> * Update _data-prepper/peer-forwarder.md Co-authored-by: Aria Marble <111301581+ariamarble@users.noreply.github.com> * Update _data-prepper/peer-forwarder.md Co-authored-by: Aria Marble <111301581+ariamarble@users.noreply.github.com> * Update _data-prepper/peer-forwarder.md Co-authored-by: Aria Marble <111301581+ariamarble@users.noreply.github.com> * Update _data-prepper/peer-forwarder.md Co-authored-by: Aria Marble <111301581+ariamarble@users.noreply.github.com> * Update _data-prepper/peer-forwarder.md Co-authored-by: Aria Marble <111301581+ariamarble@users.noreply.github.com> * Update _data-prepper/peer-forwarder.md Co-authored-by: Aria Marble <111301581+ariamarble@users.noreply.github.com> * Trying to commit file. Signed-off-by: carolxob <carolxob@amazon.com> * Trying to push file. Signed-off-by: carolxob <carolxob@amazon.com> * Trying to push file again. Signed-off-by: carolxob <carolxob@amazon.com> * Trying to push file one more time after rebasing. Signed-off-by: carolxob <carolxob@amazon.com> * Minor change. Signed-off-by: carolxob <carolxob@amazon.com> * Minor edits. Signed-off-by: carolxob <carolxob@amazon.com> * Converted optional configuration section to table. Signed-off-by: carolxob <carolxob@amazon.com> * Minor adjustmenets. Signed-off-by: carolxob <carolxob@amazon.com> * Minor adjustments again. Signed-off-by: carolxob <carolxob@amazon.com> * Updates from doc review feedback. Signed-off-by: carolxob <carolxob@amazon.com> * Made changes based on doc review feedback. Signed-off-by: carolxob <carolxob@amazon.com> * Made minor heading adjustements. Signed-off-by: carolxob <carolxob@amazon.com> * Made edits based on doc review feedback. Signed-off-by: carolxob <carolxob@amazon.com> * Made updates based on editorial feedback. Signed-off-by: carolxob <carolxob@amazon.com> * Made extensive changes based on editorial feedback. Signed-off-by: carolxob <carolxob@amazon.com> * Incorporated minor editorial feedback changes. Signed-off-by: carolxob <carolxob@amazon.com> * Incorporated more editorial feedback. Signed-off-by: carolxob <carolxob@amazon.com> * Minor changes. Signed-off-by: carolxob <carolxob@amazon.com> * Committed existing Peer Forwarder file to new PR to simplify feedback. Signed-off-by: carolxob <carolxob@amazon.com> * Incorporated doc review feedback. Signed-off-by: carolxob <carolxob@amazon.com> * Minor updates. Signed-off-by: carolxob <carolxob@amazon.com> * Minor changes. Signed-off-by: carolxob <carolxob@amazon.com> * Updates specifically to table formatting. Signed-off-by: carolxob <carolxob@amazon.com> * Minor updates. Signed-off-by: carolxob <carolxob@amazon.com> * Made minor edit to the end of the Configuration table. Signed-off-by: carolxob <carolxob@amazon.com> * Minor edits from doc review feedback. Signed-off-by: carolxob <carolxob@amazon.com> * Minor updates from doc review. Signed-off-by: carolxob <carolxob@amazon.com> * Incorporated more editorial feedback. Signed-off-by: carolxob <carolxob@amazon.com> * Minor update to line 112. Signed-off-by: carolxob <carolxob@amazon.com> * Made minor edits to references to S3. Changed to Amazon S3 where applicable. Signed-off-by: carolxob <carolxob@amazon.com> * Minor edits. Signed-off-by: carolxob <carolxob@amazon.com> * Minor updates to text. Signed-off-by: carolxob <carolxob@amazon.com> * Made updates based on SME and doc review feedback. Signed-off-by: carolxob <carolxob@amazon.com> * Minor change to one word. Signed-off-by: carolxob <carolxob@amazon.com> * Removed a comma. Signed-off-by: carolxob <carolxob@amazon.com> --------- Signed-off-by: carolxob <carolxob@amazon.com> Co-authored-by: Aria Marble <111301581+ariamarble@users.noreply.github.com>

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Creating PR with first file. Signed-off-by: carolxob <carolxob@amazon.com> * Adding newly created files to PR. Signed-off-by: carolxob <carolxob@amazon.com> * Reorganized files and added appropriate metadata to map ToC correctly. Signed-off-by: carolxob <carolxob@amazon.com> * Moved Authoring pipelines page. Signed-off-by: carolxob <carolxob@amazon.com> * Minor ToC updates. Signed-off-by: carolxob <carolxob@amazon.com> * Minor ToC updates to Sources section for Data Prepper. Signed-off-by: carolxob <carolxob@amazon.com> * Updated Buffers section under Data Prepper. Signed-off-by: carolxob <carolxob@amazon.com> * Minor update to otelmetricssource. Signed-off-by: carolxob <carolxob@amazon.com> * Restructured ToC in Processors section for Data Prepper. Signed-off-by: carolxob <carolxob@amazon.com> * Minor filename change. Signed-off-by: carolxob <carolxob@amazon.com> * Adjustments to metadata in ToC. Signed-off-by: carolxob <carolxob@amazon.com> * Minor edit. Signed-off-by: carolxob <carolxob@amazon.com> * Fixed nav order in metadata. Signed-off-by: carolxob <carolxob@amazon.com> * Minor edit. Signed-off-by: carolxob <carolxob@amazon.com> * Minor update top metadata for ToC. Signed-off-by: carolxob <carolxob@amazon.com> * Adjustmenets to Toc order. Signed-off-by: carolxob <carolxob@amazon.com> * Minor adjustments to ToC metadata. Signed-off-by: carolxob <carolxob@amazon.com> * Minor adjustments to Sinks section. Signed-off-by: carolxob <carolxob@amazon.com> * Adjustements to high level ToC. Signed-off-by: carolxob <carolxob@amazon.com> * Minor adjustement to Pipelines.md Signed-off-by: carolxob <carolxob@amazon.com> * Minor update. Signed-off-by: carolxob <carolxob@amazon.com> * Slight reorganization. Removed two placeholder pages for now. Signed-off-by: carolxob <carolxob@amazon.com> * Removed a page and replaced with pipelines content. Signed-off-by: carolxob <carolxob@amazon.com> * Minor changes/additions to content for placeholder pages. Signed-off-by: carolxob <carolxob@amazon.com> * Minor update to page link. Signed-off-by: carolxob <carolxob@amazon.com> * Minor adjustments to ToC metadata. Signed-off-by: carolxob <carolxob@amazon.com> * Minor edits. Signed-off-by: carolxob <carolxob@amazon.com> * Removed /clients from redirects to correct nav order. Signed-off-by: carolxob <carolxob@amazon.com> * Minor edits. Signed-off-by: carolxob <carolxob@amazon.com> * Minor adjustments to ToC metadata. Signed-off-by: carolxob <carolxob@amazon.com> * Minor adjustments. Signed-off-by: carolxob <carolxob@amazon.com> * Minor adjustment ot metadata. Signed-off-by: carolxob <carolxob@amazon.com> * TOC link fixes Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Changed page name. Signed-off-by: carolxob <carolxob@amazon.com> * Corrected references to Peer Forwarder. Signed-off-by: carolxob <carolxob@amazon.com> * Renamed Data Prepper folder. Signed-off-by: carolxob <carolxob@amazon.com> * Minor updates to phrasing and capitalization. Signed-off-by: carolxob <carolxob@amazon.com> * Minor phrasing update. Signed-off-by: carolxob <carolxob@amazon.com> * Minor phrasing update. Signed-off-by: carolxob <carolxob@amazon.com> * Minor change. Signed-off-by: carolxob <carolxob@amazon.com> * Minor change to change S3 Source to S3Source. Signed-off-by: carolxob <carolxob@amazon.com> * Updated references to peer forwarder and changed capitalization. Signed-off-by: carolxob <carolxob@amazon.com> * Updated capitalization for peer forwarder. Signed-off-by: carolxob <carolxob@amazon.com> * Made edits based on doc review feedback. Signed-off-by: carolxob <carolxob@amazon.com> * Update to one word. Signed-off-by: carolxob <carolxob@amazon.com> --------- Signed-off-by: carolxob <carolxob@amazon.com> Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Co-authored-by: Naarcha-AWS <naarcha@amazon.com>

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

Add managing, monitoring, and tuning sections

442bac7

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

Naarcha-AWS added the Doc review PR: Doc review in progress label Feb 3, 2023

Naarcha-AWS requested a review from a team as a code owner February 3, 2023 00:43

Naarcha-AWS self-assigned this Feb 3, 2023

Naarcha-AWS added 2 commits February 2, 2023 19:14

Change side nav order

e7215d9

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

Reorder and rename

e6aae9a

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

hdhalter approved these changes Feb 3, 2023

View reviewed changes

Remove cluster formation

ebe6f03

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

cwillum approved these changes Feb 3, 2023

View reviewed changes

Naarcha-AWS added 2 commits February 3, 2023 14:03

A few more small tweaks

e4a1791

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

Add Chris' feedback

c3f23c0

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

kolchfa-aws and others added 7 commits February 3, 2023 16:48

Adds warning to Java high-level REST client (#2557)

b00986e

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

Modifies style guide (#2620)

a113d46

Signed-off-by: natebower <102320899+natebower@users.noreply.github.com>

Adjusts list (#2622)

4fe6eda

Signed-off-by: natebower <102320899+natebower@users.noreply.github.com>

Adds important callout (#2630)

3634ca7

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

Add managing, monitoring, and tuning sections

a6cafb8

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

Naarcha-AWS closed this Feb 3, 2023

Naarcha-AWS deleted the manage-monitor-tune branch February 3, 2023 23:01

Naarcha-AWS mentioned this pull request Feb 3, 2023

Managing. Monitoring. Tuning. #2653

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add managing, monitoring, and tuning sections#2605

Add managing, monitoring, and tuning sections#2605
Naarcha-AWS wants to merge 13 commits intomainfrom
manage-monitor-tune

Naarcha-AWS commented Feb 3, 2023

Uh oh!

hdhalter left a comment

Uh oh!

cwillum left a comment

Uh oh!

cwillum Feb 3, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cwillum Feb 3, 2023

Uh oh!

Naarcha-AWS Feb 3, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Conversation

Naarcha-AWS commented Feb 3, 2023

Description

Issues Resolved

Checklist

Uh oh!

hdhalter left a comment

Choose a reason for hiding this comment

Uh oh!

cwillum left a comment

Choose a reason for hiding this comment

Uh oh!

cwillum Feb 3, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cwillum Feb 3, 2023

Choose a reason for hiding this comment

Uh oh!

Naarcha-AWS Feb 3, 2023

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants