Adds metrics framework documentation #6393
Merged
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: Gagan Juneja <gjjuneja@amazon.com>
Gaganjuneja
requested review from
hdhalter,
kolchfa-aws,
Naarcha-AWS,
vagimeli,
AMoo-Miki,
natebower and
dlvenable
as code owners
added 3 commits
February 12, 2024 02:22
Signed-off-by: Gagan Juneja <gjjuneja@amazon.com>
Signed-off-by: Gagan Juneja <gjjuneja@amazon.com>
Signed-off-by: Gagan Juneja <gjjuneja@amazon.com>
hdhalter
added
release-notes
|
@reta please take a look. |
reta
reviewed
Feb 13, 2024
reta
reviewed
Feb 13, 2024
reta
reviewed
Feb 13, 2024
Naarcha-AWS
requested changes
Feb 13, 2024
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Andriy Redko <drreta@gmail.com> Signed-off-by: Gagan Juneja <gagandeepjuneja@gmail.com>
Signed-off-by: Gagan Juneja <gjjuneja@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Naarcha-AWS
added
5 - Final Editorial Review
Naarcha-AWS
approved these changes
Feb 14, 2024
|
@Naarcha-AWS and @reta thanks for your help here. |
natebower
reviewed
Feb 15, 2024
There was a problem hiding this comment.
@Naarcha-AWS @Gaganjuneja Please see my comments and changes and let me know if you have any questions. Thanks!
| - OpenSearch [Job Scheduler]({{site.url}}{{site.baseurl}}/monitoring-your-cluster/job-scheduler/index/) plugin provides a framework that you can use to build schedules for common cluster management tasks. |
There was a problem hiding this comment.
Suggested change
| - OpenSearch [Job Scheduler]({{site.url}}{{site.baseurl}}/monitoring-your-cluster/job-scheduler/index/) plugin provides a framework that you can use to build schedules for common cluster management tasks. | |
| - The OpenSearch [Job Scheduler]({{site.url}}{{site.baseurl}}/monitoring-your-cluster/job-scheduler/index/) plugin provides a framework that you can use to build schedules for common cluster management tasks. |
| The metrics framework supports various telemetry solutions through plugins. Use the following instructions to enable the `telemetry-otel` plugin: | ||
|
|
||
|
|
||
| 1. **Publish Interval:** The Metrics Framework can locally aggregate the metrics with unique dimensions about the configured publish interval, and then export those metrics. By default, the interval is 1 minute. However, you be change the interval using the `telemetry.otel.metrics.publish.interval` cluster setting. |
There was a problem hiding this comment.
"dimensions" reads as the wrong word here. Do we mean "information"?
| telemetry.feature.metrics.enabled=true | ||
| ``` | ||
|
|
||
| The metrics framework supports various telemetry solutions through plugins. Use the following instructions to enable the `telemetry-otel` plugin: |
There was a problem hiding this comment.
The two items below do not read as "instructions" (we don't tell the reader to do anything).
Naarcha-AWS
reviewed
Feb 15, 2024
Naarcha-AWS
reviewed
Feb 15, 2024
Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Naarcha-AWS
added
6 - Done but waiting to merge
hdhalter
added
3 - Done
oeyh
pushed a commit
to oeyh/documentation-website
that referenced
this pull request
Mar 14, 2024
* Adds metrics framework documentation Signed-off-by: Gagan Juneja <gjjuneja@amazon.com> * Fixes vale issues Signed-off-by: Gagan Juneja <gjjuneja@amazon.com> * fix issues Signed-off-by: Gagan Juneja <gjjuneja@amazon.com> * Fix dead link issue Signed-off-by: Gagan Juneja <gjjuneja@amazon.com> * Apply suggestions from code review Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Andriy Redko <drreta@gmail.com> Signed-off-by: Gagan Juneja <gagandeepjuneja@gmail.com> * Address review commit Signed-off-by: Gagan Juneja <gjjuneja@amazon.com> * Add formatting fixes and editorial feedback Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --------- Signed-off-by: Gagan Juneja <gjjuneja@amazon.com> Signed-off-by: Gagan Juneja <gagandeepjuneja@gmail.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Gagan Juneja <gjjuneja@amazon.com> Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Andriy Redko <drreta@gmail.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
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
Describe what this change achieves.
Issues Resolved
List any issues this PR will resolve, e.g. Closes [...].
Closes #6338
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.