[DOC] Update segment replication to include alerting plugin limitation #4976
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Melissa Vagi <[email protected]>
vagimeli
requested review from
cwillum,
hdhalter,
kolchfa-aws,
Naarcha-AWS,
ananzh,
seanneumann,
AMoo-Miki and
natebower
as code owners
|
@dreamer-89 Please provide your technical review of the updated text in lines 25-27. Thank you, Melissa cc: @Naarcha-AWS |
dreamer-89
reviewed
Sep 6, 2023
_tuning-your-cluster/availability-and-recovery/segment-replication/index.md
Outdated
Show resolved
Hide resolved
_tuning-your-cluster/availability-and-recovery/segment-replication/index.md
Outdated
Show resolved
Hide resolved
4 tasks
Signed-off-by: Melissa Vagi <[email protected]>
anasalkouz
reviewed
Sep 6, 2023
_tuning-your-cluster/availability-and-recovery/segment-replication/index.md
Outdated
Show resolved
Hide resolved
lezzago
reviewed
Sep 7, 2023
_tuning-your-cluster/availability-and-recovery/segment-replication/index.md
Outdated
Show resolved
Hide resolved
…mments Signed-off-by: Melissa Vagi <[email protected]>
…mments Signed-off-by: Melissa Vagi <[email protected]>
kolchfa-aws
reviewed
Sep 11, 2023
_tuning-your-cluster/availability-and-recovery/segment-replication/index.md
Outdated
Show resolved
Hide resolved
_tuning-your-cluster/availability-and-recovery/segment-replication/index.md
Outdated
Show resolved
Hide resolved
…tion/index.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
hdhalter
added
4 - Doc review
Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
vagimeli
added
5 - Editorial review
anasalkouz
reviewed
Sep 12, 2023
_tuning-your-cluster/availability-and-recovery/segment-replication/index.md
Outdated
Show resolved
Hide resolved
natebower
reviewed
Sep 13, 2023
_tuning-your-cluster/availability-and-recovery/segment-replication/index.md
Outdated
Show resolved
Hide resolved
| ## Use cases | ||
|
|
||
| Segment replication can be applied in a variety of scenarios, including: | ||
|
|
||
| - Users who have high write loads but do not have high search requirements and are comfortable with longer refresh times. |
There was a problem hiding this comment.
"Users" are not "scenarios", so the first two items do not complete the stem. The stem is fine, but I would rephrase the first two items.
_tuning-your-cluster/availability-and-recovery/segment-replication/index.md
Outdated
Show resolved
Hide resolved
| @@ -106,11 +100,13 @@ When using segment replication, consider the following: | |||
|
|
|||
| 1. Enabling segment replication for an existing index requires [reindexing](https://github.com/opensearch-project/OpenSearch/issues/3685). | |||
| 1. [Cross-cluster replication](https://github.com/opensearch-project/OpenSearch/issues/4090) does not currently use segment replication to copy between clusters. | |||
| 1. Segment replication is not compatible with [document-level monitors]({{site.url}}{{site.baseurl}}/observing-your-data/alerting/api/#document-level-monitors), which are used with the [Alerting]({{site.url}}{{site.baseurl}}/install-and-configure/plugins/) plugin. The Alerting plugin uses the latest available data on replica shards when using the `immediate` refresh policy, and segment replication can delay the policy's availability, resulting in stale replica shards. | |||
| 1. Segment replication is not compatible with [security analytics]({{site.url}}{{site.baseurl}}/security-analytics/index/). Security analytics uses document-level monitors, which are not compatible with segment replication. | |||
There was a problem hiding this comment.
Should both instances of "Security Analytics" be capitalized as a proper noun?
There was a problem hiding this comment.
Yes, as we're referring to the Security Analytics plugin.
_tuning-your-cluster/availability-and-recovery/segment-replication/index.md
Outdated
Show resolved
Hide resolved
_tuning-your-cluster/availability-and-recovery/segment-replication/index.md
Outdated
Show resolved
Hide resolved
…tion/index.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
…tion/index.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
…tion/index.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
…tion/index.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
|
@natebower Please review the changes made to address comments in lines 27-28 and 103-104. Thanks! |
Signed-off-by: Melissa Vagi <[email protected]>
vagimeli
added a commit
that referenced
this pull request
Sep 19, 2023
#4976) * Update documentation to include alerting and secutiry analytics plugin limitations --------- Signed-off-by: Melissa Vagi <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]>
harshavamsi
pushed a commit
to harshavamsi/documentation-website
that referenced
this pull request
Oct 31, 2023
opensearch-project#4976) * Update documentation to include alerting and secutiry analytics plugin limitations --------- Signed-off-by: Melissa Vagi <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]>
vagimeli
added a commit
that referenced
this pull request
Dec 21, 2023
#4976) * Update documentation to include alerting and secutiry analytics plugin limitations --------- Signed-off-by: Melissa Vagi <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Update segment replication to include alerting plugin limitation
Issues Resolved
#4967
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.