opensearch-docs-cn/_reporting/rep-cli-cron.md

37 lines
1.4 KiB
Markdown
Raw Normal View History

Adds Reporting CLI documentation (#2170) * add files back from lost local files Signed-off-by: Alice Williams <alicejw@amazon.com> * nest reporting CLI under main Reporting page Signed-off-by: Alice Williams <alicejw@amazon.com> * rough draft examples for AWS Lambda and Cron Signed-off-by: Alice Williams <alicejw@amazon.com> * better title for cron job report example Signed-off-by: Alice Williams <alicejw@amazon.com> * for more details from tech reviewer Signed-off-by: Alice Williams <alicejw@amazon.com> * for better cron job usage description Signed-off-by: Alice Williams <alicejw@amazon.com> * for more details Signed-off-by: Alice Williams <alicejw@amazon.com> * remove needs info markers and add links to events doc Signed-off-by: Alice Williams <alicejw@amazon.com> * more info Signed-off-by: Alice Williams <alicejw@amazon.com> * more details from demonstration Signed-off-by: Alice Williams <alicejw@amazon.com> * remove reporting directory to keep both parallel in left nav Signed-off-by: Alice Williams <alicejw@amazon.com> * small addition Signed-off-by: Alice Williams <alicejw@amazon.com> * for two configuration settings in the function Signed-off-by: Alice Williams <alicejw@amazon.com> * more details from eng meeting adding to the steps Signed-off-by: Alice Williams <alicejw@amazon.com> * more details from eng meeting adding to the steps Signed-off-by: Alice Williams <alicejw@amazon.com> * for more details Signed-off-by: Alice Williams <alicejw@amazon.com> * for additional steps to create and test the lambda function Signed-off-by: Alice Williams <alicejw@amazon.com> * for scheduling reports with lambda Signed-off-by: Alice Williams <alicejw@amazon.com> * merge redundant set of steps together Signed-off-by: Alice Williams <alicejw@amazon.com> * for tech review comments Signed-off-by: Alice Williams <alicejw@amazon.com> * to add download correct title and link Signed-off-by: Alice Williams <alicejw@amazon.com> * for reporting directory to nest new cli page Signed-off-by: Alice Williams <alicejw@amazon.com> * un-nest reporting directory Signed-off-by: Alice Williams <alicejw@amazon.com> * to remove reporting directory - will nest with other page in separate PR Signed-off-by: Alice Williams <alicejw@amazon.com> * tech review comments and some reorg Signed-off-by: Alice Williams <alicejw@amazon.com> * for tech review comments Signed-off-by: Alice Williams <alicejw@amazon.com> * to minor changes Signed-off-by: Alice Williams <alicejw@amazon.com> * more info about crontab sequence Signed-off-by: Alice Williams <alicejw@amazon.com> * cron updates Signed-off-by: Alice Williams <alicejw@amazon.com> * for cron syntax Signed-off-by: Alice Williams <alicejw@amazon.com> * small updates to lambda proc Signed-off-by: Alice Williams <alicejw@amazon.com> * for final writer checklist Signed-off-by: Alice Williams <alicejw@amazon.com> * cron link update Signed-off-by: Alice Williams <alicejw@amazon.com> * format fix Signed-off-by: Alice Williams <alicejw@amazon.com> * for doc review cron & lambda sections Signed-off-by: Alice Williams <alicejw@amazon.com> * for cron reference to man page Signed-off-by: Alice Williams <alicejw@amazon.com> * add internal link to cron ref Signed-off-by: Alice Williams <alicejw@amazon.com> * reorg single topic into 7 pages Signed-off-by: Alice Williams <alicejw@amazon.com> * minor update Signed-off-by: Alice Williams <alicejw@amazon.com> * link to set ses permissions Signed-off-by: Alice Williams <alicejw@amazon.com> * for tech review meeting updates Signed-off-by: Alice Williams <alicejw@amazon.com> * small update Signed-off-by: Alice Williams <alicejw@amazon.com> * npm download command name changed to remove opensearch prepended name Signed-off-by: Alice Williams <alicejw@amazon.com> * for new download via artifacts hub Signed-off-by: Alice Williams <alicejw@amazon.com> * for new download instructions Signed-off-by: Alice Williams <alicejw@amazon.com> * small fix signature file Signed-off-by: Alice Williams <alicejw@amazon.com> * typo Signed-off-by: Alice Williams <alicejw@amazon.com> * for cleaner image Signed-off-by: Alice Williams <alicejw@amazon.com> * remove image for push commands we won't use Signed-off-by: Alice Williams <alicejw@amazon.com> --------- Signed-off-by: Alice Williams <alicejw@amazon.com>
2023-02-08 20:52:19 -05:00
---
layout: default
title: Schedule reports with the cron utility
Adds Reporting CLI documentation (#2170) * add files back from lost local files Signed-off-by: Alice Williams <alicejw@amazon.com> * nest reporting CLI under main Reporting page Signed-off-by: Alice Williams <alicejw@amazon.com> * rough draft examples for AWS Lambda and Cron Signed-off-by: Alice Williams <alicejw@amazon.com> * better title for cron job report example Signed-off-by: Alice Williams <alicejw@amazon.com> * for more details from tech reviewer Signed-off-by: Alice Williams <alicejw@amazon.com> * for better cron job usage description Signed-off-by: Alice Williams <alicejw@amazon.com> * for more details Signed-off-by: Alice Williams <alicejw@amazon.com> * remove needs info markers and add links to events doc Signed-off-by: Alice Williams <alicejw@amazon.com> * more info Signed-off-by: Alice Williams <alicejw@amazon.com> * more details from demonstration Signed-off-by: Alice Williams <alicejw@amazon.com> * remove reporting directory to keep both parallel in left nav Signed-off-by: Alice Williams <alicejw@amazon.com> * small addition Signed-off-by: Alice Williams <alicejw@amazon.com> * for two configuration settings in the function Signed-off-by: Alice Williams <alicejw@amazon.com> * more details from eng meeting adding to the steps Signed-off-by: Alice Williams <alicejw@amazon.com> * more details from eng meeting adding to the steps Signed-off-by: Alice Williams <alicejw@amazon.com> * for more details Signed-off-by: Alice Williams <alicejw@amazon.com> * for additional steps to create and test the lambda function Signed-off-by: Alice Williams <alicejw@amazon.com> * for scheduling reports with lambda Signed-off-by: Alice Williams <alicejw@amazon.com> * merge redundant set of steps together Signed-off-by: Alice Williams <alicejw@amazon.com> * for tech review comments Signed-off-by: Alice Williams <alicejw@amazon.com> * to add download correct title and link Signed-off-by: Alice Williams <alicejw@amazon.com> * for reporting directory to nest new cli page Signed-off-by: Alice Williams <alicejw@amazon.com> * un-nest reporting directory Signed-off-by: Alice Williams <alicejw@amazon.com> * to remove reporting directory - will nest with other page in separate PR Signed-off-by: Alice Williams <alicejw@amazon.com> * tech review comments and some reorg Signed-off-by: Alice Williams <alicejw@amazon.com> * for tech review comments Signed-off-by: Alice Williams <alicejw@amazon.com> * to minor changes Signed-off-by: Alice Williams <alicejw@amazon.com> * more info about crontab sequence Signed-off-by: Alice Williams <alicejw@amazon.com> * cron updates Signed-off-by: Alice Williams <alicejw@amazon.com> * for cron syntax Signed-off-by: Alice Williams <alicejw@amazon.com> * small updates to lambda proc Signed-off-by: Alice Williams <alicejw@amazon.com> * for final writer checklist Signed-off-by: Alice Williams <alicejw@amazon.com> * cron link update Signed-off-by: Alice Williams <alicejw@amazon.com> * format fix Signed-off-by: Alice Williams <alicejw@amazon.com> * for doc review cron & lambda sections Signed-off-by: Alice Williams <alicejw@amazon.com> * for cron reference to man page Signed-off-by: Alice Williams <alicejw@amazon.com> * add internal link to cron ref Signed-off-by: Alice Williams <alicejw@amazon.com> * reorg single topic into 7 pages Signed-off-by: Alice Williams <alicejw@amazon.com> * minor update Signed-off-by: Alice Williams <alicejw@amazon.com> * link to set ses permissions Signed-off-by: Alice Williams <alicejw@amazon.com> * for tech review meeting updates Signed-off-by: Alice Williams <alicejw@amazon.com> * small update Signed-off-by: Alice Williams <alicejw@amazon.com> * npm download command name changed to remove opensearch prepended name Signed-off-by: Alice Williams <alicejw@amazon.com> * for new download via artifacts hub Signed-off-by: Alice Williams <alicejw@amazon.com> * for new download instructions Signed-off-by: Alice Williams <alicejw@amazon.com> * small fix signature file Signed-off-by: Alice Williams <alicejw@amazon.com> * typo Signed-off-by: Alice Williams <alicejw@amazon.com> * for cleaner image Signed-off-by: Alice Williams <alicejw@amazon.com> * remove image for push commands we won't use Signed-off-by: Alice Williams <alicejw@amazon.com> --------- Signed-off-by: Alice Williams <alicejw@amazon.com>
2023-02-08 20:52:19 -05:00
nav_order: 20
parent: Reporting using the CLI
grand_parent: Reporting
redirect_from:
- /dashboards/reporting-cli/rep-cli-cron/
Adds Reporting CLI documentation (#2170) * add files back from lost local files Signed-off-by: Alice Williams <alicejw@amazon.com> * nest reporting CLI under main Reporting page Signed-off-by: Alice Williams <alicejw@amazon.com> * rough draft examples for AWS Lambda and Cron Signed-off-by: Alice Williams <alicejw@amazon.com> * better title for cron job report example Signed-off-by: Alice Williams <alicejw@amazon.com> * for more details from tech reviewer Signed-off-by: Alice Williams <alicejw@amazon.com> * for better cron job usage description Signed-off-by: Alice Williams <alicejw@amazon.com> * for more details Signed-off-by: Alice Williams <alicejw@amazon.com> * remove needs info markers and add links to events doc Signed-off-by: Alice Williams <alicejw@amazon.com> * more info Signed-off-by: Alice Williams <alicejw@amazon.com> * more details from demonstration Signed-off-by: Alice Williams <alicejw@amazon.com> * remove reporting directory to keep both parallel in left nav Signed-off-by: Alice Williams <alicejw@amazon.com> * small addition Signed-off-by: Alice Williams <alicejw@amazon.com> * for two configuration settings in the function Signed-off-by: Alice Williams <alicejw@amazon.com> * more details from eng meeting adding to the steps Signed-off-by: Alice Williams <alicejw@amazon.com> * more details from eng meeting adding to the steps Signed-off-by: Alice Williams <alicejw@amazon.com> * for more details Signed-off-by: Alice Williams <alicejw@amazon.com> * for additional steps to create and test the lambda function Signed-off-by: Alice Williams <alicejw@amazon.com> * for scheduling reports with lambda Signed-off-by: Alice Williams <alicejw@amazon.com> * merge redundant set of steps together Signed-off-by: Alice Williams <alicejw@amazon.com> * for tech review comments Signed-off-by: Alice Williams <alicejw@amazon.com> * to add download correct title and link Signed-off-by: Alice Williams <alicejw@amazon.com> * for reporting directory to nest new cli page Signed-off-by: Alice Williams <alicejw@amazon.com> * un-nest reporting directory Signed-off-by: Alice Williams <alicejw@amazon.com> * to remove reporting directory - will nest with other page in separate PR Signed-off-by: Alice Williams <alicejw@amazon.com> * tech review comments and some reorg Signed-off-by: Alice Williams <alicejw@amazon.com> * for tech review comments Signed-off-by: Alice Williams <alicejw@amazon.com> * to minor changes Signed-off-by: Alice Williams <alicejw@amazon.com> * more info about crontab sequence Signed-off-by: Alice Williams <alicejw@amazon.com> * cron updates Signed-off-by: Alice Williams <alicejw@amazon.com> * for cron syntax Signed-off-by: Alice Williams <alicejw@amazon.com> * small updates to lambda proc Signed-off-by: Alice Williams <alicejw@amazon.com> * for final writer checklist Signed-off-by: Alice Williams <alicejw@amazon.com> * cron link update Signed-off-by: Alice Williams <alicejw@amazon.com> * format fix Signed-off-by: Alice Williams <alicejw@amazon.com> * for doc review cron & lambda sections Signed-off-by: Alice Williams <alicejw@amazon.com> * for cron reference to man page Signed-off-by: Alice Williams <alicejw@amazon.com> * add internal link to cron ref Signed-off-by: Alice Williams <alicejw@amazon.com> * reorg single topic into 7 pages Signed-off-by: Alice Williams <alicejw@amazon.com> * minor update Signed-off-by: Alice Williams <alicejw@amazon.com> * link to set ses permissions Signed-off-by: Alice Williams <alicejw@amazon.com> * for tech review meeting updates Signed-off-by: Alice Williams <alicejw@amazon.com> * small update Signed-off-by: Alice Williams <alicejw@amazon.com> * npm download command name changed to remove opensearch prepended name Signed-off-by: Alice Williams <alicejw@amazon.com> * for new download via artifacts hub Signed-off-by: Alice Williams <alicejw@amazon.com> * for new download instructions Signed-off-by: Alice Williams <alicejw@amazon.com> * small fix signature file Signed-off-by: Alice Williams <alicejw@amazon.com> * typo Signed-off-by: Alice Williams <alicejw@amazon.com> * for cleaner image Signed-off-by: Alice Williams <alicejw@amazon.com> * remove image for push commands we won't use Signed-off-by: Alice Williams <alicejw@amazon.com> --------- Signed-off-by: Alice Williams <alicejw@amazon.com>
2023-02-08 20:52:19 -05:00
---
# Schedule reports with the cron utility
Adds Reporting CLI documentation (#2170) * add files back from lost local files Signed-off-by: Alice Williams <alicejw@amazon.com> * nest reporting CLI under main Reporting page Signed-off-by: Alice Williams <alicejw@amazon.com> * rough draft examples for AWS Lambda and Cron Signed-off-by: Alice Williams <alicejw@amazon.com> * better title for cron job report example Signed-off-by: Alice Williams <alicejw@amazon.com> * for more details from tech reviewer Signed-off-by: Alice Williams <alicejw@amazon.com> * for better cron job usage description Signed-off-by: Alice Williams <alicejw@amazon.com> * for more details Signed-off-by: Alice Williams <alicejw@amazon.com> * remove needs info markers and add links to events doc Signed-off-by: Alice Williams <alicejw@amazon.com> * more info Signed-off-by: Alice Williams <alicejw@amazon.com> * more details from demonstration Signed-off-by: Alice Williams <alicejw@amazon.com> * remove reporting directory to keep both parallel in left nav Signed-off-by: Alice Williams <alicejw@amazon.com> * small addition Signed-off-by: Alice Williams <alicejw@amazon.com> * for two configuration settings in the function Signed-off-by: Alice Williams <alicejw@amazon.com> * more details from eng meeting adding to the steps Signed-off-by: Alice Williams <alicejw@amazon.com> * more details from eng meeting adding to the steps Signed-off-by: Alice Williams <alicejw@amazon.com> * for more details Signed-off-by: Alice Williams <alicejw@amazon.com> * for additional steps to create and test the lambda function Signed-off-by: Alice Williams <alicejw@amazon.com> * for scheduling reports with lambda Signed-off-by: Alice Williams <alicejw@amazon.com> * merge redundant set of steps together Signed-off-by: Alice Williams <alicejw@amazon.com> * for tech review comments Signed-off-by: Alice Williams <alicejw@amazon.com> * to add download correct title and link Signed-off-by: Alice Williams <alicejw@amazon.com> * for reporting directory to nest new cli page Signed-off-by: Alice Williams <alicejw@amazon.com> * un-nest reporting directory Signed-off-by: Alice Williams <alicejw@amazon.com> * to remove reporting directory - will nest with other page in separate PR Signed-off-by: Alice Williams <alicejw@amazon.com> * tech review comments and some reorg Signed-off-by: Alice Williams <alicejw@amazon.com> * for tech review comments Signed-off-by: Alice Williams <alicejw@amazon.com> * to minor changes Signed-off-by: Alice Williams <alicejw@amazon.com> * more info about crontab sequence Signed-off-by: Alice Williams <alicejw@amazon.com> * cron updates Signed-off-by: Alice Williams <alicejw@amazon.com> * for cron syntax Signed-off-by: Alice Williams <alicejw@amazon.com> * small updates to lambda proc Signed-off-by: Alice Williams <alicejw@amazon.com> * for final writer checklist Signed-off-by: Alice Williams <alicejw@amazon.com> * cron link update Signed-off-by: Alice Williams <alicejw@amazon.com> * format fix Signed-off-by: Alice Williams <alicejw@amazon.com> * for doc review cron & lambda sections Signed-off-by: Alice Williams <alicejw@amazon.com> * for cron reference to man page Signed-off-by: Alice Williams <alicejw@amazon.com> * add internal link to cron ref Signed-off-by: Alice Williams <alicejw@amazon.com> * reorg single topic into 7 pages Signed-off-by: Alice Williams <alicejw@amazon.com> * minor update Signed-off-by: Alice Williams <alicejw@amazon.com> * link to set ses permissions Signed-off-by: Alice Williams <alicejw@amazon.com> * for tech review meeting updates Signed-off-by: Alice Williams <alicejw@amazon.com> * small update Signed-off-by: Alice Williams <alicejw@amazon.com> * npm download command name changed to remove opensearch prepended name Signed-off-by: Alice Williams <alicejw@amazon.com> * for new download via artifacts hub Signed-off-by: Alice Williams <alicejw@amazon.com> * for new download instructions Signed-off-by: Alice Williams <alicejw@amazon.com> * small fix signature file Signed-off-by: Alice Williams <alicejw@amazon.com> * typo Signed-off-by: Alice Williams <alicejw@amazon.com> * for cleaner image Signed-off-by: Alice Williams <alicejw@amazon.com> * remove image for push commands we won't use Signed-off-by: Alice Williams <alicejw@amazon.com> --------- Signed-off-by: Alice Williams <alicejw@amazon.com>
2023-02-08 20:52:19 -05:00
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]({{site.url}}{{site.baseurl}}/observing-your-data/alerting/cron/). 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]({{site.url}}{{site.baseurl}}/dashboards/reporting-cli/rep-cli-install/)
## 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>
```