Skip to content

Commit 5ad2e01

Browse files
authored
Migrate trace analytics to OpenSearch Dashboards (opensearch-project#1)
* Refactor trace analytics for opensearch * bump to opensearch 1.15 * Remove kibana in comments/docs * Update github workflows to opensearch * More renaming * Remove opendistro in trace analytics * Update documents for repo * Address comments
1 parent d927a66 commit 5ad2e01

26 files changed

Lines changed: 197 additions & 82 deletions

.cypress/integration/dashboard.spec.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import { delay, setTimeFilter } from '../utils/constants';
1919

2020
describe('Testing dashboard table empty state', () => {
2121
beforeEach(() => {
22-
cy.visit('app/opendistro-trace-analytics#/dashboard');
22+
cy.visit('app/trace-analytics-dashboards#/dashboard');
2323
cy.wait(delay * 3);
2424
});
2525

@@ -31,7 +31,7 @@ describe('Testing dashboard table empty state', () => {
3131

3232
describe('Testing dashboard table', () => {
3333
beforeEach(() => {
34-
cy.visit('app/opendistro-trace-analytics#/dashboard');
34+
cy.visit('app/trace-analytics-dashboards#/dashboard');
3535
setTimeFilter();
3636
});
3737

@@ -85,7 +85,7 @@ describe('Testing dashboard table', () => {
8585

8686
describe('Testing plots', () => {
8787
beforeEach(() => {
88-
cy.visit('app/opendistro-trace-analytics#/dashboard');
88+
cy.visit('app/trace-analytics-dashboards#/dashboard');
8989
setTimeFilter();
9090
});
9191

.cypress/integration/services.spec.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import { delay, setTimeFilter, SERVICE_NAME } from '../utils/constants';
1919

2020
describe('Testing services table empty state', () => {
2121
beforeEach(() => {
22-
cy.visit('app/opendistro-trace-analytics#/services');
22+
cy.visit('app/trace-analytics-dashboards#/services');
2323
cy.wait(delay * 3);
2424
});
2525

@@ -31,7 +31,7 @@ describe('Testing services table empty state', () => {
3131

3232
describe('Testing services table', () => {
3333
beforeEach(() => {
34-
cy.visit('app/opendistro-trace-analytics#/services');
34+
cy.visit('app/trace-analytics-dashboards#/services');
3535
setTimeFilter();
3636
});
3737

@@ -53,7 +53,7 @@ describe('Testing services table', () => {
5353

5454
describe('Testing service view empty state', () => {
5555
beforeEach(() => {
56-
cy.visit(`app/opendistro-trace-analytics#/services/${SERVICE_NAME}`);
56+
cy.visit(`app/trace-analytics-dashboards#/services/${SERVICE_NAME}`);
5757
cy.wait(delay * 3);
5858
});
5959

@@ -66,7 +66,7 @@ describe('Testing service view empty state', () => {
6666

6767
describe('Testing service view', () => {
6868
beforeEach(() => {
69-
cy.visit(`app/opendistro-trace-analytics#/services/${SERVICE_NAME}`);
69+
cy.visit(`app/trace-analytics-dashboards#/services/${SERVICE_NAME}`);
7070
setTimeFilter(undefined, undefined, false);
7171
});
7272

.cypress/integration/traces.spec.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import { delay, setTimeFilter, TRACE_ID, SPAN_ID } from '../utils/constants';
1919

2020
describe('Testing traces table empty state', () => {
2121
beforeEach(() => {
22-
cy.visit('app/opendistro-trace-analytics#/traces');
22+
cy.visit('app/trace-analytics-dashboards#/traces');
2323
cy.wait(delay * 3);
2424
});
2525

@@ -31,7 +31,7 @@ describe('Testing traces table empty state', () => {
3131

3232
describe('Testing traces table', () => {
3333
beforeEach(() => {
34-
cy.visit('app/opendistro-trace-analytics#/traces');
34+
cy.visit('app/trace-analytics-dashboards#/traces');
3535
setTimeFilter();
3636
});
3737

@@ -53,7 +53,7 @@ describe('Testing traces table', () => {
5353

5454
describe('Testing trace view', () => {
5555
beforeEach(() => {
56-
cy.visit(`app/opendistro-trace-analytics#/traces/${TRACE_ID}`);
56+
cy.visit(`app/trace-analytics-dashboards#/traces/${TRACE_ID}`);
5757
cy.wait(delay * 3);
5858
});
5959

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
name: 🐛 Bug report
3+
about: Create a report to help us improve
4+
title: "[BUG]"
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
**Describe the bug**
10+
A clear and concise description of what the bug is.
11+
12+
**To Reproduce**
13+
Steps to reproduce the behavior:
14+
1. Go to '...'
15+
2. Click on '....'
16+
3. Scroll down to '....'
17+
4. See error
18+
19+
**Expected behavior**
20+
A clear and concise description of what you expected to happen.
21+
22+
**Plugins**
23+
Please list all plugins currently enabled.
24+
25+
**Screenshots**
26+
If applicable, add screenshots to help explain your problem.
27+
28+
**Host/Environment (please complete the following information):**
29+
- OS: [e.g. iOS]
30+
- Version [e.g. 22]
31+
32+
**Additional context**
33+
Add any other context about the problem here.
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: 🎆 Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
**Is your feature request related to a problem? Please describe.**
10+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
11+
12+
**Describe the solution you'd like**
13+
A clear and concise description of what you want to happen.
14+
15+
**Describe alternatives you've considered**
16+
A clear and concise description of any alternative solutions or features you've considered.
17+
18+
**Additional context**
19+
Add any other context or screenshots about the feature request here.

.github/workflows/release-workflow.yml

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ on:
77
- 'v*'
88

99
env:
10-
PLUGIN_NAME: opendistroTraceAnalyticsKibana
11-
OD_VERSION: 1.13.0.0-alpha
10+
PLUGIN_NAME: traceanalyticsDashboards
11+
OD_VERSION: 1.15.0.0
1212

1313
jobs:
1414

@@ -25,33 +25,34 @@ jobs:
2525
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
2626
aws-region: us-east-1
2727

28-
- name: Checkout Kibana
28+
# TODO change to opensearch dashboards
29+
- name: Checkout OpenSerach Dashboards
2930
uses: actions/checkout@v1
3031
with:
31-
repository: opendistro-for-elasticsearch/kibana-oss
32-
ref: 7.10.2
33-
token: ${{secrets.OD_ACCESS}}
34-
path: kibana
32+
repository: opensearch-project/Opensearch-Dashboards
33+
ref: 1.x
34+
path: OpenSearch-Dashboards
3535

3636
- name: Checkout Plugin
3737
uses: actions/checkout@v1
3838
with:
39-
path: kibana/plugins/trace-analytics
39+
path: OpenSearch-Dashboards/plugins/trace-analytics
4040

4141
- name: Setup Node
4242
uses: actions/setup-node@v1
4343
with:
4444
node-version: '10.23.1'
4545

46-
- name: Kibana Pluign Bootstrap
46+
- name: Pluign Bootstrap
4747
run: |
48-
yarn kbn bootstrap
48+
yarn osd bootstrap
4949
5050
- name: Build Artifact
5151
run: |
5252
yarn build
5353
mv ./build/*.zip ./build/${{ env.PLUGIN_NAME }}-${{ env.OD_VERSION }}.zip
5454
artifact=`ls ./build/*.zip`
5555
56+
# TODO change to new bucket
5657
aws s3 cp $artifact s3://artifacts.opendistroforelasticsearch.amazon.com/downloads/kibana-plugins/opendistro-trace-analytics/
5758
aws cloudfront create-invalidation --distribution-id ${{ secrets.DISTRIBUTION_ID }} --paths "/downloads/*"

.github/workflows/test-and-build-workflow.yml

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ name: Test and Build Trace Analytics
44
on: [pull_request, push]
55

66
env:
7-
PLUGIN_NAME: opendistroTraceAnalyticsKibana
8-
OD_VERSION: 1.13.0.0-alpha
7+
PLUGIN_NAME: traceanalyticsDashboards
8+
OD_VERSION: 1.15.0.0
99

1010
jobs:
1111

@@ -14,23 +14,24 @@ jobs:
1414
runs-on: ubuntu-latest
1515

1616
steps:
17-
- name: Checkout Kibana
17+
# TODO change to opensearch dashboards
18+
- name: Checkout OpenSerach Dashboards
1819
uses: actions/checkout@v1
1920
with:
20-
repository: elastic/kibana
21-
ref: v7.10.2
22-
path: kibana
21+
repository: opensearch-project/Opensearch-Dashboards
22+
ref: 1.x
23+
path: OpenSearch-Dashboards
2324
- name: Checkout Plugin
2425
uses: actions/checkout@v1
2526
with:
26-
path: kibana/plugins/trace-analytics
27+
path: OpenSearch-Dashboards/plugins/trace-analytics
2728
- name: Setup Node
2829
uses: actions/setup-node@v1
2930
with:
3031
node-version: '10.23.1'
31-
- name: Kibana Pluign Bootstrap
32+
- name: Pluign Bootstrap
3233
run: |
33-
yarn kbn bootstrap
34+
yarn osd bootstrap
3435
- name: Test
3536
run: |
3637
yarn test

CODE_OF_CONDUCT.md

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,25 @@
1-
## Code of Conduct
2-
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
3-
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
4-
opensource-codeofconduct@amazon.com with any additional questions or comments.
1+
2+
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.
3+
4+
5+
**Our open source communities endeavor to:**
6+
7+
* Be Inclusive: We are committed to being a community where everyone can join and contribute. This means using inclusive and welcoming language.
8+
* Be Welcoming: We are committed to maintaining a safe space for everyone to be able to contribute.
9+
* 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.
10+
* 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.
11+
12+
13+
**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:**
14+
15+
* The use of violent threats, abusive, discriminatory, or derogatory language;
16+
* Offensive comments related to gender, gender identity and expression, sexual orientation, disability, mental illness, race, political or religious affiliation;
17+
* Posting of sexually explicit or violent content;
18+
* The use of sexualized language and unwelcome sexual attention or advances;
19+
* Public or private harassment of any kind;
20+
* Publishing private information, such as physical or electronic address, without permission;
21+
* Other conduct which could reasonably be considered inappropriate in a professional setting;
22+
* Advocating for or encouraging any of the above behaviors.
23+
* Enforcement and Reporting Code of Conduct Issues:
24+
25+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported. [Contact us](mailto:opensource-codeofconduct@amazon.com). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances.

LICENSE

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
Apache License
32
Version 2.0, January 2004
43
http://www.apache.org/licenses/
@@ -173,3 +172,30 @@
173172
defend, and hold each Contributor harmless for any liability
174173
incurred by, or claims asserted against, such Contributor by reason
175174
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

MAINTAINERS.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Trace Analytics Maintainers
2+
3+
## Maintainers
4+
| Maintainer | GitHub ID | Affiliation |
5+
|------------------------|---------------------------------------------------|-------------|
6+
| David Cui | [davidcui-amzn](https://github.com/davidcui-amzn) | Amazon |
7+
| Joshua Li | [joshuali925](https://github.com/joshuali925) | Amazon |

0 commit comments

Comments
 (0)