When an account or application sends many individual metrics that could be better managed in groups, New Relic uses the term metric grouping issue or MGI to describe this situation. When this occurs, the agent is sending unnecessarily large amounts of data to New Relic, which reduces the effectiveness of charts, tables, and reports in the New Relic user interface.
Metric grouping issues occur most commonly with web transactions, especially if the name is based on URLs. They can also happen with other metrics reported by your application. For example:
- If your application is crawling the Internet and each external call goes to a different domain
- If your software dynamically generates temporary database tables every time you receive a request
- If you are using custom instrumentation that includes UUIDs, article names, or similar unique components
Any situation where a potentially infinite list of metrics can be created, rather than metrics being grouped effectively (as with controllers, permanent database tables, or specific external services) can become a metric grouping issue.
By understanding what metric grouping is and how issues can arise, you can better understand how New Relic works with your application to group metrics effectively and help prevent metric grouping issues from occurring.
To help prevent metric grouping issues from occurring in your app:
- Check the New Relic release notes to verify you are running the most current version of the New Relic agent.
- If needed, upgrade your New Relic agent to the most current version.
- Wait a few minutes, then look at new data in the New Relic UI.
If the problem persists:
- All agents: Review the information about what causes metric grouping issues.
- Browser: Add URL groupings
- Go: Rename the Go transactions.
- Java: See Java metric grouping issues.
- .NET: Rename metrics with
SetTransactionName. For more information about adding details by using XML, see Name transactions.
- Node: Rename transactions with the Request API calls.
- PHP: Rename transactions.
- Python: Rename transactions with set_transaction_name.
- Ruby: Rename transactions.
Metric grouping issues occur when the granularity of metric names (most often web transaction names) is too fine, resulting in hundreds or thousands of different web transaction names for just a small number of code paths. A few major code paths may generate many different full URL paths to unique documents, articles, or page, etc., and if the unique element of the URL path is included in the transaction name, each of these common paths will have its own unique name.
- MGI example
In this example, you have an application that lets users write articles on any subject and post them for other users to see. Your application has three main functions: add an article, search for an article, and display an article.
In order to improve search engine optimization (SEO), the "view article" code generates a unique URL to refer to each article. For example, the following URLs each refer to different articles in the example website:
http://example.com/article/view/How_to_Install_New_Relic http://example.com/article/view/How_New_Relic_Saved_the_Day http://example.com/article/view/Where_do_I_get_New_Relic
All three articles are different; they contain different content and their URLs are different. However, the code path that generates each article is the same: they all use the "view article" function.
Many web frameworks use this technique. They have a controller or route (in this case named
article/view) as part of the URL. New Relic works to automatically identify these patterns and group similar routes together, to prevent metric grouping issues from occurring.
Without mechanisms for detecting controllers, the example application would send metrics for each individual URL requested by visitors to your site. If you have a million articles and your site is popular, in each minute there could be several thousand unique URLs visited. This produces a significant amount of additional data to be sent to New Relic for each harvest cycle, and the New Relic APM Transactions page would attempt to list thousands of unique URLs, resulting in metric grouping issues.
To monitor and improve your application performance, it's much more useful to know the average performance for a function (for example, viewing articles on your site) than how quickly each individual article is displayed. To prevent metric grouping issues, New Relic will normally show a single entry for that function (for example,
/article/view/*) on the New Relic APM Transactions page.
This grouping gives you a much better idea of how much time was spent viewing articles, and allows you to easily spot any performance problems related to viewing articles. If these statistics were spread across hundreds or thousands of transactions, detecting trends, regressions, or performance improvements would be extremely difficult.
Each New Relic APM agent has distinct ways of detecting controllers and frameworks. Most are automatic, but a few require you to enable or disable options in a config file. You can also follow New Relic's recommendations to help prevent metric grouping issues from occurring.