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

Documentation and other papercuts for datasource api launch #1530

Merged
merged 1 commit into from
Apr 17, 2023
Merged

Documentation and other papercuts for datasource api launch #1530

merged 1 commit into from
Apr 17, 2023

Conversation

vamsi-amazon
Copy link
Member

@vamsi-amazon vamsi-amazon commented Apr 17, 2023 •
edited

Description

  • Improves documentation for datasource APIs. [Master Key Config, Keystore Config Deprecation]
  • Fixed prometheus integ test failures when running individually.
  • Removed keystore config from doctests.
  • Removed integtest.sh script since keystore config is no longer required.

Issues Resolved

#1477

Check List

  • New functionality includes testing.
    • All tests pass, including unit test, integration test and doctest
  • New functionality has been documented.
    • New functionality has javadoc added
    • New functionality has user manual doc added
  • Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@vamsi-amazon vamsi-amazon force-pushed the datasources-documentation branch 2 times, most recently from cfdeb0d to 520d6d7 Compare April 17, 2023 18:37
@codecov-commenter
Copy link

codecov-commenter commented Apr 17, 2023 •
edited

Codecov Report

Merging #1530 (520d6d7) into main (fbc72a4) will not change coverage.
The diff coverage is n/a.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

@@            Coverage Diff            @@
##               main    #1530   +/-   ##
=========================================
  Coverage     97.18%   97.18%           
  Complexity     4100     4100           
=========================================
  Files           371      371           
  Lines         10448    10448           
  Branches        703      703           
=========================================
  Hits          10154    10154           
  Misses          287      287           
  Partials          7        7
Flag Coverage Δ
sql-engine 97.18% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
...h/sql/datasources/settings/DataSourceSettings.java 0.00% <ø> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@vamsi-amazon vamsi-amazon marked this pull request as ready for review April 17, 2023 19:18
@vamsi-amazon vamsi-amazon linked an issue Apr 17, 2023 that may be closed by this pull request
[Datasource APIS] Documentation and other miscellaneous tasks #1477
Closed
5 tasks
@vamsi-amazon vamsi-amazon self-assigned this Apr 17, 2023
@vamsi-amazon vamsi-amazon added enhancement New feature or request v2.7.0 labels Apr 17, 2023
@vamsi-amazon vamsi-amazon force-pushed the datasources-documentation branch 2 times, most recently from 1846078 to 8ce367c Compare April 17, 2023 19:35
penghuo
penghuo previously approved these changes Apr 17, 2023
View reviewed changes
Yury-Fridlyand
Yury-Fridlyand reviewed Apr 17, 2023
View reviewed changes
integ-test/src/test/java/org/opensearch/sql/ppl/ShowDataSourcesCommandIT.java Outdated
*/
@BeforeClass
protected static void metricGenerationWait() throws InterruptedException {
Thread.sleep(20000);
Copy link
Collaborator

Choose a reason for hiding this comment

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

This will extend CI run for 20 sec just for sleeping few times (few classes). Is it possible to do a conditional sleep? It is necessary to wait more than one time?

Copy link
Member Author

Choose a reason for hiding this comment

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

I need to query prometheus in a loop till it generates metrics.
I can reduce this to 10sec.

Copy link
Collaborator

Choose a reason for hiding this comment

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

It will be great if you can, or consider this to follow-up update:

while (!isMetricsGenerated()) {
  sleep(100);
}

Copy link
Member Author

Choose a reason for hiding this comment

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

will follow up in the next release. Thanks.

rupal-bq
rupal-bq previously approved these changes Apr 17, 2023
View reviewed changes
YANG-DB
YANG-DB previously approved these changes Apr 17, 2023
View reviewed changes
@vamsi-amazon
Documentation and other papercuts for datasource api launch
f77f398 
Signed-off-by: vamsi-amazon <reddyvam@amazon.com>
@vamsi-amazon vamsi-amazon dismissed stale reviews from YANG-DB and rupal-bq via f77f398 April 17, 2023 20:19
@vamsi-amazon vamsi-amazon merged commit fd1d7d8 into opensearch-project:main Apr 17, 2023
13 checks passed
@opensearch-trigger-bot opensearch-trigger-bot bot mentioned this pull request Apr 17, 2023
Merged
opensearch-trigger-bot bot pushed a commit that referenced this pull request Apr 17, 2023
@vamsi-amazon @github-actions
Documentation and other papercuts for datasource api launch (#1530)
fe09f26 
Signed-off-by: vamsi-amazon <reddyvam@amazon.com>
(cherry picked from commit fd1d7d8)
@opensearch-trigger-bot opensearch-trigger-bot bot mentioned this pull request Apr 17, 2023
Merged
opensearch-trigger-bot bot pushed a commit that referenced this pull request Apr 17, 2023
@vamsi-amazon @github-actions
Documentation and other papercuts for datasource api launch (#1530)
5fbf96d 
Signed-off-by: vamsi-amazon <reddyvam@amazon.com>
(cherry picked from commit fd1d7d8)
vamsi-amazon added a commit that referenced this pull request Apr 17, 2023
@opensearch-trigger-bot @vamsi-amazon
Documentation and other papercuts for datasource api launch (#1530) (#…
918c2d3 
…1533)

Signed-off-by: vamsi-amazon <reddyvam@amazon.com>
(cherry picked from commit fd1d7d8)

Co-authored-by: Vamsi Manohar <reddyvam@amazon.com>
vamsi-amazon added a commit that referenced this pull request Apr 17, 2023
@opensearch-trigger-bot @vamsi-amazon
Documentation and other papercuts for datasource api launch (#1530) (#…
74d2d67 
…1534)

Signed-off-by: vamsi-amazon <reddyvam@amazon.com>
(cherry picked from commit fd1d7d8)

Co-authored-by: Vamsi Manohar <reddyvam@amazon.com>
acarbonetto pushed a commit to Bit-Quill/opensearch-project-sql that referenced this pull request Apr 28, 2023
@vamsi-amazon @acarbonetto
Documentation and other papercuts for datasource api launch (opensear…
cacb783 
…ch-project#1530)

Signed-off-by: vamsi-amazon <reddyvam@amazon.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Yury-Fridlyand Yury-Fridlyand Yury-Fridlyand left review comments

@anirudha anirudha anirudha approved these changes

@penghuo penghuo penghuo approved these changes

@YANG-DB YANG-DB YANG-DB left review comments

@rupal-bq rupal-bq rupal-bq left review comments

@ps48 ps48 Awaiting requested review from ps48 ps48 is a code owner

@kavithacm kavithacm Awaiting requested review from kavithacm kavithacm is a code owner

@derek-ho derek-ho Awaiting requested review from derek-ho derek-ho is a code owner

@joshuali925 joshuali925 Awaiting requested review from joshuali925 joshuali925 is a code owner

@dai-chen dai-chen Awaiting requested review from dai-chen dai-chen is a code owner

@mengweieric mengweieric Awaiting requested review from mengweieric mengweieric is a code owner

@MaxKsyunz MaxKsyunz Awaiting requested review from MaxKsyunz MaxKsyunz is a code owner

Assignees

@vamsi-amazon vamsi-amazon

Labels
backport 2.x backport 2.7 enhancement New feature or request v2.7.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Datasource APIS] Documentation and other miscellaneous tasks
7 participants
@vamsi-amazon @codecov-commenter @anirudha @penghuo @YANG-DB @rupal-bq @Yury-Fridlyand