Skip to content

wazuh/wazuh-indexer-reporting

 
 

Chat Slack Documentation

Welcome!

The Wazuh Indexer is a highly scalable, full-text search and analytics engine. This Wazuh central component indexes and stores alerts generated by the Wazuh server and provides near real-time data search and analytics capabilities.

Wazuh Indexer is an open source fork of OpenSearch.

This repository stores the source code of the Wazuh Indexer Reporting Plugin and its configurations.

Wazuh Indexer Reporting Plugin

Wazuh Indexer Reporting allows ‘Report Owner’ (engineers, including but not limited to developers, DevOps, IT Engineer, and IT admin) export and share reports from Wazuh Dashboard's 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.

Project Resources

Documentation

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

Contributing

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

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

To report a possible vulnerability or security issue you can:

  • Email us to [email protected].
  • Open a new security report under the security tab on this repository.

PLEASE DO NOT OPEN A PUBLIC ISSUE ABOUT SECURITY

We want to protect our community, so please give us time to fix a vulnerability before publishing it.

License

This project is licensed under the AGPL v3.0 License.

Copyright

  • Copyright Wazuh, Inc.

Trademark

OpenSearch is a registered trademark of Amazon Web Services.

OpenSearch includes certain Apache-licensed Elasticsearch code from Elasticsearch B.V. and other source code. Elasticsearch B.V. is not the source of that other source code. ELASTICSEARCH is a registered trademark of Elasticsearch B.V.

Check Wazuh's trademark and Brand policy.

About

Export and automate PNG, PDF, and CSV reports in OpenSearch Dashboards

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Kotlin 92.7%
  • Java 3.6%
  • HTML 3.3%
  • Python 0.4%