Alice Williams
1dd560977b
* add files back from lost local files Signed-off-by: Alice Williams <[email protected]> * nest reporting CLI under main Reporting page Signed-off-by: Alice Williams <[email protected]> * rough draft examples for AWS Lambda and Cron Signed-off-by: Alice Williams <[email protected]> * better title for cron job report example Signed-off-by: Alice Williams <[email protected]> * for more details from tech reviewer Signed-off-by: Alice Williams <[email protected]> * for better cron job usage description Signed-off-by: Alice Williams <[email protected]> * for more details Signed-off-by: Alice Williams <[email protected]> * remove needs info markers and add links to events doc Signed-off-by: Alice Williams <[email protected]> * more info Signed-off-by: Alice Williams <[email protected]> * more details from demonstration Signed-off-by: Alice Williams <[email protected]> * remove reporting directory to keep both parallel in left nav Signed-off-by: Alice Williams <[email protected]> * small addition Signed-off-by: Alice Williams <[email protected]> * for two configuration settings in the function Signed-off-by: Alice Williams <[email protected]> * more details from eng meeting adding to the steps Signed-off-by: Alice Williams <[email protected]> * more details from eng meeting adding to the steps Signed-off-by: Alice Williams <[email protected]> * for more details Signed-off-by: Alice Williams <[email protected]> * for additional steps to create and test the lambda function Signed-off-by: Alice Williams <[email protected]> * for scheduling reports with lambda Signed-off-by: Alice Williams <[email protected]> * merge redundant set of steps together Signed-off-by: Alice Williams <[email protected]> * for tech review comments Signed-off-by: Alice Williams <[email protected]> * to add download correct title and link Signed-off-by: Alice Williams <[email protected]> * for reporting directory to nest new cli page Signed-off-by: Alice Williams <[email protected]> * un-nest reporting directory Signed-off-by: Alice Williams <[email protected]> * to remove reporting directory - will nest with other page in separate PR Signed-off-by: Alice Williams <[email protected]> * tech review comments and some reorg Signed-off-by: Alice Williams <[email protected]> * for tech review comments Signed-off-by: Alice Williams <[email protected]> * to minor changes Signed-off-by: Alice Williams <[email protected]> * more info about crontab sequence Signed-off-by: Alice Williams <[email protected]> * cron updates Signed-off-by: Alice Williams <[email protected]> * for cron syntax Signed-off-by: Alice Williams <[email protected]> * small updates to lambda proc Signed-off-by: Alice Williams <[email protected]> * for final writer checklist Signed-off-by: Alice Williams <[email protected]> * cron link update Signed-off-by: Alice Williams <[email protected]> * format fix Signed-off-by: Alice Williams <[email protected]> * for doc review cron & lambda sections Signed-off-by: Alice Williams <[email protected]> * for cron reference to man page Signed-off-by: Alice Williams <[email protected]> * add internal link to cron ref Signed-off-by: Alice Williams <[email protected]> * reorg single topic into 7 pages Signed-off-by: Alice Williams <[email protected]> * minor update Signed-off-by: Alice Williams <[email protected]> * link to set ses permissions Signed-off-by: Alice Williams <[email protected]> * for tech review meeting updates Signed-off-by: Alice Williams <[email protected]> * small update Signed-off-by: Alice Williams <[email protected]> * npm download command name changed to remove opensearch prepended name Signed-off-by: Alice Williams <[email protected]> * for new download via artifacts hub Signed-off-by: Alice Williams <[email protected]> * for new download instructions Signed-off-by: Alice Williams <[email protected]> * small fix signature file Signed-off-by: Alice Williams <[email protected]> * typo Signed-off-by: Alice Williams <[email protected]> * for cleaner image Signed-off-by: Alice Williams <[email protected]> * remove image for push commands we won't use Signed-off-by: Alice Williams <[email protected]> --------- Signed-off-by: Alice Williams <[email protected]>
1.3 KiB
1.3 KiB
layout, title, nav_order, parent
| layout | title | nav_order | parent |
|---|---|---|---|
| default | Scheduling reports with the cron utility | 20 | Creating reports with the Reporting CLI |
Scheduling reports with the cron utility
You can use the cron command-line utility to initiate a report request with the Reporting CLI that runs periodically at any date or time interval. Follow the cron expression syntax to specify the date and time that precedes the command that you want to initiate.
To learn about the cron expression syntax, see Cron expression reference. To get help with cron, open the man page by running the following command:
man cron
Prerequisites
- You need a machine with cron installed.
- You need to install the Reporting CLI. See Downloading and installing the Reporting CLI tool
Specifying the report details
Open the crontab editor by running the following command:
crontab -e
In the crontab editor, enter the report request. The following example shows a cron report that runs every day at 8:00 AM:
0 8 * * * opensearch-reporting-cli -u https://playground.opensearch.org/app/dashboards#/view/084aed50-6f48-11ed-a3d5-1ddbf0afc873 -e ses -s <sender_email> -r <recipient_email>