search

opensearch-project / dashboards-reporting

Apache License 2.0
9 stars 33 forks source link

readme

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

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 & Forum

Please see our technical documentation to learn more about its features. For additional help with the plugin, including questions about opening an issue, try the OpenSearch Forum.

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

Please see developer guide.

Notifications Integration

OpenSearch Dashboards Reports integration with Notifications is currently in progress. Tracking 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 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 OpenSearch Contributors. See NOTICE for details.