Usage Metrics


https://c.na44.content.force.com/servlet/servlet.ImageServer?id=01530000002xQP4&oid=00D000000000062&lastMod=1416868986000
Usage Metrics is now unavailable. For more information, see Usage Metrics Retirement. Enable AppExchange App Analytics in your security-reviewed managed packages to retrieve usage data about how subscribers interact with your AppExchange solutions. You can use these details to identify attrition risks, inform feature development decisions, and improve user experience. To enable App Analytics, follow the instructions in Request AppExchange App Analytics.

Usage Metrics is a feature that provides valuable insights and allows you to take a closer look at utilization and performance of your app across your entire customer base. With Usage Metrics, you can identify the highest and lowest performing app features as well as which customers are engaging the most and least with your app.

Check out the resources below to learn how to activate Usage Metrics and more.
 

1. Before setting up Usage Metrics for any package, please note two important organizations involved in the process:

  • Release organization — This is the Development Edition organization used to upload the package
  • Reporting organization — Usage data is delivered to this organization on a daily basis

 Note: The release organization and reporting organization must be members of the same Environment Hub. This is a security feature that ensures usage data is only delivered to an organization controlled by the developer of the package. We recommend using the Environment Hub as your reporting organization.

2. In order to activate Usage Metrics for a package you must:

  • Set up Environment Hub, if you haven’t already done so. 
  • Connect the release organization to the Environment Hub. 
  • Connect the reporting organization to the Environment Hub (if they’re different). 
  • Submit a case in the Partner Community to activate Usage Metrics. You will need to provide the package ID for your app. 
To use this feature, you must have a fully executed contract and your app must have already passed security review. If you do not have a fully executed contract, please reach out to your Partner Account Manager.

Once the Usage Metrics feature is activated, you will receive a confirmation email. From there, usage data will automatically be collected from all organizations in which your package is installed, and delivered to the reporting organization on a daily basis.

3. Download the Usage Metrics Visualization app from AppExchange:
  • This tool will enable you to visualize trends in usage metrics data for your app.
  • You can download the app from the Salesforce Labs category page on AppExchange.

Q: What is Usage Metrics?
A: Usage Metrics enables you to collect detailed usage metrics from each organization in which your managed package is installed.

Q: Why should I use Usage Metrics?
A: You will be able to determine which app features are used the most and least. This can help with prioritizing your development efforts and when planning the next version of your app. You can also identify which customers are either the most valuable or at-risk, based on their level of engagement with your app.

Q: What types of components can I use to collect these metrics?
A: You can collect daily metrics on two types of components in a managed package: Custom Objects and Visualforce pages. 

  • Custom Objects —Identify the total number of records existing per organization in each custom object. This enables you to track how the usage of that custom object is growing with time in any subscriber organization, which is a reliable indicator of how much it is being utilized.
  • Visualforce pages — Identify the number of times each Visualforce page was accessed per organization, the number of unique users who accessed it, and the average loading time (in milliseconds). By comparing the metrics for different Visualforce pages, you can determine the relative popularity of different parts of your app in a specific customer organization, as well as trends across all customers.

Q: Where is the usage data stored?
A: The usage data for a package is stored in MetricsDataFile records in your reporting organization. Once you activate the Usage Metrics feature, one new record is created for all custom objects and one for all Visualforce pages, per Salesforce instance per day. To learn more, visit the ISVforce guide.

Q: When is the Usage Metrics File created?
A: Usage metrics files are generated daily at 9AM Pacific time.

Q: What is the Usage Metrics Visualization app? How do I install it?
A:The Usage Metrics Visualization app, available from Salesforce Labs category collection on AppExchange, enables you to visualize trends in usage metrics data for your app. You can use the Usage Metrics Visualization app to generate charts showing changes in various app metrics, over a specified duration, for one or more customer organizations. 

To install the Usage Metrics Visualization app:

  • Go to the AppExchange and locate the Usage Metrics Visualization app. 
  • Click Get It Now. 
  • Enter the credentials for your reporting organization, then click the login button.
  • Click Install. 
You will see a message describing the progress and a confirmation message after the installation is complete.

For more information on Usage Metrics, check out the ISVforce guide.