Skip to content

opensearch-project/reporting

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

81f170d · Jun 30, 2021
Jun 30, 2021
Jun 30, 2021
Jun 25, 2021
May 26, 2021
Jun 30, 2021
Nov 19, 2020
Jun 25, 2021
Apr 16, 2021
Apr 16, 2021
Apr 16, 2021
Jun 25, 2021
Apr 16, 2021
Jun 25, 2021
Jun 25, 2021
Jun 25, 2021

Repository files navigation

OpenSearch Dashboards Reports CI Reports Scheduler CI codecov Documentation PRs welcome!

OpenSearch Dashboards Reports

OpenSearch Dashboards Reports allows ‘Report Owner’ (engineers, including but not limited to developers, DevOps, IT Engineer, and IT admin) export and share reports from OpenSearch Dashboards dashboards, saved search, alerts and visualizations. It helps automate the process of scheduling reports on an on-demand or a periodical basis (on cron schedules as well). Further, it also automates the process of exporting and sharing reports triggered for various alerts. The feature is present in the Dashboard, Discover, and Visualization tabs. We are currently working on integrating Dashboards Reports with Notifications to enable sharing functionality. After the support is introduced, scheduled reports can be sent to (shared with) self or various stakeholders within the organization. These stakeholders include but are not limited to, executives, managers, engineers (developers, DevOps, IT Engineer) in the form of pdf, hyperlinks, csv, excel via various channels such as email, Slack, and Amazon Chime. However, in order to export, schedule and share reports, report owners should have the necessary permissions as defined under Roles and Privileges.

Contributing

We welcome you to get involved in development, documentation, testing the OpenSearch Dashboards reports plugin. See our CONTRIBUTING.md and join in.

Setup & Build

Complete OpenSearch Dashboards Report feature is composed of 2 plugins. Refer to README in each plugin folder for more details.

Notifications Integration

OpenSearch Dashboards Reports integration with Notifications is currently in progress, tracking for the 8/30 OpenSearch 1.1 release.

Troubleshooting

Fail to launch Chromium

There could be two reasons for this problem

  1. You are not having the correct version of headless-chrome matching to the OS that your OpenSearch Dashboards is running. Different versions of headless-chrome can be found here

  2. Missing additional dependencies. Please refer to additional dependencies section to install required dependencies according to your operating system.

Code of Conduct

This project has adopted the Amazon Open Source Code of Conduct. For more information see the Code of Conduct FAQ, or contact opensource-codeofconduct@amazon.com with any additional questions or comments.

Security

If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our vulnerability reporting page. Please do not create a public GitHub issue.

License

See the LICENSE file for our project's licensing. We will ask you to confirm the licensing of your contribution.

Copyright

Copyright 2020-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.