Skip to content

Latest commit

 

History

History
119 lines (76 loc) · 6.5 KB

README.md

File metadata and controls

119 lines (76 loc) · 6.5 KB
Raw

ecAudit

tests coverage

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 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.

ecAudit for Cassandra 5.0.<latest> ecAudit for Cassandra 4.1.<latest> ecAudit for Cassandra 4.0.<latest> ecAudit for Cassandra 3.11.<latest>

For a detailed description of compatible Cassandra versions, refer to the Cassandra Compatibility Matrix.

Maintenance

The following flavors of ecAudit are in maintenance mode and will get critical fixes, but no new features.

ecAudit for Cassandra 3.0.<latest>

Archive

The following flavors of ecAudit are no longer maintained.

ecAudit for Cassandra 3.0.11 ecAudit for Cassandra 2.2.<latest>

Setup

Install and configure ecAudit using the setup guide for your Cassandra version.

Upgrade

Upgrade ecAudit using then upgrade guide for your Cassandra version

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.

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.