Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Constants added for searchbackpressure rca reader to consume searchbackpressure metrics in shared folder #34

Merged
merged 3 commits into from
Jul 3, 2023
Merged

Constants added for searchbackpressure rca reader to consume searchbackpressure metrics in shared folder #34

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c25f161
Update key metrics to be used by SearchBackPressure Node RCA (Signed-…
CoderJeffrey Jun 26, 2023
cb1fe3e
Additional Comments to explain SEARCHBP_TABLE_NAME and SEARCHBP_TYPE_…
CoderJeffrey Jun 28, 2023
7ffdb89
Update comments to sperate variables (Signed-off-by: Jeffrey Liu uje…
CoderJeffrey Jun 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion src/main/java/org/opensearch/performanceanalyzer/commons/metrics/AllMetrics.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -943,7 +943,9 @@ public enum SearchBackPressureStatsValue implements MetricValue {
SearchBackPressureStatsValue.Constants.SEARCHBP_SEARCH_BACK_PRESSURE_STATS_MODE),
SEARCHBP_SEARCH_BACK_PRESSURE_STATS_SEARCH_TASK_STATS(
SearchBackPressureStatsValue.Constants
.SEARCHBP_SEARCH_BACK_PRESSURE_STATS_SEARCH_TASK_STATS);
.SEARCHBP_SEARCH_BACK_PRESSURE_STATS_SEARCH_TASK_STATS),
SEARCHBP_TABLE_NAME(SearchBackPressureStatsValue.Constants.SEARCHBP_TABLE_NAME),
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are we replicating this information ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

.SEARCHBP_SEARCH_BACK_PRESSURE_STATS_SEARCH_TASK_STATS); change to
.SEARCHBP_SEARCH_BACK_PRESSURE_STATS_SEARCH_TASK_STATS), because it is not the final constants in the list
SEARCHBP_TABLE_NAME(SearchBackPressureStatsValue.Constants.SEARCHBP_TABLE_NAME), use this for easier access and consistent coding style.

SEARCHBP_TYPE_DIM(SearchBackPressureStatsValue.Constants.SEARCHBP_TYPE_DIM);

private final String value;

Expand Down Expand Up @@ -1037,6 +1039,16 @@ public static class Constants {
public static final String SEARCHBP_SEARCH_BACK_PRESSURE_STATS_MODE = "mode";
public static final String SEARCHBP_SEARCH_BACK_PRESSURE_STATS_SEARCH_TASK_STATS =
"searchTaskStats";


/**
* Add SEARCHBP_TABLE_NAME for searchbackpressureRCA to find the corresponding table
*/
public static final String SEARCHBP_TABLE_NAME = "Searchbp_Stats";
/**
* Add SEARCHBP_TYPE_DIM for searchbackpressureRCA to find the cell value for each stats type
*/
public static final String SEARCHBP_TYPE_DIM = "SearchBackPressureStats";
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add some details about the purpose of this ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Resolved in latest commit.
Also paste here for better visibility.

Add SEARCHBP_TABLE_NAME for searchbackpressureRCA to find the corresponding table
Add SEARCHBP_TYPE_DIM for searchbackpressureRCA to find the cell value for each stats type

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@CoderJeffrey can you plz add comments for 2 constants separately?
e.g.

            /**
             * Add SEARCHBP_TABLE_NAME for searchbackpressureRCA to find the corresponding table
             */
            public static final String SEARCHBP_TABLE_NAME = "Searchbp_Stats";
            /**
            * Add SEARCHBP_TYPE_DIM for searchbackpressureRCA to find the cell value for each stats type
            * /
            public static final String SEARCHBP_TYPE_DIM = "SearchBackPressureStats";

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Latest commit added comments for 2 constants separately. Resolved.

}
}

Expand Down
1 change: 1 addition & 0 deletions ...n/java/org/opensearch/performanceanalyzer/commons/metrics/PerformanceAnalyzerMetrics.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ public class PerformanceAnalyzerMetrics {
public static final String sGcInfoPath = "gc_info";
public static final String sMountedPartitionMetricsPath = "mounted_part_space";
public static final String sAdmissionControlMetricsPath = "admission_control_metrics";
public static final String sSearchBackPressureMetricsPath = "search_back_pressure";
public static final String sShardIndexingPressurePath = "shard_indexing_pressure_metrics";
public static final String sKeyValueDelimitor = ":";
public static final String sMetricNewLineDelimitor = System.getProperty("line.separator");
Expand Down
Loading