diff --git a/.github/ISSUE_TEMPLATE/BUG_TEMPLATE.md b/.github/ISSUE_TEMPLATE/BUG_TEMPLATE.md new file mode 100644 index 000000000..29eddb95e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG_TEMPLATE.md @@ -0,0 +1,31 @@ +--- +name: 🐛 Bug report +about: Create a report to help us improve +title: '[BUG]' +labels: 'bug, untriaged' +assignees: '' +--- + +**What is the bug?** +A clear and concise description of the bug. + +**How can one reproduce the bug?** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**What is the expected behavior?** +A clear and concise description of what you expected to happen. + +**What is your host/environment?** + - OS: [e.g. iOS] + - Version [e.g. 22] + - Plugins + +**Do you have any screenshots?** +If applicable, add screenshots to help explain your problem. + +**Do you have any additional context?** +Add any other context about the problem. diff --git a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST_TEMPLATE.md b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..19b01d9f9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST_TEMPLATE.md @@ -0,0 +1,18 @@ +--- +name: 🎆 Feature request +about: Request a feature in this project +title: '[FEATURE]' +labels: enhancement +assignees: '' +--- +**Is your feature request related to a problem?** +A clear and concise description of what the problem is, e.g. _I'm always frustrated when [...]_ + +**What solution would you like?** +A clear and concise description of what you want to happen. + +**What alternatives have you considered?** +A clear and concise description of any alternative solutions or features you've considered. + +**Do you have any additional context?** +Add any other context or screenshots about the feature request here. \ No newline at end of file diff --git a/.github/bug_template.md b/.github/bug_template.md deleted file mode 100644 index 05d275f3e..000000000 --- a/.github/bug_template.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -name: 🐛 Bug report -about: Create a report to help us improve -title: "[BUG]" -labels: 'bug, untriaged, Beta' -assignees: '' ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Plugins** -Please list all plugins currently enabled. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Host/Environment (please complete the following information):** - - OS: [e.g. iOS] - - Version [e.g. 22] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/feature_request_template.md b/.github/feature_request_template.md deleted file mode 100644 index 5713d7aa9..000000000 --- a/.github/feature_request_template.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -name: 🎆 Feature request -about: Suggest an idea for this project -title: '' -labels: enhancement -assignees: '' ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/workflows/links.yml b/.github/workflows/links.yml new file mode 100644 index 000000000..dd59cc70e --- /dev/null +++ b/.github/workflows/links.yml @@ -0,0 +1,23 @@ +name: Link Checker +on: + push: + branches: [ main ] + pull_request: + branches: [ main ] + +jobs: + linkchecker: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + - name: lychee Link Checker + id: lychee + uses: lycheeverse/lychee-action@master + with: + args: --accept=200,403,429 "**/*.html" "**/*.md" "**/*.txt" + env: + GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} + - name: Fail if there were link errors + run: exit ${{ steps.lychee.outputs.exit_code }} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 294a74b13..bd65155fb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,134 +1,2 @@ -# Contributing Guidelines - -Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional -documentation, we greatly value feedback and contributions from our community. - -Please read through this document before submitting any issues or pull requests to ensure we have all the necessary -information to effectively respond to your bug report or contribution. - - -## Reporting Bugs/Feature Requests - -We welcome you to use the GitHub issue tracker to report bugs or suggest features. - -When filing an issue, please check [existing open](https://github.com/opensearch-project/performance-analyzer-rca/issues), or [recently closed](https://github.com/opensearch-project/performance-analyzer-rca/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already -reported the issue. Please try to include as much information as you can. Details like these are incredibly useful: - -* A reproducible test case or series of steps -* The version of our code being used -* Any modifications you've made relevant to the bug -* Anything unusual about your environment or deployment - - -## Contributing via Pull Requests -Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that: - -1. You are working against the latest source on the *main* branch. -2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already. -3. You open an issue to discuss any significant work - we would hate for your time to be wasted. - -To send us a pull request, please: - -1. Fork the repository. -2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change. -3. Ensure local tests pass. -4. Commit to your fork using clear commit messages. -5. Send us a pull request, answering any default questions in the pull request interface. -6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation. - -GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and -[creating a pull request](https://help.github.com/articles/creating-a-pull-request/). - -## Developer Certificate of Origin - -We respect intellectual property rights of others and we want to make sure all incoming contributions are correctly attributed and licensed. A Developer Certificate of Origin (DCO) is a lightweight mechanism to do that. - -The DCO is a declaration attached to every contribution made by every developer. In the commit message of the contribution, the developer simply adds a `Signed-off-by` statement and thereby agrees to the DCO, which you can find below or at [DeveloperCertificate.org](http://developercertificate.org/). - -``` -Developer's Certificate of Origin 1.1 -By making a contribution to this project, I certify that: -(a) The contribution was created in whole or in part by me and I - have the right to submit it under the open source license - indicated in the file; or -(b) The contribution is based upon previous work that, to the - best of my knowledge, is covered under an appropriate open - source license and I have the right under that license to - submit that work with modifications, whether created in whole - or in part by me, under the same open source license (unless - I am permitted to submit under a different license), as - Indicated in the file; or -(c) The contribution was provided directly to me by some other - person who certified (a), (b) or (c) and I have not modified - it. -(d) I understand and agree that this project and the contribution - are public and that a record of the contribution (including - all personal information I submit with it, including my - sign-off) is maintained indefinitely and may be redistributed - consistent with this project or the open source license(s) - involved. - ``` -We require that every contribution is signed with a Developer Certificate of Origin. Additionally, please use your real name. We do not accept anonymous contributors nor those utilizing pseudonyms. - -Each commit must include a DCO which looks like this - -``` -Signed-off-by: Jane Smith -``` -You may type this line on your own when writing your commit messages. However, if your user.name and user.email are set in your git configs, you can use `-s` or `– – signoff` to add the `Signed-off-by` line to the end of the commit message. - -## Finding contributions to work on -Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/opensearch-project/performance-analyzer-rca/labels/help%20wanted) issues is a great place to start. - -## Testing your changes - -### To run all tests -```shell script -./gradlew test -``` -### To run tests for the rca package only -```shell script - ./gradlew rcaTest -``` -### To run a specific test -``` -./gradlew test --tests . - -e.g. -./gradlew test --tests RCASchedulerTaskTests.getLocallyExecutableNodes -``` - -### Adding your own tests -- You can add a unit tests using the junit framework -- There is also a mechanism to add integration tests for the RCA framework. For details, please - see [here](docs/gauntlet.md). - -Before submitting the PR, we request that you also run -```shell script -./gradlew build -``` -This validates the code coverage. - -### Code coverage -If you want to check the code coverage, you can consider these steps -1. ./gradlew test -2. ./gradlew jacocoTestReport -3. then point your browser to `performance-analyzer-rca/build/reports/jacoco/test/html/index.html` - -We request that for the new source code that you add, the coverage is at least `80 %`. - -## Code of Conduct -This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct). -For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact -opensource-codeofconduct@amazon.com with any additional questions or comments. - - -## Security issue notifications -If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue. - - -## Licensing - -See the [LICENSE](https://github.com/opensearch-project/performance-analyzer-rca/blob/master/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution. - -We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes. +OpenSearch is a community project that is built and maintained by people just like **you**. +[This document](https://github.com/opensearch-project/.github/blob/main/CONTRIBUTING.md) explains how you can contribute to this and related projects. \ No newline at end of file diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md deleted file mode 100644 index f403e77b5..000000000 --- a/CONTRIBUTORS.md +++ /dev/null @@ -1,19 +0,0 @@ -Contributors (Ordered by last name): - -Adithya Chandra - -Ruizhen Guo - -Palash Hedau - -Balaji Kannan - -Partha Kanuparthy - -Prachi Kumar - -Karthik Kumarguru - -Pardeep Singh - -Joydeep Sinha diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md new file mode 100644 index 000000000..5041152b7 --- /dev/null +++ b/DEVELOPER_GUIDE.md @@ -0,0 +1,39 @@ +- [Developer Guide](#developer-guide) + - [Forking and Cloning](#forking-and-cloning) + - [Install Prerequisites](#install-prerequisites) + - [JDK 14](#jdk-14) + - [Building](#building) + - [Using IntelliJ IDEA](#using-intellij-idea) + - [Submitting Changes](#submitting-changes) + +## Developer Guide + +So you want to contribute code to this project? Excellent! We're glad you're here. Here's what you need to do. + +### Forking and Cloning + +Fork this repository on GitHub, and clone locally with `git clone`. + +### Install Prerequisites + +#### JDK 14 + +OpenSearch components build using Java 14 at a minimum. This means you must have a JDK 14 installed with the environment variable `JAVA_HOME` referencing the path to Java home for your JDK 14 installation, e.g. `JAVA_HOME=/usr/lib/jvm/jdk-14`. + +### Building + +To build from the command line, use `./gradlew`. + +``` +./gradlew clean +./gradlew build +./gradlew publishToMavenLocal +``` + +### Using IntelliJ IDEA + +Launch Intellij IDEA, choose **Import Project**, and select the `build.gradle` file in the root of this package. + +### Submitting Changes + +See [CONTRIBUTING](CONTRIBUTING.md). \ No newline at end of file diff --git a/MAINTAINERS.md b/MAINTAINERS.md index 8a0c643cc..a99b00771 100644 --- a/MAINTAINERS.md +++ b/MAINTAINERS.md @@ -1,14 +1,12 @@ -# Performance Analyzer RCA plugin Maintainers +# OpenSearch Performance Analyzer RCA Maintainers ## Maintainers -| Maintainer | GitHub ID | Affiliation | -| --------------- | --------- | ----------- | -| Joshua Tokle | [jotok](https://github.com/jotok) | Amazon | -| Sruti Parthiban | [sruti1312](https://github.com/sruti1312) | Amazon | -| Haoru Xiao | [hxiao608](https://github.com/hxiao608) | Amazon | -| Ricardo L. Stephen | [ricardolstephen](https://github.com/ricardolstephen) | Amazon | -| Yujia Sun | [yujias0706](https://github.com/yujias0706) | Amazon | -| Kunal Khatua | [kkhatua](https://github.com/kkhatua) | Amazon | +| Maintainer | GitHub ID | Affiliation | +| ----------------------- | ------------------------------------------------------- | ----------- | +| Joshua Tokle | [jotok](https://github.com/jotok) | Amazon | +| Kunal Khatua | [kkhatua](https://github.com/kkhatua) | Amazon | +| Ruizhen Guo | [rguo-aws](https://github.com/rguo-aws) | Amazon | +| Sruti Parthiban | [sruti1312](https://github.com/sruti1312) | Amazon | +| Yujia Sun | [yujias0706](https://github.com/yujias0706) | Amazon | - -**Note:** Affiliations are tracked as during time of their contributions, and might be out-of-date. \ No newline at end of file +[This document](https://github.com/opensearch-project/.github/blob/main/MAINTAINERS.md) explains what maintainers do in this repo, and how they should be doing it. If you're interested in contributing, see [CONTRIBUTING](CONTRIBUTING.md). diff --git a/README.md b/README.md index 2ef621e21..0e41b9c25 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,26 @@ [![Java CI](https://github.com/opensearch-project/performance-analyzer-rca/workflows/Java%20CI/badge.svg)](https://github.com/opensearch-project/performance-analyzer-rca/actions?query=workflow%3A%22Java+CI%22) -[![codecov](https://codecov.io/gh/opensearch-project/performance-analyzer-rca/branch/master/graph/badge.svg)](https://codecov.io/gh/opensearch-project/performance-analyzer-rca) -[![Documentation](https://img.shields.io/badge/api-reference-blue.svg)](https://docs-beta.opensearch.org/docs/pa/reference/) +[![codecov](https://codecov.io/gh/opensearch-project/performance-analyzer-rca/branch/main/graph/badge.svg)](https://codecov.io/gh/opensearch-project/performance-analyzer-rca) +[![Documentation](https://img.shields.io/badge/api-reference-blue.svg)](https://docs-beta.opensearch.org/monitoring-plugins/pa/reference/) [![Chat](https://img.shields.io/badge/chat-on%20forums-blue)](https://discuss.opendistrocommunity.dev/c/performance-analyzer/) ![PRs welcome!](https://img.shields.io/badge/PRs-welcome!-success) -## Performance Analyzer RCA + + + + +- [OpenSearch Performance Analyzer RCA](#opensearch-performace-analyzer-rca) +- [RCA Overview](#rca-overview) +- [Design RFC](#design-rfc) +- [Documentation](#documentation) +- [Contributing](#contributing) +- [Code of Conduct](#code-of-conduct) +- [Security](#security) +- [License](#license) +- [Copyright](#copyright) + + + +## OpenSearch Performance Analyzer RCA The Performance Analyzer RCA is a framework that builds on the Performance Analyzer engine to support Root Cause Analysis (RCA) of performance and reliability problems in OpenSearch @@ -166,23 +182,26 @@ Please refer to the [Install Guide](./INSTALL.md) for detailed information on bu * We don't have 100% unit test coverage yet and will continue to add new unit tests. * We have tested and verified RCA artifacts only for Docker images. Other distributions are yet to be built and tested and will be available as a part of the final release. -## Contribute -We invite developers from the larger Open Distro community to contribute and help improve test coverage and give us feedback on where improvements can be made in design, code and documentation. You can look at [Contributing.md](./CONTRIBUTING.md) for more information on how to contribute. +## Documentation -## Code of Conduct +Please refer to the [technical documentation](https://docs-beta.opensearch.org/monitoring-plugins/pa/index/) for detailed information on installing and configuring Performance Analyzer. -This project has adopted an [Open Source Code of Conduct](https://opensearch.org/codeofconduct.html). +## Contributing +See [developer guide](DEVELOPER_GUIDE.md) and [how to contribute to this project](CONTRIBUTING.md). -## Security Issue Notifications +## Code of Conduct -If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public GitHub issue. +This project has adopted the [Amazon Open Source Code of Conduct](CODE_OF_CONDUCT.md). For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq), or contact [opensource-codeofconduct@amazon.com](mailto:opensource-codeofconduct@amazon.com) with any additional questions or comments. +## Security + +If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public GitHub issue. ## License -This library is licensed under the Apache 2.0 License. +This project is licensed under the [Apache v2.0 License](LICENSE.txt). ## Copyright -Copyright 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved. +Copyright 2020-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved. diff --git a/RELEASING.md b/RELEASING.md new file mode 100644 index 000000000..4808a6be1 --- /dev/null +++ b/RELEASING.md @@ -0,0 +1,3 @@ +## Releasing + +This project follows [OpenSearch branching, labelling, and releasing](https://github.com/opensearch-project/.github/blob/main/RELEASING.md). diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 000000000..0b85ca04e --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,3 @@ +## Reporting a Vulnerability + +If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/) or directly via email to aws-security@amazon.com. Please do **not** create a public GitHub issue. \ No newline at end of file diff --git a/docs/gauntlet.md b/docs/gauntlet.md index 84761b4ec..693e943da 100644 --- a/docs/gauntlet.md +++ b/docs/gauntlet.md @@ -85,7 +85,7 @@ Let's see an example: metrics class that you specify, should have a `static final` field called `NAME` (`CPU_Utilization`) and that will be used to determine the name of the metric table. - _dimensionNames_ : For the dimension names for a metric, please refer to the docs -[here](https://docs-beta.opensearch.org/docs/pa/reference/). Each of the dimension +[here](https://docs-beta.opensearch.org/monitoring-plugins/pa/reference/). Each of the dimension will be a column in the rca.sqlite table. - _tables_ : This specifies one or more table(s). The table should be a 5 second snapshot of the metrics, similar to what exists in metricsdb files. The table is an array type diff --git a/rfc-rca.pdf b/rfc-rca.pdf deleted file mode 100644 index 7e8665845..000000000 Binary files a/rfc-rca.pdf and /dev/null differ diff --git a/src/main/java/org/opensearch/performanceanalyzer/rca/README.md b/src/main/java/org/opensearch/performanceanalyzer/rca/README.md index 9d2e125df..8c2d61c90 100644 --- a/src/main/java/org/opensearch/performanceanalyzer/rca/README.md +++ b/src/main/java/org/opensearch/performanceanalyzer/rca/README.md @@ -19,7 +19,7 @@ will run through the entirety of this discussion. ### Metrics ### This is the input to the system. These are essentially key-value pairs. For details on what metrics are available, please take a look at the online - reference [here](https://docs-beta.opensearch.org/docs/pa/reference/). + reference [here](https://docs-beta.opensearch.org/monitoring-plugins/pa/reference/). ### Symptoms ### diff --git a/src/main/java/org/opensearch/performanceanalyzer/rca/store/rca/temperature/README.md b/src/main/java/org/opensearch/performanceanalyzer/rca/store/rca/temperature/README.md index 26326e1f5..b2ee91d90 100644 --- a/src/main/java/org/opensearch/performanceanalyzer/rca/store/rca/temperature/README.md +++ b/src/main/java/org/opensearch/performanceanalyzer/rca/store/rca/temperature/README.md @@ -16,7 +16,7 @@ node and cluster) based on resource utilization. ### Temperature RCA Graph construction Temperature along each dimension is contributed by a shard-dependent and a shard-independent components. For all the metrics - [here](https://docs-beta.opensearch.org/docs/pa/reference/), the metrics that + [here](https://docs-beta.opensearch.org/monitoring-plugins/pa/reference/), the metrics that have shardID as dimension will have a shard contributed factor to the temperature along that dimension. But that metric also might have a factor that is shard independent. For example , _CPU_utilization_, has a shard dependent components for the CPU that is spent for various