Adds support for asynchronous gauge metric type #12642

Gaganjuneja · 2024-03-13T18:47:53Z

Description

As part of the #10238 we have added the Metrics Framework. We need to enhance this by adding the support for Gauge type of metrics. Gauge metrics are required to capture point in time snapshot of values.

Related Issues

Resolves #12641

Check List

New functionality includes testing.
- All tests pass
New functionality has been documented.
- New functionality has javadoc added
Failing checks are inspected and point to the corresponding known issue(s) (See: Troubleshooting Failing Builds)
Commits are signed per the DCO using --signoff
Commit changes are listed out in CHANGELOG.md file (See: Changelog)
Public documentation issue/PR created

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

Signed-off-by: Gagan Juneja <gjjuneja@amazon.com>

Gaganjuneja · 2024-03-13T18:51:18Z

@reta, Please take a look. Thanks!

github-actions · 2024-03-13T19:00:53Z

❌ Gradle check result for 1c36fe4: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

github-actions · 2024-03-13T19:04:30Z

❌ Gradle check result for 2a626bb: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

github-actions · 2024-03-13T19:11:41Z

Compatibility status:

Checks if related components are compatible with change 18e0193

Incompatible components

Skipped components

Compatible components

Compatible components: [https://github.com/opensearch-project/custom-codecs.git, https://github.com/opensearch-project/flow-framework.git, https://github.com/opensearch-project/neural-search.git, https://github.com/opensearch-project/cross-cluster-replication.git, https://github.com/opensearch-project/job-scheduler.git, https://github.com/opensearch-project/geospatial.git, https://github.com/opensearch-project/opensearch-oci-object-storage.git, https://github.com/opensearch-project/security-analytics.git, https://github.com/opensearch-project/observability.git, https://github.com/opensearch-project/asynchronous-search.git, https://github.com/opensearch-project/k-nn.git, https://github.com/opensearch-project/reporting.git, https://github.com/opensearch-project/notifications.git, https://github.com/opensearch-project/anomaly-detection.git, https://github.com/opensearch-project/ml-commons.git, https://github.com/opensearch-project/common-utils.git, https://github.com/opensearch-project/sql.git, https://github.com/opensearch-project/index-management.git, https://github.com/opensearch-project/performance-analyzer-rca.git, https://github.com/opensearch-project/alerting.git, https://github.com/opensearch-project/security.git, https://github.com/opensearch-project/performance-analyzer.git]

libs/telemetry/src/main/java/org/opensearch/telemetry/metrics/DefaultMetricsRegistry.java

Signed-off-by: Gagan Juneja <gjjuneja@amazon.com>

Signed-off-by: Gagan Juneja <gagandeepjuneja@gmail.com>

github-actions · 2024-03-14T17:41:46Z

❌ Gradle check result for 4c9768b: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

github-actions · 2024-03-14T17:47:07Z

❌ Gradle check result for 895fc00: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

Signed-off-by: Gagan Juneja <gjjuneja@amazon.com>

github-actions · 2024-03-15T08:45:35Z

✅ Gradle check result for 18e0193: SUCCESS

codecov · 2024-03-15T08:46:49Z

Codecov Report

Attention: Patch coverage is 87.50000% with 1 lines in your changes are missing coverage. Please review.

Project coverage is 71.40%. Comparing base (b15cb0c) to head (18e0193).
Report is 36 commits behind head on main.

Files	Patch %	Lines
...ch/telemetry/metrics/noop/NoopMetricsRegistry.java	0.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main   #12642      +/-   ##
============================================
- Coverage     71.42%   71.40%   -0.02%     
- Complexity    59978    60103     +125     
============================================
  Files          4985     4991       +6     
  Lines        282275   282643     +368     
  Branches      40946    40990      +44     
============================================
+ Hits         201603   201815     +212     
- Misses        63999    64112     +113     
- Partials      16673    16716      +43

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Gaganjuneja · 2024-03-15T08:50:58Z

@reta, I have fixed build errors. Please take a look once and merge. Thanks!

reta · 2024-03-15T12:10:23Z

@reta, I have fixed build errors. Please take a look once and merge. Thanks!

@Gaganjuneja please create a documentation issue (if none exists yet), thank you

opensearch-trigger-bot · 2024-03-15T12:11:26Z

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/OpenSearch/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/OpenSearch/backport-2.x
# Create a new branch
git switch --create backport/backport-12642-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 dfa203aae1184c5a93254a636a6851491d5c4e84
# Push it to GitHub
git push --set-upstream origin backport/backport-12642-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/OpenSearch/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-12642-to-2.x.

reta · 2024-03-15T12:13:19Z

@Gaganjuneja could you also please send manual backport to 2.x, thank you

…2642) * Adds support for asynchronous gauge metric type Signed-off-by: Gagan Juneja <gjjuneja@amazon.com> * Adds change log Signed-off-by: Gagan Juneja <gjjuneja@amazon.com> * incorporate pr comments Signed-off-by: Gagan Juneja <gjjuneja@amazon.com> * fixes build errors Signed-off-by: Gagan Juneja <gjjuneja@amazon.com> --------- Signed-off-by: Gagan Juneja <gjjuneja@amazon.com> Signed-off-by: Gagan Juneja <gagandeepjuneja@gmail.com> Co-authored-by: Gagan Juneja <gjjuneja@amazon.com>

Gaganjuneja · 2024-03-15T12:54:44Z

@reta, I have fixed build errors. Please take a look once and merge. Thanks!

@Gaganjuneja please create a documentation issue (if none exists yet), thank you

