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.

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

Support configurable timeout #62

Merged
merged 5 commits into from
Feb 28, 2024
Merged

Conversation

rupal-bq
Copy link
Member

Description

  • added configurable timeout

Issues Resolved

#61

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.

Signed-off-by: Rupal Mahajan <[email protected]>
Signed-off-by: Rupal Mahajan <[email protected]>
@rupal-bq
Copy link
Member Author

CI failure not related to this change.

Copy link
Member

@joshuali925 joshuali925 left a comment

Choose a reason for hiding this comment

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

also update the user guide?

src/arguments.js Outdated
@@ -67,7 +67,10 @@ async function getCommandArguments() {
.env(ENV_VAR.EMAIL_NOTE))
.addOption(new Option('--selfsignedcerts <flag>', 'enable or disable self-signed certicates for smtp transport')
.default(DEFAULT_SELF_SIGNED_CERTIFICATES)
.choices(['true', 'false']));
.choices(['true', 'false']))
.addOption(new Option('--timeout <timeout>', 'timeout for generating report')
Copy link
Member

Choose a reason for hiding this comment

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

it might be better to include the unit in the option name (--timeout-ms) or in the description

Signed-off-by: Rupal Mahajan <[email protected]>
@rupal-bq
Copy link
Member Author

also update the user guide?

done

it might be better to include the unit in the option name (--timeout-ms) or in the description

Included timeout unit in description

USER_GUIDE.md Outdated
@@ -41,6 +41,7 @@ Option | Default Value | Valid Options | Environment Variable | Description
--subject | This is an email containing your dashboard report | - | OPENSEARCH_SUBJECT | subject for the email
--note | Hi,\nHere is the latest report! | string or path to text file | OPENSEARCH_EMAIL_NOTE | The email body
--selfsignedcerts | false | true, false | - | enable or disable self-signed certicates for smtp transport
--timeout | 300000ms | - | OPENSEARCH_TIMEOUT | timeout for generating report in ms
Copy link
Member

Choose a reason for hiding this comment

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

the value shouldn't contain ms or does it not matter?

Copy link
Member Author

Choose a reason for hiding this comment

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

Good catch. the value shouldn't contain ms.

@joshuali925 joshuali925 merged commit 0b38c50 into opensearch-project:main Feb 28, 2024
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants