Log pre-existing object state when creating an ObjectChange instance #4617

New Issue

adam · 2025-12-29T18:38:19+01:00

adam commented

2025-12-29 18:38:19 +01:00

Originally created by @jeremystretch on GitHub (Mar 3, 2021).

Originally assigned to: @jeremystretch on GitHub.

Environment

Python version: 3.7.9
NetBox version: 2.10.5

Proposed Functionality

When creating a new ObjectChange instance to log a change to a NetBox object, capture its pre-change state as well as its current state. This may take a bit of cleverness to implement, but it should be possible by using a custom signal to register a pre-change copy of data on an instance immediately prior to modifying it.

Use Case

Storing both the pre- and post-change copies of an object allows us to present a more accurate depiction of that changes attributable to a specific action, and not worry about indirect changes not being accounted for. Related issues:

#2511: Provide a diff showing the changes between two logged changes (implemented)
#3451: WebHook should provide old data together with new data
#5583: Unnecessary changelog records for tag add/change/remove

Database Changes

Add a field to the ObjectChange model for storing pre-change data.

External Dependencies

None expected

Originally created by @jeremystretch on GitHub (Mar 3, 2021). Originally assigned to: @jeremystretch on GitHub. ### Environment * Python version: 3.7.9 * NetBox version: 2.10.5 ### Proposed Functionality When creating a new ObjectChange instance to log a change to a NetBox object, capture its pre-change state as well as its current state. This may take a bit of cleverness to implement, but it should be possible by using a custom signal to register a pre-change copy of data on an instance immediately prior to modifying it. ### Use Case Storing both the pre- and post-change copies of an object allows us to present a more accurate depiction of that changes attributable to a specific action, and not worry about indirect changes not being accounted for. Related issues: * #2511: Provide a diff showing the changes between two logged changes (implemented) * #3451: WebHook should provide old data together with new data * #5583: Unnecessary changelog records for tag add/change/remove ### Database Changes Add a field to the ObjectChange model for storing pre-change data. ### External Dependencies None expected

adam added the status: accepted type: feature labels 2025-12-29 18:38:19 +01:00

adam closed this issue

2025-12-29 18:38:19 +01:00

adam commented

2025-12-29 18:38:20 +01:00

@jeremystretch commented on GitHub (Mar 3, 2021):

This is what I've come up with so far: The ObjectChange model has been extended to store both pre- and post-change data. When a request is processed, the responsible view calls snapshot() on the object being modified or deleted, which saves a serialized representation of the object on the object itself generated by the serialize_object() utility. After the change has been made, serialize_object() is called on the object once more to catch the post-change data. Both of these serialized representations are then stored in the new ObjectChange instance.

I'd like to add some GitHub-style diff highlighting to the UI, but the important bits are all there. I also still need to write changelog tests for bulk edit and delete views.

@jeremystretch commented on GitHub (Mar 3, 2021): This is what I've come up with so far: The ObjectChange model has been extended to store both pre- and post-change data. When a request is processed, the responsible view calls `snapshot()` on the object being modified or deleted, which saves a serialized representation of the object on the object itself generated by the `serialize_object()` utility. After the change has been made, `serialize_object()` is called on the object once more to catch the post-change data. Both of these serialized representations are then stored in the new ObjectChange instance. ![Screenshot_2021-03-03 dcim site Site X updated by admin - NetBox](https://user-images.githubusercontent.com/13487278/109878962-f846b000-7c42-11eb-98e7-e9c266d7217f.png) I'd like to add some GitHub-style diff highlighting to the UI, but the important bits are all there. I also still need to write changelog tests for bulk edit and delete views.

adam commented

2025-12-29 18:38:20 +01:00

@jeremystretch commented on GitHub (Mar 4, 2021):

Now with diff highlighting!

I expect we'll put a bit more polish on it in conjunction with the ongoing UI overhaul (#5893) prior to release.

@jeremystretch commented on GitHub (Mar 4, 2021): Now with diff highlighting! ![Screenshot_2021-03-04 ipam prefix 192 0 2 0 24 updated by admin - NetBox](https://user-images.githubusercontent.com/13487278/110009068-80cc5b80-7cea-11eb-908b-31235139fb5a.png) I expect we'll put a bit more polish on it in conjunction with the ongoing UI overhaul (#5893) prior to release.

Sign in to join this conversation.

Branches Tags

main

update-changelog-comments-docs

feature-removal-issue-type

20911-dropdown

20239-plugin-menu-classes-mutable-state

21097-graphql-id-lookups

feature

fix_module_substitution

20923-dcim-templates

20044-elevation-stuck-lightmode

feature-ip-prefix-link

v4.5-beta1-release

20068-import-moduletype-attrs

20766-fix-german-translation-code-literals

20378-del-script

7604-filter-modifiers-v3

circuit-swap

12318-case-insensitive-uniqueness

20637-improve-device-q-filter

20660-script-load

19724-graphql

20614-update-ruff

14884-script

02496-max-page

19720-macaddress-interface-generic-relation

19408-circuit-terminations-export-templates

20203-openapi-check

fix-19669-api-image-download

7604-filter-modifiers

19275-fixes-interface-bulk-edit

fix-17794-get_field_value_return_list

11507-show-aggregate-and-rir-on-api

9583-add_column_specific_search_field_to_tables

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/netbox#4617