Created one - opensearch-project/documentation-website#6694

* Adds support for asynchronous gauge metric type * Adds change log * incorporate pr comments * fixes build errors --------- Signed-off-by: Gagan Juneja <gjjuneja@amazon.com> Signed-off-by: Gagan Juneja <gagandeepjuneja@gmail.com> Co-authored-by: Gagan Juneja <gjjuneja@amazon.com>

…2642) * Adds support for asynchronous gauge metric type Signed-off-by: Gagan Juneja <gjjuneja@amazon.com> * Adds change log Signed-off-by: Gagan Juneja <gjjuneja@amazon.com> * incorporate pr comments Signed-off-by: Gagan Juneja <gjjuneja@amazon.com> * fixes build errors Signed-off-by: Gagan Juneja <gjjuneja@amazon.com> --------- Signed-off-by: Gagan Juneja <gjjuneja@amazon.com> Signed-off-by: Gagan Juneja <gagandeepjuneja@gmail.com> Co-authored-by: Gagan Juneja <gjjuneja@amazon.com>

…2642) * Adds support for asynchronous gauge metric type Signed-off-by: Gagan Juneja <gjjuneja@amazon.com> * Adds change log Signed-off-by: Gagan Juneja <gjjuneja@amazon.com> * incorporate pr comments Signed-off-by: Gagan Juneja <gjjuneja@amazon.com> * fixes build errors Signed-off-by: Gagan Juneja <gjjuneja@amazon.com> --------- Signed-off-by: Gagan Juneja <gjjuneja@amazon.com> Signed-off-by: Gagan Juneja <gagandeepjuneja@gmail.com> Co-authored-by: Gagan Juneja <gjjuneja@amazon.com> Signed-off-by: Shivansh Arora <hishiv@amazon.com>

Adds support for asynchronous gauge metric type

1c36fe4

Signed-off-by: Gagan Juneja <gjjuneja@amazon.com>

Adds change log

2a626bb

Signed-off-by: Gagan Juneja <gjjuneja@amazon.com>

reta reviewed Mar 14, 2024

View reviewed changes

libs/telemetry/src/main/java/org/opensearch/telemetry/metrics/DefaultMetricsRegistry.java Outdated Show resolved Hide resolved

incorporate pr comments

4c9768b

Signed-off-by: Gagan Juneja <gjjuneja@amazon.com>

Gaganjuneja requested a review from nknize as a code owner March 14, 2024 17:30

Merge branch 'main' into main-gauge-type

895fc00

Signed-off-by: Gagan Juneja <gagandeepjuneja@gmail.com>

reta approved these changes Mar 14, 2024

View reviewed changes

fixes build errors

18e0193

Signed-off-by: Gagan Juneja <gjjuneja@amazon.com>

reta self-requested a review March 15, 2024 12:09

reta approved these changes Mar 15, 2024

View reviewed changes

github-actions bot added enhancement Enhancement or improvement to existing feature or request Other Telemetry:Metrics PRs or issues specific to telemetry metrics framework labels Mar 15, 2024

reta merged commit dfa203a into opensearch-project:main Mar 15, 2024
36 checks passed

reta added the backport 2.x Backport to 2.x branch label Mar 15, 2024

opensearch-trigger-bot bot added the backport-failed label Mar 15, 2024

This was referenced Mar 15, 2024

[Backport] [2.x] - Adds support for asynchronous gauge metric type (#12642) #12692

Merged

[DOC] Update Metrics Framework documentation opensearch-project/documentation-website#6694

Closed

BrewTestBot mentioned this pull request Apr 3, 2024

opensearch 2.13.0 Homebrew/homebrew-core#167852

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds support for asynchronous gauge metric type #12642

Adds support for asynchronous gauge metric type #12642

Gaganjuneja commented Mar 13, 2024 •

edited by reta

Loading

Gaganjuneja commented Mar 13, 2024

github-actions bot commented Mar 13, 2024

github-actions bot commented Mar 13, 2024

github-actions bot commented Mar 13, 2024 •

edited

Loading

github-actions bot commented Mar 14, 2024

github-actions bot commented Mar 14, 2024

github-actions bot commented Mar 15, 2024

codecov bot commented Mar 15, 2024 •

edited

Loading

Gaganjuneja commented Mar 15, 2024

reta commented Mar 15, 2024

opensearch-trigger-bot bot commented Mar 15, 2024

reta commented Mar 15, 2024

Gaganjuneja commented Mar 15, 2024

Adds support for asynchronous gauge metric type #12642

Adds support for asynchronous gauge metric type #12642

Conversation

Gaganjuneja commented Mar 13, 2024 • edited by reta Loading

Description

Related Issues

Check List

Gaganjuneja commented Mar 13, 2024

github-actions bot commented Mar 13, 2024

github-actions bot commented Mar 13, 2024

github-actions bot commented Mar 13, 2024 • edited Loading

Compatibility status:

Incompatible components

Skipped components

Compatible components

github-actions bot commented Mar 14, 2024

github-actions bot commented Mar 14, 2024

github-actions bot commented Mar 15, 2024

codecov bot commented Mar 15, 2024 • edited Loading

Codecov Report

Gaganjuneja commented Mar 15, 2024

reta commented Mar 15, 2024

opensearch-trigger-bot bot commented Mar 15, 2024

reta commented Mar 15, 2024

Gaganjuneja commented Mar 15, 2024

Gaganjuneja commented Mar 13, 2024 •

edited by reta

Loading

github-actions bot commented Mar 13, 2024 •

edited

Loading

codecov bot commented Mar 15, 2024 •

edited

Loading