Skip to content

Commit

Permalink
Merge pull request #23 from prudhvigodithi/main
Browse files Browse the repository at this point in the history 
Onboard release 2.14.0 and readme update
  • Loading branch information
@prudhvigodithi
prudhvigodithi authored Apr 9, 2024
2 parents 7cd8ea1 + 864c8f6 commit 5b2eb4b
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 32 deletions.
54 changes: 27 additions & 27 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
- `cdk deploy OpenSearchMetrics-Workflow`: To deploy the lambda and step function.
- `cdk deploy OpenSearchMetrics-HostedZone`: T0 deploy the route53 and DNS setup.
- `cdk deploy OpenSearchMetricsNginxReadonly`: To deploy the dashboard read only setup.
- `cdk deploy OpenSearchWAF`: To deploy the AWS WAF for the project ALB's.


## OpenSearch Project Supported Metrics
Expand All @@ -17,11 +18,11 @@

| metric_name | metric_description |
|-------------------------------------|----------------------------------------------------------------------------------------------------------------------------|
| Closed Issues | This metric simply counts the total number of issues that have been closed. |
| Created Issues | Metrics related to created issues on GitHub. |
| Issue Comments | This metric counts the total number of comments made on issues. |
| Negative Reactions | Look for reactions such as 👎 or similar GitHub negative indicators. |
| Positive Reactions | Look for reactions such as 👍 or similar GitHub positive indicators. |
| Closed Issues | The metric that counts the total number of issues that have been closed. |
| Created Issues | The metric that counts the issues created. |
| Issue Comments | The metric that counts the total number of comments made on issues. |
| Negative Reactions | The metric that counts the reactions such as 👎 or similar GitHub negative indicators. |
| Positive Reactions | The metric that counts the reactions such as 👍 or similar GitHub positive indicators. |
| Merged Pull Requests | The metric that counts the total number of pull requests that have been successfully merged. |
| Open Issues | The metric that counts the total number of issues that are currently open and unresolved. |
| Open Pull Requests | The metric that counts the total number of pull requests that are currently open and awaiting review and merge. |
Expand All @@ -36,34 +37,33 @@

### GitHub Label Metrics

| metric_name | metric_description |
|---------------------------------------------|--------------------|
| Issues Grouped by Label | |
| Pull Requests Grouped by Label | |
| Total Number of Open Issues by label | |
| Total Number of Open Pull Requests by label | |
| metric_name | metric_description |
|---------------------------------------------|---------------------------------------------------------------------------------------------------|
| Issues Grouped by Label | The metric that counts the issues associated with a specific label. |
| Pull Requests Grouped by Label | The metric that counts the pull requests associated with a specific label. |

### Release Metrics

| metric_name | metric_description |
|------------------------------|--------------------|
| Release state | |
| Release Branch | |
| Version Increment | |
| Release Notes | |
| Open AutoCut Issues | |
| Open Issues with Release Label | |
| Closed Issues with Release Label | |
| Open Pull Requests with Release Label | |
| Closed Pull Requests with Release Label | |
| metric_name | metric_description |
|---------------------------|----------------------------------------------------------------------------------------------|
| Release state | The metric that shows the state of a release (open or closed). |
| Release Branch | The metric that finds if the release branch is create or not. |
| Version Increment | The metric that finds if the version increment is done or not. |
| Release Notes | The metric that finds if the release notes is created or not. |
| Open AutoCut Issues | The metric that counts the created AUTOCUT issues. |
| Issues with Release Label | The metric that counts the issues (open and closed state) that has the release label. | |
| Pull Requests with Release Label | The metric that counts the pull requests (open and merged state) that has the release label. | |

### OpenSearch Core Metrics

| metric_name | metric_description |
|------------------|--------------------|
| | |
| | |
| | |
| metric_name | metric_description |
|--------------------|------------------------------------|
| Contributions | The GitHub Contributions by Userid |
| Contribution Goals | Goals for number of contributions |
| Flaky tests | Open Issues with label `Flaky` |


### OpenSearch Gradle Check Metrics

## Security

Expand Down
4 changes: 3 additions & 1 deletion src/main/java/org/opensearchmetrics/metrics/release/ReleaseInputs.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@
public enum ReleaseInputs {
VERSION_3_0_0("3.0.0", "open", "main"),
VERSION_2_12_0("2.12.0", "closed", "2.12"),
VERSION_2_13_0("2.13.0", "open", "2.x"),
VERSION_2_13_0("2.13.0", "closed", "2.13"),

VERSION_2_14_0("2.14.0", "open", "2.x"),
VERSION_1_3_15("1.3.15", "closed", "1.3");

private final String version;
Expand Down
12 changes: 8 additions & 4 deletions src/test/java/org/opensearchmetrics/metrics/release/ReleaseInputsTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,32 +12,36 @@ public void testGetVersion() {
assertEquals("3.0.0", ReleaseInputs.VERSION_3_0_0.getVersion());
assertEquals("2.12.0", ReleaseInputs.VERSION_2_12_0.getVersion());
assertEquals("2.13.0", ReleaseInputs.VERSION_2_13_0.getVersion());
assertEquals("2.14.0", ReleaseInputs.VERSION_2_14_0.getVersion());
assertEquals("1.3.15", ReleaseInputs.VERSION_1_3_15.getVersion());
}

@Test
public void testGetState() {
assertEquals("open", ReleaseInputs.VERSION_3_0_0.getState());
assertEquals("closed", ReleaseInputs.VERSION_2_12_0.getState());
assertEquals("open", ReleaseInputs.VERSION_2_13_0.getState());
assertEquals("open", ReleaseInputs.VERSION_2_14_0.getState());
assertEquals("closed", ReleaseInputs.VERSION_2_13_0.getState());
assertEquals("closed", ReleaseInputs.VERSION_1_3_15.getState());
}

@Test
public void testGetBranch() {
assertEquals("main", ReleaseInputs.VERSION_3_0_0.getBranch());
assertEquals("2.12", ReleaseInputs.VERSION_2_12_0.getBranch());
assertEquals("2.x", ReleaseInputs.VERSION_2_13_0.getBranch());
assertEquals("2.13", ReleaseInputs.VERSION_2_13_0.getBranch());
assertEquals("2.x", ReleaseInputs.VERSION_2_14_0.getBranch());
assertEquals("1.3", ReleaseInputs.VERSION_1_3_15.getBranch());
}

@Test
public void testGetAllReleaseInputs() {
ReleaseInputs[] releaseInputs = ReleaseInputs.getAllReleaseInputs();
assertEquals(4, releaseInputs.length);
assertEquals(5, releaseInputs.length);
assertEquals(ReleaseInputs.VERSION_3_0_0, releaseInputs[0]);
assertEquals(ReleaseInputs.VERSION_2_12_0, releaseInputs[1]);
assertEquals(ReleaseInputs.VERSION_2_13_0, releaseInputs[2]);
assertEquals(ReleaseInputs.VERSION_1_3_15, releaseInputs[3]);
assertEquals(ReleaseInputs.VERSION_2_14_0, releaseInputs[3]);
assertEquals(ReleaseInputs.VERSION_1_3_15, releaseInputs[4]);
}
}

0 comments on commit 5b2eb4b

Please sign in to comment.