Export and automate PNG, PDF, and CSV reports in OpenSearch Dashboards https://opensearch.org/docs/latest/dashboards/reporting/
Find a file
Craig Perkins 7032eef2cd
Fix maven snapshot publication (#1151)
Signed-off-by: Craig Perkins <cwperx@amazon.com>
2026-01-23 14:20:01 -08:00
.github Increment version to 3.5.0-SNAPSHOT (#1148) 2026-01-23 14:07:47 -08:00
.idea Onboards report-definition and report-instance to resource sharing framework (#1141) 2025-12-10 10:28:31 -08:00
build-tools Upgrade gradle to version 9.2 and Java to version 25 (#1139) 2025-11-24 16:09:22 -08:00
config/checkstyle Backport 2.x to main (#630) 2023-01-10 11:43:46 -08:00
docs Update Doc Links (#127) 2021-07-14 15:05:36 -07:00
gradle/wrapper Upgrade gradle to version 9.2 and Java to version 25 (#1139) 2025-11-24 16:09:22 -08:00
release-notes Add release notes for 3.3.0 (#1125) 2025-10-07 12:32:05 -04:00
scripts Add integtest.sh to specifically run integTestRemote task (#1112) 2025-08-05 07:11:58 -04:00
src Corrects resource-action-groups.yml (#1146) 2025-12-23 09:32:38 -08:00
.classpath Onboards report-definition and report-instance to resource sharing framework (#1141) 2025-12-10 10:28:31 -08:00
.codecov.yml Backport 2.x to main (#630) 2023-01-10 11:43:46 -08:00
.editorconfig Backport 2.x to main (#630) 2023-01-10 11:43:46 -08:00
.gitignore Onboards report-definition and report-instance to resource sharing framework (#1141) 2025-12-10 10:28:31 -08:00
.project Onboards report-definition and report-instance to resource sharing framework (#1141) 2025-12-10 10:28:31 -08:00
.whitesource Add .whitesource configuration file 2022-01-11 19:14:19 +00:00
ADMINS.md level up markdowns and readme (#97) 2021-06-25 16:26:01 -07:00
build.gradle Fix maven snapshot publication (#1151) 2026-01-23 14:20:01 -08:00
CODE_OF_CONDUCT.md Migrate reporting frontend plugin to OpenSearch Dashboards 1.15 (#4) 2021-04-16 14:02:29 -07:00
CONTRIBUTING.md Migrate reporting frontend plugin to OpenSearch Dashboards 1.15 (#4) 2021-04-16 14:02:29 -07:00
detekt.yml Backport 2.x to main (#630) 2023-01-10 11:43:46 -08:00
gradlew Upgrade gradle to version 9.2 and Java to version 25 (#1139) 2025-11-24 16:09:22 -08:00
gradlew.bat Upgrade gradle to version 9.2 and Java to version 25 (#1139) 2025-11-24 16:09:22 -08:00
LICENSE Migrate reporting frontend plugin to OpenSearch Dashboards 1.15 (#4) 2021-04-16 14:02:29 -07:00
MAINTAINERS.md add ani to codeowners and maintainers 2023-05-08 15:45:33 -04:00
NOTICE.txt Update the copyright notices to reflect OpenSearch Contributors (#220) 2021-11-05 11:43:32 -07:00
README.md Updating security reachout email (#1000) 2024-06-20 12:11:48 -04:00
RELEASING.md level up markdowns and readme (#97) 2021-06-25 16:26:01 -07:00
SECURITY.md Updating security reachout email (#1000) 2024-06-20 12:11:48 -04:00
settings.gradle Backport 2.x to main (#630) 2023-01-10 11:43:46 -08:00

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

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.

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 OpenSearch Security directly via email to security@opensearch.org. 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.