Install or enable the Analytics service

Azure DevOps Server 2020 | Azure DevOps Server 2019

For Azure DevOps Server 2020, the Analytics service is generally available. It's automatically enabled for all new project collections added to your server. For project collections upgraded from a previous version, you may need to manually enable it. You enable Analytics for each project collection for which you want to generate Analytics reports.

Analytics is currently in Preview. It's free to use while it remains in Preview. For Azure DevOps Server 2019, you install the Analytics extension from your local marketplace. For Azure DevOps Server 2019.1, you enable Analytics. You install or enable Analytics for each project collection for which you want to generate Analytics reports.

Note

The Analytics Marketplace extension and Analytics are not supported for TFS 2018 or earlier versions.

Analytics supports access to Analytics widgets for all projects defined in the project collection. To learn more, see What is Analytics? and Widgets based on Analytics.

Prerequisites

For Azure DevOps Server 2019.1:

For Azure DevOps Server 2019:

Enable Analytics

If you've upgraded to Azure DevOps Server 2019.1, you can enable Analytics for a project collection with the following steps. Otherwise, for Azure DevOps Server 2019, see Install Analytics.

Note

Analytics is automatically enabled for all newly created project collections.

  1. From a web browser, select (1) the project collection, (2) Collection Settings or Admin settings, and then (3) Analytics.

    Open Collection>Admin settings>Analytics

  2. Select Enable Analytics.

    Enable Analytics

    Once enabled, Analytics staging jobs begin to populate the Analytics data tables. This process could take some time depending on the size of your collection. To learn more about the data tables, see Analytics data model.

Pause or disable Analytics

If you've upgraded to Azure DevOps Server 2019.1, you can pause or disable Analytics for a project collection with the following steps. Otherwise, for Azure DevOps Server 2019, the equivalent actions are to Disable or uninstall the Analytics extension.

You can only pause or disable Analytics that has been previously enabled.

  1. From the Analytics settings page, select Pause Analytics or Disable Analytics.

    Pause or Disable Analytics

  2. Confirm that you want to pause or disable the service.

    Confirm Pause dialog. Confirm  Disable

Resume Analytics

For Azure DevOps Server 2019.1, you can resume Analytics after you've paused it for a project collection. Resuming the service will re-enable staging jobs, which will update the data tables and make them current, updating since the time it was paused.

  1. From the Analytics settings page, select Resume Analytics.

    Enable Analytics

  2. Confirm that you want to resume the service.

    Confirm Resume dialog.

    Once enabled, Analytics staging jobs begin to populate the Analytics data tables. This process could take some time depending on the size of your collection.

What happens if I pause or disable Analytics?

Pausing Analytics or disabling the Analytics extension (2019), disables the following features:

Pausing Analytics preserves your data but stops staging jobs from updating your data. You can resume the service later and your data will then be updated.

Disabling Analytics or removing the Analytics extension (2019), turns off all Analytics staging jobs and deletes the Analytics data stored in the Analytics tables. All Analytics data that captures historical trends is lost. It doesn't delete any other data stored in your collection. You can't undo this action. Once historical data and trending data is deleted, you can't restore it. Re-enabling Analytics won't restore the historical data.

With Analytics disabled or removed, the following actions occur:

  • No staging jobs are run, and the Analytics tables won't have updated information.
  • Table data is deleted, and if Analytics is re-enabled, all data will have to be repopulated from scratch.

Note

Disabling Analytics in Azure DevOps Server 2019.1 is the same as uninstalling the Analytics extension for Azure DevOps Server 2019.

To learn more about the data tables, see Analytics data model.

Install the Analytics extension

If you haven't upgraded to Azure DevOps Server 2019.1, you can install the Analytics extension to gain access to Analytics widgets and reports for your project collection. The Analytics extension is shipped within the on-premises installer. Installing the extension simply enables the functionality. There isn't any need to download extension files manually to install.

Tip

The Analytics extension appears in the local gallery for Azure DevOps Server so that there isn't any need to download it from the Azure DevOps Marketplace.

  1. From a web browser, select (1) the project collection, (2) Admin settings, and then (3) Extensions.

    Open Collection>Admin settings>Extensions

  2. Select Browse local extensions.

    Browse local marketplace

    Note

    Installing the extension from the local marketplace is identical to installing from the hosted marketplace. The only difference is the hosted marketplace shows extension ratings and user comments.

  3. The local Marketplace opens in a new browser tab. Select the Analytics extension card.

    Analytics extension card

  4. Select Get it free.

    Screenshot of Analytics Marketplace extension, Select Get it free.

  5. Select the project collection and then select Install.

    Select the project collection

  6. Upon completion of install, you'll see an image similar to the following. Select Proceed to collection to return to the web portal for your collection.

    Screenshot of Analytics Marketplace extension installed, Proceed to collection.

    Optionally, if you want to install the Analytics extension on other project collections, select the browser back button.

Disable or uninstall the Analytics extension

If you choose to disable the Analytics extension, it will stop any jobs from running. Analytics data will be out of sync and associated features won't be available. However, no data is deleted. Uninstalling the Analytics extension deletes the data from the Analytics database tables. Upon reinstall of the extension, the data is repopulated from scratch.

  1. Open the extensions menu and select Manage Extensions.

    Screenshot of Manage extensions tab.

  2. In the Manage tab, open the shortcut menu for the extension.

    Screenshot of context menu for an extension, Disable or uninstall an extension menu options.

  3. Select Disable or Uninstall as required.

Restore the Analytics extension if removed from the deployment

If you remove the Analytics extension from your deployment, you can install the extension from the online marketplace to restore it. You may be unable to use the online marketplace because of your server setup. For example, your firewall might block some outgoing connections. Even if that's the case, you can restore it to the local marketplace using the following steps.

  1. Open Collection settings following the instructions provided in the section Install the Analytics extension.

    Select Extensions, and then Browse local extensions.

  2. Scroll to the bottom of the page, and select Manage Extensions.

    Manage extensions

  3. Select Upload extension and then select click to upload. Browse to the folder containing the Microsoft.TeamFoundation.Extension.Analytics.vsix file.

    Upload extension

    The .vsix file can be found in your application-tier folder installation in the following path.

    C:\Program Files\Azure DevOps Server 2019\Tools\Deploy\TfsServicingFiles\Extensions\Microsoft.TeamFoundation.Extension.Analytics.vsix

    Uploading the extension restores it to the local marketplace. From there, you can install it to a collection.

How to determine if your server is disconnected?

If your server is disconnected from the Internet, you must install Analytics from the local marketplace.

You can determine if your Azure DevOps Server is in a disconnected state. Check to see if the connected icon and server name appear at the top when browsing the hosted marketplace.

Determining if your server is connected or not

When you navigate to the Marketplace from your on-premises server, an error doesn't display if you're not connected. It simply switches to the cloud service context.

Known issue

If you use a public URL to install the extension, for example https://OnPrem.MyCompany.com, you may get a callback error, such as a TLS/SSL error.

To resolve this issue, you can install the extension from a machine that hosts the application tier and point to the local machine URL, for example https://myMachineName.