Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create SelfDescribingEvent for Wizard usage #192

Merged
merged 1 commit into from
Dec 11, 2024
Merged

Conversation

oomIRL
Copy link
Contributor

@oomIRL oomIRL commented Nov 20, 2024

I setup the analytics to track the "create" event which fires when Wizards are run. Specifically, when the "Create" button is clicked. There are also some formatter changes.

Here's what the event looks like in the Snowplow plugin. Its type appears as "SD Event: action", and it includes the action "wizard-complete", the name of the Wizard, and time saved in minutes.

image

The schema displays as Unrecognised[sic], I assume because Dan & Co haven't added it to their schema registry yet, since this is the schema spec they provided.

Ministry is blank because the Wizard's user input is not included with the create event.
I think including it is reasonable but non-trivial. Most likely requiring a custom scaffolder action that we add to the Wizard.

@jenreiher-bcgov
Copy link
Contributor

I setup the analytics to track the "create" event which fires when Wizards are run. Specifically, when the "Create" button is clicked. There are also some formatter changes.

Here's what the event looks like in the Snowplow plugin. Its type appears as "SD Event: action", and it includes the action "wizard-complete", the name of the Wizard, and time saved in minutes.

image

The schema displays as Unrecognised[sic], I assume because Dan & Co haven't added it to their schema registry yet, since this is the schema spec they provided.

Ministry is blank because the Wizard's user input is not included with the create event. I think including it is reasonable but non-trivial. Most likely requiring a custom scaffolder action that we add to the Wizard.

Yay! Awesome :)

Interesting that the previous data isn't available! One way I've got around this in the past (which may or may not work with Backstage) is to add it into the url as a parameter as we navigate through the steps so that in the final view we can retrieve it.

I still say we should make ministry mandatory in the metadata though!

}
}
enableActivityTracking({
minimumVisitLength: 30,
Copy link
Contributor

Choose a reason for hiding this comment

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

curious what this is doing!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The activity tracking cause page pings to fire when users are engaged on the page.
So, if a user has the page focused and they're scrolling or moving their mouse then the ping will go off every 30 seconds. If there's no activity then the pings stop.
I'm not sure if this metric is visible in the dashboards though.

Copy link
Contributor

Choose a reason for hiding this comment

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

This could be useful if we want to ask dan in future to track "drop off" on wizards :)

@oomIRL oomIRL merged commit eba8493 into main Dec 11, 2024
2 checks passed
@oomIRL oomIRL deleted the DEVX1881-CreateEvent branch December 11, 2024 17:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants