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

Support configurable timeout #62

Merged
merged 5 commits into from
Feb 28, 2024
Merged

Support configurable timeout #62

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d184be5
add configurable timeout
rupal-bq Feb 22, 2024
4bf05b5
Merge branch 'main' into timeout
rupal-bq Feb 22, 2024
8660cdd
fix tests
rupal-bq Feb 23, 2024
44720ab
Add timeout unit
rupal-bq Feb 26, 2024
0994550
Update default timeout in user guide
rupal-bq Feb 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions USER_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Contributor 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.

| - | - | - | CHROMIUM_PATH | path to chromium directory

You can also find this information using help command.
Expand Down
2 changes: 1 addition & 1 deletion src/arguments.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ async function getCommandArguments() {
.addOption(new Option('--selfsignedcerts <flag>', 'enable or disable self-signed certicates for smtp transport')
.default(DEFAULT_SELF_SIGNED_CERTIFICATES)
.choices(['true', 'false']))
.addOption(new Option('--timeout <timeout>', 'timeout for generating report')
.addOption(new Option('--timeout <timeout>', 'timeout for generating report in ms')
.default(DEFAULT_TIMEOUT)
.env(ENV_VAR.TIMEOUT));

Expand Down
2 changes: 1 addition & 1 deletion test/help.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Options:
--subject <subject> email subject (default: "This is an email containing your opensearch dashboard report", env: OPENSEARCH_EMAIL_SUBJECT)
--note <note> email body (string or path to text file) (default: "Hi,\\nHere is the latest report!", env: OPENSEARCH_EMAIL_NOTE)
--selfsignedcerts <flag> enable or disable self-signed certicates for smtp transport (choices: "true", "false", default: false)
--timeout <timeout> timeout for generating report (default: 300000, env: OPENSEARCH_TIMEOUT)
--timeout <timeout> timeout for generating report in ms (default: 300000, env: OPENSEARCH_TIMEOUT)
-h, --help display help for command

Note: The tenant in the url has the higher priority than tenant value provided as command option.
Expand Down
Loading