Skip to content

Latest commit

 

History

History
156 lines (114 loc) · 12 KB

README.md

File metadata and controls

156 lines (114 loc) · 12 KB
Raw

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.

Code Summary

Reports-Scheduler
Test and build Observability OpenSearch Build CI
Code coverage codecov
Distribution build tests OpenSearch IT tests OpenSearch IT code
Backward compatibility tests BWC tests

Dashboard-Reports
Test and build Observability Dashboards CI
Code coverage codecov
Distribution build tests cypress tests cypress code

Repository Checks
DCO Checker Developer certificate of origin
Link Checker Link Checker

Issues
good first issues open
features open
enhancements open
bugs open
untriaged open
nolabel open

Documentation

Please see our technical documentation to learn more about its features.

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.

Notifications Integration

OpenSearch Dashboards Reports integration with Notifications is currently in progress. Tracking here

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.

Missing Font Dependencies

Chromium may not have all of the dependencies you may require to be able to view all of the content of your reports.

If you are using a CentOS/RHEL system, install the following packages:

If you are using a Ubuntu/Debian system, install the following packages:

The installation command for both systems can be found here.

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 [email protected] 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 OpenSearch Contributors. See NOTICE for details.