Skip to main content

Keep track of different events and write them down to an audit log.

Project description

Finger Pointing

Finger Pointing

Life, the Universe, and Everything

Keep track of different events and write them down to an audit log.

Mostly Harmless

http://img.shields.io/pypi/v/collective.fingerpointing.svg https://img.shields.io/travis/collective/collective.fingerpointing/master.svg https://img.shields.io/coveralls/collective/collective.fingerpointing/master.svg

Got an idea? Found a bug? Let us know by opening a support ticket.

Don’t Panic

Installation

To enable this package in a buildout-based installation:

  1. Edit your buildout.cfg and add add the following to it:

    [buildout]
    ...
    eggs =
        collective.fingerpointing

After updating the configuration you need to run ‘’bin/buildout’’, which will take care of updating your system.

Go to the ‘Site Setup’ page in a Plone site and click on the ‘Add-ons’ link.

Check the box next to collective.fingerpointing and click the ‘Activate’ button.

Usage

Go to ‘Site Setup’ and select ‘Finger Pointing’ and enable the events you want to keep an eye on.

docs/controlpanel.png

The Finger Pointing control panel configlet.

Finger Pointing will start logging the selected events:

# bin/instance fg
2016-03-01 17:29:29 INFO ZServer HTTP server started at Tue Mar  1 17:29:29 2016
        Hostname: 0.0.0.0
        Port: 8080
2016-03-01 17:29:31 INFO collective.fingerpointing Start logging audit information to audit.log
2016-03-01 17:29:34 INFO Plone OpenID system packages not installed, OpenID support not available
2016-03-01 17:29:37 INFO Zope Ready to handle requests
2016-03-01 17:31:40 INFO collective.fingerpointing user=admin ip=127.0.0.1 action=logged out
2016-03-01 17:31:49 INFO collective.fingerpointing user=admin ip=127.0.0.1 action=logged in

These events are also logged in var/log/audit.log:

2016-03-01 17:31:40,813 - collective.fingerpointing - INFO - user=admin ip=127.0.0.1 action=logged out
2016-03-01 17:31:49,678 - collective.fingerpointing - INFO - user=admin ip=127.0.0.1 action=logged in

The audit log is available through the @@fingerpointing-log view, available in portal_actions for users with the collective.fingerpointing: Show the Log permission.

Share and Enjoy

This package would not have been possible without the contribution of the following people:

You can find an updated list of package contributors on GitHub.

Changelog

1.0b1 (2016-03-09)

  • Add a view for the audit.log file @@fingerpointing-log and link it to portal_actions. [pcdummy, hvelarde]

  • Make control panel configlet accesible to Site Administrator role (closes #18). [hvelarde]

  • Avoid ComponentLookupError when removing a Plone site (fixes #2). [hvelarde]

  • Remove unused plone.directives.form dependency which pulled in Grok packages. [vangheem]

  • Audit information is now logged into a file named audit.log instead of inside the standard event.log. [pcdummy]

  • Package is now compatible with Plone 5. [hvelarde]

  • Ignore errors caused by subscribers trying to access nonexistent registry records when package is still not installed (fixes #1). [hvelarde]

1.0a1 (2015-06-08)

  • Initial release.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

collective.fingerpointing-1.0b1.zip (166.8 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page