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

52 lines
2.1 KiB
Markdown
Raw Permalink 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: Create and request visualization reports
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: 15
parent: Reporting using the CLI
grand_parent: Reporting
redirect_from:
- /dashboards/reporting-cli/rep-cli-create/
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
---
# Create and request visualization reports
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
First, you need to get the URL for the visualization that you want to download as an image file or PDF.
To generate a visualization report, you need to specify the Dashboards URL.
Open the visualization for which you want to generate a report, and select **Share > Permalinks > Generate link as Shapshot > Short URL > Copy link**, as shown in the following image.
![Copy link]({{site.url}}{{site.baseurl}}/images/dashboards/dash-url.png)
You will need to add the URL with the `-u` argument when you request the report in the CLI.
#### Example: Requesting a PNG file
The following command requests a report in PNG format with basic authentication and sends the report to an email address using Amazon SES:
```
opensearch-reporting-cli -u https://localhost:5601/app/dashboards#/view/7adfa750-4c81-11e8-b3d7-01146121b73d -a basic -c admin:Test@1234 -e ses -s <email address> -r <email address> -f png
```
#### Example: Requesting a PDF file
The following command requests a PDF file and specifies the recipient's email address:
```
opensearch-reporting-cli -u https://localhost:5601/app/dashboards#/view/7adfa750-4c81-11e8-b3d7-01146121b73d -a basic -c admin:Test@1234 -e ses -s <email address> -r <email address> -f pdf
```
Upon success, the file will be sent to the specified email address. The following image shows an example PDF report.
![PDF example]({{site.url}}{{site.baseurl}}/images/dashboards/cli-pdf-report.png)
#### Example: Requesting a CSV file
The following command generates a report that contains all table content in CSV format and sends the report to an email address using Amazon SES transport:
```
opensearch-reporting-cli -u https://localhost:5601/app/dashboards#/view/7adfa750-4c81-11e8-b3d7-01146121b73d -f csv -a basic -c admin:Test@1234 -e ses -s <email address> -r <email address>
```
Upon success, the email will be sent to the specified email address with the CSV file attached.