[![Unit tests](https://github.com/opensearch-project/security-analytics-dashboards-plugin/workflows/Unit%20tests%20workflow/badge.svg)](https://github.com/opensearch-project/security-analytics-dashboards-plugin/actions?query=workflow%3A%22Unit+tests+workflow%22)
[![Integration tests](https://github.com/opensearch-project/security-analytics-dashboards-plugin/workflows/Cypress%20integration%20tests%20workflow/badge.svg)](https://github.com/opensearch-project/security-analytics-dashboards-plugin/actions/workflows/cypress-workflow.yml?query=workflow%3A%22Cypress+integration+tests+workflow%22)
[![codecov](https://codecov.io/gh/opensearch-project/security-analytics-dashboards-plugin/branch/main/graph/badge.svg)](https://codecov.io/gh/opensearch-project/security-analytics-dashboards-plugin)
[![Documentation](https://img.shields.io/badge/doc-reference-blue)](https://opensearch.org/docs/security-analytics-plugin/index/)
[![Forum](https://img.shields.io/badge/chat-on%20forums-blue)](https://discuss.opendistrocommunity.dev/c/Use-this-category-for-all-questions-around-machine-learning-plugins)
![PRs welcome!](https://img.shields.io/badge/PRs-welcome!-success)

<img src="https://opensearch.org/assets/img/opensearch-logo-themed.svg" height="64px">

- [OpenSearch Security Analytics Dashboards Plugin](#opensearch-security-analytics-dashboards-plugin)
- [Documentation](#documentation)
- [Contributing](#contributing)
- [Code of Conduct](#code-of-conduct)
- [Security](#security)
- [License](#license)
- [Copyright](#copyright)

## OpenSearch Security Analytics Dashboards Plugin

The Security Analytics Dashboards plugin lets you manage your [Security Analytics plugin](https://github.com/opensearch-project/security-analytics) to generate critical security insights from existing security event logs (such as firewall logs, windows logs, authentication audit logs, etc.) directly from OpenSearch-Dashboards. Security Analytics is a security information and event management (SIEM) solution for OpenSearch, designed to investigate, detect, analyze, and respond to security threats that can jeopardize the success of businesses and organizations and their online operations. These threats include the potential exposure of confidential data, cyber attacks, and other adverse security events. Security Analytics provides an out-of-the-box solution that installs automatically with any OpenSearch distribution. It includes the tools and features necessary for defining detection parameters, generating alerts, and responding effectively to potential threats.

## Documentation

Please see our [documentation](https://opensearch.org/docs/security-analytics-plugin/index/).

## Contributing

See [developer guide](DEVELOPER_GUIDE.md) and [how to contribute to this project](CONTRIBUTING.md).

## Code of Conduct

This project has adopted the [Amazon Open Source Code of Conduct](CODE_OF_CONDUCT.md). For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq), or contact [opensource-codeofconduct@amazon.com](mailto: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](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public GitHub issue.

## License

This project is licensed under the [Apache v2.0 License](LICENSE).

## Copyright

Copyright OpenSearch Contributors. See [NOTICE](NOTICE) for details.