Skip to content

Commit

Permalink
Audit Log Docs (#477)
Browse files Browse the repository at this point in the history
* Audit Log Docs

Audit Log docs + changes to the roll-outs page given the audit logs entries for gradual rollouts

* Updates to Audit Log Docs

- Updated images to reflect new + icon
- explained multiple modification cards on Feature Create
- self-targeting callout
  • Loading branch information
katemacfarlane authored Nov 16, 2023
1 parent 61ee784 commit ce8033f
Show file tree
Hide file tree
Showing 7 changed files with 47 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/extras/advanced-targeting/rollouts.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,4 +74,10 @@ No targets below this one would impact this user in any way.

Additionally, if there is a *rollout* and a variation is being rolled out to a set of users,
and the user qualifies for a target but still has *not received the rollout,*
the user will *still* not receive a later target.
the user will *still* not receive a later target.

:::info

For modifications to or additions of a gradual roll-out, entries in the [Audit Log](/extras/audit-log) will be marked as `Stage 1` and labelled as a `Linear` roll-out.

:::
2 changes: 2 additions & 0 deletions docs/extras/audit-log/_category_.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
label: 'Audit Log'
position: 4
38 changes: 38 additions & 0 deletions docs/extras/audit-log/audit-log.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: Audit Log
sidebar_position: 1
---

The Audit Log tracks all modifications made to a Feature. DevCycle captures the DevCycle user who made the change, a time stamp, and what was modified on each Feature save.

The Audit Log is located at the bottom of the Feature form in the Data & Results section.

![Audit Log on Feature Page](/nov2023-audit-log-sidebar.png)

You can filter modfications by environment, DevCycle user, and for a particular date range.

![Audit Log](/nov2023-audit-log-summary.png)

The title of each modification card, highlights the change that was made to the Feature upon clicking save. If multiple changes were made on a Feature save and/or there were modifications made to more than one Environment, the card will show the total number modifications made.

Click the `View Details` button on each card for more information about each modification.

Modifications are organized by Environment with each card. The color of each Environment tag corresponds to the [color selected for that Environment](/essentials/environments#from-the-dashboard-1).

Items that are added to the Feature will be highlighted in green in the left-hand column of the modification card (see below), and removals or deletions of items will be highlighted in red.

![Audit Log Addition](/nov2023-audit-log-net-new-add.png)

For modifications to values, each card will show the orignal value on the left-hand column of the card and the updated value of on the right. If a value was added or modified, the change will be highlighted in green. If a value was deleted or removed, the change will be highlighted in red.

:::info

Please note that [Self-Targeting](/extras/advanced-targeting/self-targeting) actions are not recorded in the Audit Log.

:::

### Feature Created Modification Cards in the Audit Log

When a Feature is created, you will see multiple modification cards populate in the Audit Log. The first modification card in the Audit Log will outline the initial Feature configuration (initial variable, variations, status, settings, etc.). Then, depending on the [Feature Type](/introduction/core-concepts/feature-types) selected when creating a new Feature, the following cards will highlight the each Environment's Targeting status, along with the templated Targeting Rules (if they exist). See an example below of an Experiment Feature Type.

![Audit Log Experiment Feature Type](/nov2023-audit-log-experiment-feature-type.png)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/nov2023-audit-log-net-new-add.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/nov2023-audit-log-sidebar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/nov2023-audit-log-summary.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

1 comment on commit ce8033f

@vercel
Copy link

@vercel vercel bot commented on ce8033f Nov 16, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.