Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/casecommons/pg_audit_log

Create a trigger-based audit log for PostgreSQL
https://github.com/casecommons/pg_audit_log

activerecord audit-log postgresql

Last synced: about 2 months ago
JSON representation

Create a trigger-based audit log for PostgreSQL

Host: GitHub
URL: https://github.com/casecommons/pg_audit_log
Owner: Casecommons
License: mit
Created: 2011-01-17T02:04:07.000Z (almost 14 years ago)
Default Branch: master
Last Pushed: 2024-04-09T17:33:48.000Z (9 months ago)
Last Synced: 2024-04-25T10:02:28.938Z (8 months ago)
Topics: activerecord, audit-log, postgresql
Language: Ruby
Homepage:
Size: 109 KB
Stars: 3
Watchers: 4
Forks: 2
Open Issues: 6
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

# pg_audit_log

[![Build Status](https://secure.travis-ci.org/Casecommons/pg_audit_log.svg?branch=master)](https://travis-ci.org/Casecommons/pg_audit_log)
[![Code Climate](https://img.shields.io/codeclimate/github/Casecommons/pg_audit_log.svg?style=flat)](https://codeclimate.com/github/Casecommons/pg_audit_log)
[![Gem Version](https://img.shields.io/gem/v/pg_audit_log.svg?style=flat)](https://rubygems.org/gems/pg_audit_log)

## Description

PostgreSQL-only database-level audit logging of all databases changes using a completely transparent stored procedure and triggers.
Comes with specs for your project and a rake task to generate the reverse SQL to undo changes logged.

All SQL `INSERT`s, `UPDATE`s, and `DELETE`s will be captured. Record columns that do not change do not generate an audit log entry.

## Installation

- First, enable plpgsql langauges in your postgresql instance. Execute the following as a superuser in postgres make sure your database has plpgsql enabled:

CREATE OR REPLACE PROCEDURAL LANGUAGE plpgsql;

- Generate the appropriate Rails files:

rails generate pg_audit_log:install

- Install the PostgreSQL function and triggers for your project:

rake pg_audit_log:install

## Usage

The PgAuditLog::Entry ActiveRecord model represents a single entry in the audit log table. Each entry represents a single change to a single field of a record in a table. So if you change 3 columns of a record, that will generate 3 corresponding PgAuditLog::Entry records.

You can see the SQL it injects on every query by running with LOG_AUDIT_SQL

### Migrations

TODO

### schema.rb and development_structure.sql

Since schema.rb cannot represent TRIGGERs or FUNCTIONs you will need to set your environment to generate SQL instead of Ruby for your database schema and structure. In your application environment put the following:

config.active_record.schema_format = :sql

And you can generate this sql using:

rake db:structure:dump

## Uninstalling

rake pg_audit_log:uninstall

## Performance

On a 2.93GHz i7 with PostgreSQL 9.1 the audit log has an overhead of about 0.0035 seconds to each `INSERT`, `UPDATE`, or `DELETE`.

## Requirements

- ActiveRecord
- PostgreSQL
- Rails 3.2, 4.x

## LICENSE