Assess your instance scale using Jira Cloud Migration Assistant: Database queries and usage metrics

Still need help?

The Atlassian Community is here for you.

Ask the community

You can assess the scale of your Jira instance by collecting data about its content, such as the number of users, projects, automations, and many more. Sharing this data with the Atlassian migration team will allow us to analyze the complexity of your migration and provide some guidance on migration planning.

How it works

The assessments are part of the cloud migration assistants, currently hidden behind a dark feature. When you enable them and run the assessment, we’ll automatically collect the following data:

  • Database entities: Number, or metadata, of entities, such as projects or issues

  • Usage data: for example the number of active users in the past days

  • Instance metadata: products installed, details about the database, Data Center nodes, and some metadata related to your instance, such as Server ID or timezone

  • Browser metrics: performance and browser metrics, including network speed and quality, based on users' browser

  • Apps: number and size of entities that might affect the migration, for the most critical apps

The data will be saved in a ZIP archive with a number of files. You’ll need to share them with Atlassian for analysis, and also review yourself to get a better idea about your instance.

How we use the data

As part of the assessment process, we'll only use the metadata about your Jira instance that you share with us. This metadata contains no Personally Identifiable Information (PII).

This will help us better understand your data complexity and cloud performance needs, and will allow us to craft a migration strategy and plan that mitigates risk and sets you up for success. Additionally, the metadata collected will help us continually improve our products and tooling.

Running the assessment requires you to enable a feature flag in your Jira instance. The assessment tool will monitor your instance for 24 hours, after which time it will output several results files. The assessment will not consume system resources during this time.

FAQs

Here are some common questions we’re getting.

Do you collect any identifiable data?

The assessment doesn’t collect any personal identifiable data (PII). Any data that we collect is based on IDs. It’s also not automatically shared with Atlassian – you share the files when you want to.

Do I need Internet connection? Do you call any APIs outside of my network?

The Internet connection is not required to collect the data. We’re also not calling any APIs outside of your instance’s network.

What’s the performance impact on the Jira instance?

We did performance testing and optimizations to make sure the assessment doesn’t affect your instance. When it’s running, your users can keep doing their work in Jira.

What’s the user key / ID collected from the user’s browser?

When collecting data from your users' browsers, we collect the user key associated with every user. These keys are hashed on export and never exposed to Atlassian teams. We only use them for grouping, clustering, and creating themes for research and analysis.

Before you begin

Here are some prerequisites:

  • We're adding new metrics on a regular basis. To get the most accurate assessment results, update the Confluence Cloud Migration Assistant to the latest version. Some results might not be available at all in earlier versions.

  • It takes 24 hours to collect the users' browser data. We recommend that you run the assessment during working hours so the data is meaningful. The assessment won’t impact the performance of your instance.

Assess your instance scale

To assess your instance, follow these steps.

1. Enable the assessment

To enable the assessment:

  1. Go to <Jira_URL>/secure/admin/SiteDarkFeatures!default.jspa

  2. Add the following flag: 

    com.atlassian.jira.migration.features.assess-l1-cloud-tooling

If you need more details, see Enabling dark features in Jira.

2. Run the assessment

To run the assessment and collect the data:

  1. Open the Jira Cloud Migration Assistant.

  2. In the Assess the size of your instance card, select Begin assessing.

  3. We’ll ask you to confirm that the data will be stored on your instance. Select Continue.

  4. The assessment will start. We’ll collect the data that includes:

    • Database entities: Running queries on your database to collect data about your entities.

    • Usage data: We’ll check access logs to see the usage data.

    • Browser metrics: We’ll collect performance data from your users' browsers.

3. Download the results

Once the assessment is complete, which should take 24 hours, select Download ZIP file. The ZIP archive includes the following files:

The files might be different if you're using one of the earlier versions of the assistant. We recommend that you update it to the latest version.

File

Description

jira-entities-[date].csv

Data about specific entities, retrieved from the database. It helps us understand the scale of your instance.

jira-usage-metrics-[date].csv

Usage metrics taken from access logs. It helps the Jira Cloud teams determine the best cloud instances for you.

jira-instance-metadata-[date].jsonl

Details about your instance, including products, infrastructure, database, Data Center nodes, and some metadata for easier identification.

jira-browser-metrics-[date].jsonl

Data from users' browsers on the performance of your instance. It helps us understand what you’ll need in cloud for best performance.

Apps subdirectory

Data about entities that might affect the migration, for the most critical apps. If you have these apps, each will have a separate file inside.

cloud-database-queries-[date].csv

(Deprecated) This file includes data about specific entities, similarly to jira-entities-[date].csv file. We've used it before we merged all entities into a single file. This file will be removed in one of the upcoming versions.

4. Share the results with Atlassian

Share the results with Atlassian. You'll most likely do it by attaching it to a MOVE ticket or Support request that pointed you at this page.

We will review the output results to better understand the complexity, data shape, performance needs, and risks, if any. These will help inform the creation of your Migration Strategy and Plan.

