How to track custom events in paper_trail?

Question

I am using paper_trail for audit trail. Along with create, update and delete events I want to track few custom events like view(record), sent(email) etc. How can we introduce such custom events while auditing a model?

score 4 · Accepted Answer · edited Aug 09 '21 at 15:03

4

I have found a tweak to add custom events in paper_trail managed Versions:

Version.create(item_type: "Campaign", item_id: campaign.id, event: "Sent")

Maybe this is not right solution, but it helped me to achieve the goal. I would like to explore paper_trail more to find a better solution.

edited Aug 09 '21 at 15:03

Shepmaster

388,571
95
1,107
1,366

answered Mar 26 '12 at 05:33

Amit Patel

15,609
18
68
106

score 2 · Answer 2 · answered Nov 28 '20 at 14:33

Following the paper trail flow, and having paper trail hooked to your touch events:

record.paper_trail_event = 'notified'
record.touch

If you don't want to have that hook in place you can:

record.versions.create!(event: 'notified')

The main problem with the second approach is that it won't apply any of the PaperTrail scoped params, nor any other dynamic field you may have defined for that model PaperTrail config.

You will need to set those manually. For the request.whodunnit it would be like:

record.versions.create!(event: 'notified', whodunnit: current_user.id)

score 1 · Answer 3 · edited May 23 '17 at 12:01

1

See simple hit counter for page views in rails as an answer to the first part of your question. As for tracking sent mails, you may want to use Observer pattern.

In any case all these events are outside of paper_trail domain. While paper_trail simply creates versions of your model during data changing, what you need is to observe custom event and write to DB all necessary information about that event.

edited May 23 '17 at 12:01

Community

1
1

answered Mar 24 '12 at 14:03

Nash Bridges

2,350
14
19

thanks @nash-bridges, your answer is very useful. I am preparing a prototype application which requires auditing of basic events like create, update, delete as well as some custom events as I mentioned earlier. As paper_clip has nice support of these basic events tracking, I was looking some tweak so I can track custom actions along with basic ones. This arrangement is for time being till I demonstrate the POC to client. – Amit Patel Mar 24 '12 at 17:47

How to track custom events in paper_trail?

3 Answers3