https://github.com/ericsson/ecaudit
Ericsson Audit plug-in for Apache Cassandra
https://github.com/ericsson/ecaudit
audit cassandra hacktoberfest java
Last synced: 24 days ago
JSON representation
Ericsson Audit plug-in for Apache Cassandra
- Host: GitHub
- URL: https://github.com/ericsson/ecaudit
- Owner: Ericsson
- License: apache-2.0
- Created: 2018-08-24T07:49:45.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-04-07T08:21:19.000Z (24 days ago)
- Last Synced: 2025-04-07T08:32:26.271Z (24 days ago)
- Topics: audit, cassandra, hacktoberfest, java
- Language: Java
- Homepage:
- Size: 2.05 MB
- Stars: 44
- Watchers: 13
- Forks: 36
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# ecAudit
[](https://github.com/Ericsson/ecaudit/actions/workflows/test.yml?query=branch%3Amaster)
[](https://codecov.io/gh/Ericsson/ecaudit/branch/master)
With ecAudit you get auditing and query logger functionality for Apache Cassandra 3.0, 3.11, 4.0, 4.1 and 5.0.
Features include:
* Detailed audit records for CQL operations and login attempts
* Customizable audit record format
* Obfuscation of sensitive password information
* Powerful filtering with centralized or local whitelists
* Logger backends with SLF4J/Logback or Chronicle
Example of audit records created by ecAudit:
```
15:42:41.644 - client:'127.0.0.1'|user:'cassandra'|status:'ATTEMPT'|operation:'INSERT INTO ecks.ectbl (partk, clustk, value) VALUES (?, ?, ?)[1, '1', 'valid']'
15:42:41.646 - client:'127.0.0.1'|user:'cassandra'|status:'ATTEMPT'|operation:'SELECT * FROM ecks.ectbl WHERE partk = ?[1]'
15:42:41.650 - client:'127.0.0.1'|user:'cassandra'|status:'ATTEMPT'|operation:'DELETE FROM ecks.ectbl WHERE partk = ?[1]'
15:42:41.651 - client:'127.0.0.1'|user:'cassandra'|status:'ATTEMPT'|operation:'INSERT INTO ecks.ectbl (partk, clustk, value) VALUES (?, ?, ?)[2, '2', 'valid']'
15:42:41.653 - client:'127.0.0.1'|user:'cassandra'|status:'ATTEMPT'|operation:'SELECT * FROM ecks.ectbl WHERE partk = ?[2]'
15:42:41.655 - client:'127.0.0.1'|user:'cassandra'|status:'ATTEMPT'|operation:'DELETE FROM ecks.ectbl WHERE partk = ?[2]'
```
Checkout the detailed [description](doc/description.md) for a more comprehensive list of features, limitations and operational impact.
## Getting Started
ecAudit integrates with Apache Cassandra using its existing plug-in points.
### Download
Official releases of ecAudit can be downloaded from Maven Central.
Get the ecAudit flavor for your Cassandra version.
[](https://central.sonatype.com/search?q=g:com.ericsson.bss.cassandra.ecaudit%20AND%20a:ecaudit_c5.0)
[](https://central.sonatype.com/search?q=g:com.ericsson.bss.cassandra.ecaudit%20AND%20a:ecaudit_c4.1)
[](https://central.sonatype.com/search?q=g:com.ericsson.bss.cassandra.ecaudit%20AND%20a:ecaudit_c4.0)
[](https://central.sonatype.com/search?q=g:com.ericsson.bss.cassandra.ecaudit%20AND%20a:ecaudit_c3.11)
For a detailed description of compatible Cassandra versions, refer to the [Cassandra Compatibility Matrix](doc/cassandra_compatibility.md).
#### Maintenance
The following flavors of ecAudit are in maintenance mode and will get critical fixes, but no new features.
[](https://central.sonatype.com/search?q=g:com.ericsson.bss.cassandra.ecaudit%20AND%20a:ecaudit_c3.0)
#### Archive
The following flavors of ecAudit are no longer maintained.
[](https://central.sonatype.com/search?q=g:com.ericsson.bss.cassandra.ecaudit%20AND%20a:ecaudit_c3.0.11)
[](https://central.sonatype.com/search?q=g:com.ericsson.bss.cassandra.ecaudit%20AND%20a:ecaudit_c2.2)
### Setup
Install and configure ecAudit using the setup guide for your Cassandra version.
* [ecAudit Setup Guide for Cassandra 5.0.\](https://github.com/Ericsson/ecaudit/blob/master/doc/setup.md)
* [ecAudit Setup Guide for Cassandra 4.1.\](https://github.com/Ericsson/ecaudit/blob/release/c4.1/doc/setup.md)
* [ecAudit Setup Guide for Cassandra 4.0.\](https://github.com/Ericsson/ecaudit/blob/release/c4.0/doc/setup.md)
* [ecAudit Setup Guide for Cassandra 3.11.\](https://github.com/Ericsson/ecaudit/blob/release/c3.11/doc/setup.md)
* [ecAudit Setup Guide for Cassandra 3.0.\](https://github.com/Ericsson/ecaudit/blob/release/c3.0/doc/setup.md)
### Upgrade
Upgrade ecAudit using then upgrade guide for your Cassandra version
* [ecAudit Upgrade Guide for Cassandra 5.0.\](https://github.com/Ericsson/ecaudit/blob/master/UPGRADING.md)
* [ecAudit Upgrade Guide for Cassandra 4.1.\](https://github.com/Ericsson/ecaudit/blob/release/c4.1/UPGRADING.md)
* [ecAudit Upgrade Guide for Cassandra 4.0.\](https://github.com/Ericsson/ecaudit/blob/release/c4.0/UPGRADING.md)
* [ecAudit Upgrade Guide for Cassandra 3.11.\](https://github.com/Ericsson/ecaudit/blob/release/c3.11/UPGRADING.md)
* [ecAudit Upgrade Guide for Cassandra 3.0.\](https://github.com/Ericsson/ecaudit/blob/release/c3.0/UPGRADING.md)
## Issues & Contributions
Report an issue if you're having trouble to use ecAudit or have an idea for an improvement.
Want to contribute to ecAudit?
Check out our [contribution guide](CONTRIBUTING.md).
## Credits
The following developers have contributed to the ecAudit project:
* Per Otterström
* Tobias Eriksson
* Laxmikant Upadhyay
* Anuj Wadhera
* Marcus Olsson
* Ted Petersson
* Pushpendra Rajpoot
* Tommy Stendahl
## License
Copyright 2018-23 Telefonaktiebolaget LM Ericsson
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
either express or implied.
See the License for the specific language governing permissions and limitations under the License.