Migrating historical User Activity Monitoring Plugin data

2 minute read

In the 2.332.3.2 release, the User Activity Monitoring Plugin was updated to use a new database. The new database is installed automatically when you upgrade to version 2.332.3.2 or later, however historical data tracked by the plugin will not be migrated to the new database. You may continue to use the User Activity Monitoring Plugin normally and user activity will be captured again, or you can migrate the data from the old database if you need historical data.

You can manually export the data from the old database using a .csv file before you perform the upgrade. However, CloudBees also provides an automated migration tool that allows you to migrate the historical data from the old database to the new database.

Migrating historical User Activity Monitoring Plugin data

When you migrate the User Activity Monitoring Plugin information using the migration tool, CloudBees CI downloads the .jar file for the old database so that it can read the historical information. It then migrates the historical information to the new database, and deletes the .jar file.

For most use cases, the migration process only needs to be performed on the operations center, since the operations center contains the aggregated data from all connected controllers. However, if you want to capture the data from the controllers directly, you must perform the following procedure on each of the controllers as well.

Complete the following steps to migrate the User Activity Monitoring Plugin’s historical data to the new database:

  1. When you upgrade CloudBees CI to version 2.332.3.2 or later, an administrative monitor message appears asking whether you would like to migrate the historical User Activity Monitoring data. Note the URL. If you would like to download the .jar file from a different location, edit the URL in this field. Alternatively, you can specify a file-protocol URL to use the .jar file that is already present at that location.

    Administrative monitor message
  2. Select Migrate.

    The .jar file is downloaded. Any existing user data is decoded and imported into the new database. The .jar file is then deleted.

    There is no visual confirmation that the migration process was successful. However, you can verify that the data was migrated by viewing the User Activity dashboard.

Re-enabling the administrative monitor message

If you dismiss the administrative monitor message without migrating the data, and then decide you would like to migrate the data later, you can re-enable the message in the Administrative monitors configuration in the Manage Jenkins options.

To re-enable the administrative monitor message:

  1. Ensure you are signed in to the operations center as a user with the Administer permission.

  2. From the operations center dashboard, in the left pane, select Manage Jenkins.

  3. Select Configure System.

  4. In the Administrative monitors configuration section, select Data migration needed for user activity monitoring.

    The administrative monitor message is re-enabled.