cancel
Showing results for 
Show  only  | Search instead for 
Did you mean: 
Claudia.Landivar
Community Manager

What naming conventions are recommended when defining configuration objects for Analytics metrics?

 

We highly recommend the following standard naming conventions for different configuration items used in AppDynamics because sound naming standards are an important practice for:

  • Efficient identification of objects
  • Understanding data context
  • Navigation
  • Searching
  • Housekeeping
  • Decommissioning efforts

plus more...!

 

NOTEIn this article, we are specifying standards for setting configuration items values, rather than methods. See more below.

These recommendations are based on standard configurations and are not intended to be a universal solution, and therefore may not work with custom-configured instances. 

 

In this article...


 

Naming conventions for Analytics metrics

Successful naming is based on emphasizing the use of common standards. So, where available, use nomenclature that already exists, whether public or company-based. The following table contains naming best practices for Analytics metrics.

 

Analytics metrics naming conventions

{Full Business Application Name}_{Description}_{Metric type}

Example: UK-Digital_LargeLoanCalculation_ResponseTime

If the metric query spans multiple apps, the first segment must be a useful group description, such as service name or business unit name.

Back to Contents

 

Overarching principles for naming conventions

Some configuration items do not specify a strict pattern or convention. Instead, we leave it up to you to decide. In such cases the following principle should always apply:

 

Names chosen for any configuration item should be a sensible, non-technical description.

 

DO THIS

NOT THIS

Use plain language

Avoid too-formal, distancing language

Be descriptive, but concise

Don’t be verbose

Use business terminology where possible

Don’t use technical terms

Make it meaningful to all intended users

Avoid jargon that won’t be familiar to all of the intended users.
When in doubt, leave it out.

 

PLEASE NOTE: In this article, we are not specifying the method of setting values for configuration items, only standards for the values themselves. In the case of agent configuration properties, use one of the following methods to set the values:

  • Configuration files
  • System Properties
  • Environment Variables

Let us know in the comments below if you have further questions on methods.


 

Additional Resources

 

Need to go deeper? Reach out to Call a Consultant

Version history
Last update:
‎02-03-2022 09:09 PM
Updated by: