What naming conventions are recommended when defining configuration objects for server visibility Machine Agent?
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...!
NOTE | In 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 EUM
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 tables contain naming best practices for End User Monitoring (EUM), including EUM applications, RUM, and Synthetic job names.
Back to Contents
| Naming conventions for EUM |
EUM applications
|
{Full Business Application Name} - {EUM Type}
|
|
{EUM Type} must be one of the following:
- BRUM for Browser Real User monitoring
- iOS for iOS mobile application monitoring
- Android for Android mobile application monitoring
|
RUM
|
PAGES, AJAX CALLS, and NETWORK REQUESTS
{To be decided by the application teams, with assistance from AppDynamics knowledgeable resources}
|
- As required to conform to the Overarching Principle, use manual renaming or custom match rules.
- Whenever possible, BRUM Page names or Ajax calls should match (or be very similar to) the APM BT’s that performs the corresponding back-end processing.
|
Synthetic job names
|
{Description of journey and steps involved} |
- Application teams to define a naming standard, with assistance from AppDynamics-knowledgeable resources.
- The naming standard should conform to the overarching naming principles: names chosen for any configuration item should be a sensible, non-technical description
|
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
