Module: Provenance

Defined in:
lib/provenance.rb,
lib/provenance/context.rb,
lib/provenance/journal.rb,
lib/provenance/version.rb,
lib/provenance/configuration.rb,
lib/provenance/transaction_key.rb,
lib/provenance/trackers/auditable.rb,
lib/provenance/trackers/providers.rb,
lib/provenance/trackers/trackable.rb,
lib/provenance/trackers/bulk_operations.rb,
lib/provenance/trackers/error_reporting.rb

Overview

Provenance is a self-contained audit trail for Rails applications. It records user actions and model changes, sanitizes sensitive data and ships the resulting events to any sink you configure through audit hooks.

Defined Under Namespace

Modules: Auditable, ErrorReporting, Trackable, Trackers, TransactionKey Classes: Configuration, Context, Error, Journal

Constant Summary collapse

VERSION = 
"1.0.0"

Class Method Summary collapse

Class Method Details

.config ⇒ Object 



32
33
34
 
# File 'lib/provenance.rb', line 32

def config
  @config ||= Configuration.new
end

.configure {|config| ... } ⇒ Object

Yields:



28
29
30
 
# File 'lib/provenance.rb', line 28

def configure
  yield config
end

.setup_origin_ip_provider(provider) ⇒ Object 



48
49
50
 
# File 'lib/provenance.rb', line 48

def setup_origin_ip_provider(provider)
  config.origin_ip_provider = provider
end

.setup_remote_ip_provider(provider) ⇒ Object 



44
45
46
 
# File 'lib/provenance.rb', line 44

def setup_remote_ip_provider(provider)
  config.remote_ip_provider = provider
end

.setup_roles_provider(provider) ⇒ Object 



40
41
42
 
# File 'lib/provenance.rb', line 40

def setup_roles_provider(provider)
  config.roles_provider = provider
end

.setup_session_id_provider(provider) ⇒ Object 



52
53
54
 
# File 'lib/provenance.rb', line 52

def setup_session_id_provider(provider)
  config.session_id_provider = provider
end

.setup_username_provider(provider) ⇒ Object 



36
37
38
 
# File 'lib/provenance.rb', line 36

def setup_username_provider(provider)
  config.username_provider = provider
end