![Documentation](https://img.shields.io/badge/api-reference-blue.svg)
![Chat](https://img.shields.io/badge/chat-on%20forums-blue)
![PRs welcome!](https://img.shields.io/badge/PRs-welcome!-success)

<img src="https://opensearch.org/assets/brand/SVG/Logo/opensearch_logo_default.svg" height="64px"/>

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

# OpenSearch Security Analytics

The OpenSearch Security Analytics aims to enable you to run security operations by automating threat detection and threat analysis on your data. Security analytics plugin will include a threat detection engine that will be pre-loaded with a set of detection rules, that you can customize and extend to alert on standard or custom attack patterns.

## Highlights

* This open-source framework for analyzing the security events will address the cost and complexity associated with running the security operations on your business and infrastructure data.
* It will enable you to monitor your data, generate findings and send alert notifications automatically to your stakeholders.
* The security analytics dashboards will let you manage your threats, correlate events and take remediation actions.


## Documentation

Please see our [documentation]() [ToDo].

## Contributing

See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.

## 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-2.0 License.

## Copyright

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