generated from amazon-archives/__template_Custom
-
Notifications
You must be signed in to change notification settings - Fork 105
Migrate trace analytics to OpenSearch Dashboards #1
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.
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
Merged
Merged
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
100b59c
Refactor trace analytics for opensearch
joshuali925 47680cf
bump to opensearch 1.15
joshuali925 75d7336
Remove kibana in comments/docs
joshuali925 3ce576d
Update github workflows to opensearch
joshuali925 9e1a5d0
More renaming
joshuali925 1c5f7b8
Remove opendistro in trace analytics
joshuali925 46899b5
Update documents for repo
joshuali925 2d9c9ac
Address comments
joshuali925 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| --- | ||
| name: 🐛 Bug report | ||
| about: Create a report to help us improve | ||
| title: "[BUG]" | ||
| labels: bug | ||
| 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. |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| --- | ||
| 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. |
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,25 @@ | ||
| ## 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 | ||
| [email protected] with any additional questions or comments. | ||
|
|
||
| This code of conduct applies to all spaces provided by the OpenSource project including in code, documentation, issue trackers, mailing lists, chat channels, wikis, blogs, social media and any other communication channels used by the project. | ||
|
|
||
|
|
||
| **Our open source communities endeavor to:** | ||
|
|
||
| * Be Inclusive: We are committed to being a community where everyone can join and contribute. This means using inclusive and welcoming language. | ||
| * Be Welcoming: We are committed to maintaining a safe space for everyone to be able to contribute. | ||
| * Be Respectful: We are committed to encouraging differing viewpoints, accepting constructive criticism and work collaboratively towards decisions that help the project grow. Disrespectful and unacceptable behavior will not be tolerated. | ||
| * Be Collaborative: We are committed to supporting what is best for our community and users. When we build anything for the benefit of the project, we should document the work we do and communicate to others on how this affects their work. | ||
|
|
||
|
|
||
| **Our Responsibility. As contributors, members, or bystanders we each individually have the responsibility to behave professionally and respectfully at all times. Disrespectful and unacceptable behaviors include, but are not limited to:** | ||
|
|
||
| * The use of violent threats, abusive, discriminatory, or derogatory language; | ||
| * Offensive comments related to gender, gender identity and expression, sexual orientation, disability, mental illness, race, political or religious affiliation; | ||
| * Posting of sexually explicit or violent content; | ||
| * The use of sexualized language and unwelcome sexual attention or advances; | ||
| * Public or private harassment of any kind; | ||
| * Publishing private information, such as physical or electronic address, without permission; | ||
| * Other conduct which could reasonably be considered inappropriate in a professional setting; | ||
| * Advocating for or encouraging any of the above behaviors. | ||
| * Enforcement and Reporting Code of Conduct Issues: | ||
|
|
||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be reported. [Contact us](mailto:[email protected]). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. |
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| # Trace Analytics Maintainers | ||
|
|
||
| ## Maintainers | ||
| | Maintainer | GitHub ID | Affiliation | | ||
| |------------------------|---------------------------------------------------|-------------| | ||
| | Anantha Krishna Bhatta | [akbhatta](https://github.com/akbhatta) | Amazon | | ||
| | Anirudha (Ani) Jadhav | [anirudha](https://github.com/anirudha) | Amazon | | ||
| | Charlotte | [CEHENKLE](https://github.com/CEHENKLE) | Amazon | | ||
| | Joshua Li | [joshuali925](https://github.com/joshuali925) | Amazon | | ||
| | Nick Knize | [nknize](https://github.com/nknize) | Amazon | |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,12 @@ | ||
| Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| OpenSearch | ||
| Copyright 2021 OpenSearch Contributors | ||
|
|
||
| This product includes software developed by | ||
| Elasticsearch (http://www.elastic.co). | ||
| Copyright 2009-2018 Elasticsearch | ||
|
|
||
| This product includes software developed by The Apache Software | ||
| Foundation (http://www.apache.org/). | ||
|
|
||
| This product includes software developed by | ||
| Joda.org (http://www.joda.org/). |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| # Open Distro for Elasticsearch Trace Analytics | ||
| # OpenSearch Dashboards Trace Analytics | ||
|
|
||
| The Open Distro for Elasticsearch Trace Analytics plugin provides instant on dashboards in Kibana for users to quickly analyze their logs. The plugin uses aggregated results from two indices, `otel-v1-apm-span-*` and `otel-v1-apm-service-map*` created by the otel-trace-raw-processor and service-map-processor, and renders three main views: | ||
| The OpenSearch Dashboards Trace Analytics plugin provides instant on dashboards in OpenSearch Dashboards for users to quickly analyze their logs. The plugin uses aggregated results from two indices, `otel-v1-apm-span-*` and `otel-v1-apm-service-map*` created by the otel-trace-raw-processor and service-map-processor, and renders three main views: | ||
|
|
||
| 1. Dashboard: an overview of the trace groups and two charts: error rate and throughput. | ||
|
|
||
|
|
@@ -16,21 +16,19 @@ Please see our technical [documentation](https://opendistro.github.io/for-elasti | |
|
|
||
| ## Setup | ||
|
|
||
| 1. Download Elasticsearch for the version that matches the [Kibana version specified in package.json](./package.json#L5). | ||
| 1. Download the Kibana source code for the [version specified in package.json](./package.json#L5) you want to set up. | ||
| 1. Download OpenSearch for the version that matches the [OpenSearch Dashboards version specified in package.json](./package.json#L5). | ||
| 1. Download the OpenSearch Dashboards source code for the [version specified in package.json](./package.json#L5) you want to set up. | ||
|
|
||
| See the [Kibana contributing guide](https://github.com/elastic/kibana/blob/master/CONTRIBUTING.md#setting-up-your-development-environment) for more instructions on setting up your development environment. | ||
|
|
||
| 1. Change your node version to the version specified in `.node-version` inside the Kibana root directory. | ||
| 1. cd into `plugins` directory in the Kibana source code directory. | ||
| 1. Change your node version to the version specified in `.node-version` inside the OpenSearch Dashboards root directory. | ||
| 1. cd into `plugins` directory in the OpenSearch Dashboards source code directory. | ||
| 1. Check out this package from version control into the `plugins` directory. | ||
| 1. Run `yarn kbn bootstrap` inside `kibana/plugins/trace-analytics`. | ||
| 1. Run `yarn osd bootstrap` inside `OpenSearch-Dashboards/plugins/trace-analytics`. | ||
|
|
||
| Ultimately, your directory structure should look like this: | ||
|
|
||
| ```md | ||
| . | ||
| ├── kibana | ||
| ├── OpenSearch-Dashboards | ||
| │ └── plugins | ||
| │ └── trace-analytics | ||
| ``` | ||
|
|
@@ -39,24 +37,22 @@ Ultimately, your directory structure should look like this: | |
|
|
||
| To build the plugin's distributable zip simply run `yarn build`. | ||
|
|
||
| Example output: `./build/opendistroTraceAnalytics-*.zip` | ||
| Example output: `./build/opendistroTraceAnalytics*.zip` | ||
|
||
|
|
||
|
|
||
| ## Run | ||
|
|
||
| - `yarn start` | ||
|
|
||
| Starts Kibana and includes this plugin. Kibana will be available on `localhost:5601`. | ||
|
|
||
| ## Contributing to Open Distro for Elasticsearch Trace Analytics | ||
| Starts OpenSearch Dashboards and includes this plugin. OpenSearch Dashboards will be available on `localhost:5601`. | ||
|
|
||
| We welcome you to get involved in development, documentation, testing the kibana reports plugin. See our [CONTRIBUTING.md](./CONTRIBUTING.md) and join in. | ||
| ## Contributing to OpenSearch Dashboards Trace Analytics | ||
|
|
||
| Since this is a Kibana plugin, it can be useful to review the [Kibana contributing guide](https://github.com/elastic/kibana/blob/master/CONTRIBUTING.md) alongside the documentation around [Kibana plugins](https://www.elastic.co/guide/en/kibana/master/kibana-plugins.html) and [plugin development](https://www.elastic.co/guide/en/kibana/current/plugin-development.html). | ||
| We welcome you to get involved in development, documentation, testing the OpenSearch Dashboards Trace Analytics plugin. See our [CONTRIBUTING.md](./CONTRIBUTING.md) and join in. | ||
|
|
||
| ## Bugs, Enhancements or Questions | ||
|
|
||
| Please file an issue to report any bugs you may find, enhancements you may need or questions you may have [here](https://github.com/opendistro-for-elasticsearch/trace-analytics/issues). | ||
| Please file an issue to report any bugs you may find, enhancements you may need or questions you may have [here](https://github.com/opensearch-project/trace-analytics/issues). | ||
|
|
||
| ## License | ||
|
|
||
|
|
||
This file contains hidden or 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this correct and shouldn't be
traceanalyticsDashboards, @saratvemulapalli