What data is collected?

Here are some details on the collected data that you can find in each of the files.


File: jira-entities-[date].csv

This file includes the following metrics:

Users and groups
  • Total number of users
  • Number of active users
  • Number of inactive users
  • Number of users deleted from an external directory
  • Total number of agents
  • Number of active agents
  • Total number of customers
  • Total number of groups
  • Metadata of groups with 35k or more members
  • Average and max number of members in a group
  • Average and max number of groups users have
  • Max number of groups associated with a user
  • Number of users with a unique username
Attachments
  • Total number of attachments
  • Size of all attachments in GB
  • Max number of attachments in an issue
Projects and issues
  • Total number of projects
  • Number of projects by type
  • Number of active projects
  • Total number of issues
  • Total number of issue types
  • Total number of comments
  • Number of project roles by type for example assigned to users or groups
  • Number of project roles with deactivated users
  • Number of projects with 80k or more issues
  • Total number of labels
  • Number of calendars per project
  • Max number of child issues in an issue
  • Number of time metrics by project
  • Total number of entity properties which are additional data stored in Jira entities such as issues or projects
  • Number of entity properties by entity type such as issue or project
  • Metadata of issues with 10k or more history groups
  • Metadata of projects with 10k or more history groups
  • Total number of history items which are individual changes made to issues
  • Total number of history groups which group multiple changes made to an issue in a single edit
Service projects
  • Total number of queues in service projects
  • Total number of request types in service projects
  • Number of service projects with 50 or more queues
  • Number of queues in top 10 projects with the most queues
  • Number of SLAs per each service project
  • Number of projects with 30 or more SLAs
  • Metadata of projects with 30 or more SLAs
  • Metadata of projects with 90 or more SLAs
  • Number of requests created per channel for example through email or customer portal
Workflows
  • Total number of workflow schemes
Custom fields
  • Total number of custom fields
  • Max number of options in a custom field
  • Total number of custom field values
  • Total number of custom field options
Assets
  • Total number of assets
  • Total number of asset schemas
  • Number of Assets custom fields linked to 20 or more assets
Automation

These entities refer to the legacy automation from Jira Service Management.

  • Total number of automation rules
  • Total number of automation rule executions per day
  • Metadata of automation rules with 30 or more branches
  • Number of automation rules with 30 or more branches
  • Number of projects with 30 or more automation rules
  • Metadata of projects with 30 or more automation rules
Audit and logging tables

For these entries, we're mostly interested in the size of tables, rather than the number of specific items. If the tables are too big, they can slow down or block the migration.

  • Total number of incoming emails received by Jira
  • Number of logs for fetching emails from the database
  • Number of logs for processing emails
  • Total number of execution logs for all automation rules
  • Number of execution logs. Rules with IF/COND statements
  • Number of execution logs. Rules with IF statements
  • Number of execution logs. Rules with IF/THEN statements
  • Number of execution logs. Rules with THEN statements
  • Number of execution logs. Rules with THEN/ACT statements


File: jira-usage-metrics-[date].csv

  • Interactions date: Date when an interaction with the Jira instance was recorded in the access logs.

  • Active users per day: Total number of unique users who interacted with the Jira instance in the past 14 days.

  • Peak-hour active users per day: Number of unique users who interacted with the Jira instance at the same time. We obtain it by aggregating user IDs and the corresponding date-hour combinations in the access logs. It provides a snapshot of your instance’s busiest periods.

  • Node availability and data collection status: Data on the availability of each node (or single node). It also shows the status of data collection.


File: jira-instance-metadata-[date].jsonl

  • Products: Name, version, and SEN number of products installed on your instance.

  • Infrastructure: Details about the database, Data Center nodes, and Java heap size.
  • Instance metadata: Some metadata, including assistant version, Server ID, instance UUID, and timezone.


File: jira-browser-metrics-[date].jsonl

  • user ID: A unique identifier of a user. It’s generated securely and hashed randomly to maintain privacy, while also allowing us to track user interactions.

  • Browser type and version: Details about the browser, for example Google Chrome, Safari.

  • Operating system: Details about the operating system, for example Windows, MacOS.

  • Processor count: Number of processors on the device.

  • System memory (RAM): Total memory or RAM on the device.

  • Network download speed: The speed of downloading data.

  • Network connection quality: The effectiveness of network connection.

  • Network Latency (RTT): Round Trip Time (RTT) is a measurement of the time it takes for a signal to travel from a user's computer to the Jira Instance and back. This helps gauge the responsiveness of users' network connection.

File: cloud-scale-database-[date].csv

This file has been deprecated and will be removed in one of the upcoming versions. It includes data about some entities that you can also find in the jira-entities-[date].csv file. 

Apps subdirectory

This subdirectory contains files with entities for the most critical apps. Right now, we support Zephyr Squad and Xray.

File: zephyr-squad-[date].jsonl

File: xray-[date].jsonl



Last modified on Jun 3, 2024

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.