Managed system names

Edit online

The managed system name (MSN) is used to uniquely identify each Cloud APM agent within your environment. It is also the instance name that you see on the Application Performance Dashboard when you select a group for each managed system from the navigator Groups section. To avoid conflicts in your environment, assign unique MSNs to your agents.

The agent MSN format differs, depending on your agent type. It falls into one of the following categories:

Common MSN format for single-instance agents

For most single-instance agents, the common form of the MSN follows this format:
hostname:pc
where:
  • hostname is the name of the computer where the agent is installed. This part can be changed if needed.
  • pc is the uppercase two-character agent code, which cannot be changed. For more information about agent codes, see Using agent commands.
  • : is the separator, which cannot be changed.

Example: linuxhost01:LZ is the MSN of the Linux® OS agent.

Some single-instance agents that do not follow this MSN format are listed in Table 1.

The MSN is limited to 32 characters. For this MSN category, 29 characters are available for the host name because the agent code and separator cannot be changed.
Important: If the length of the MSN exceeds 32 characters, part of the MSN is truncated and it does not display correctly in the Cloud APM console. For example, if your host name is VeryLongSalesDivisionServerName03, your managed system name should be VeryLongSalesDivisionServerName03:PC. However, it is truncated to VeryLongSalesDivisionServerName0.

Common MSN format for multi-instance agents

For most multi-instance agents, the common form of the MSN follows this format:
instancename:hostname:pc
where:
  • instancename is the agent instance name that you specify during agent configuration. Use this variable to ensure a unique MSN for each instance of each agent type on each agent host computer.
    Remember:
    • Letters from the Latin alphabet (a-z, A-Z), Arabic numerals (0-9), and the hyphen-minus character (-) can be used to create agent instance names.
    • The underscore character (_) is not allowed in agent instance names.
    • The instance name that you specify is limited as follows:
      • Linux or AIX28 characters minus the length of your host name on Linux or AIX systems.
      • Windows28 characters minus the length of your host name when using the silent response file for configuration on Windows systems. Example, Server-Name is 11 characters long. So agent instances on the Server-Name host must be less than or equal to 17 characters in length.
      • Windows20 characters minus the length by which your host name exceeds 8 characters when using the Cloud APM console configuration on Windows systems. Example, TestServer is 10 characters long, which exceeds 8 by 2. So agent instances on the TestServer host must be less than or equal to 18 characters in length.
  • hostname is the name of the computer where the agent is installed. The host name component of the MSN can be changed if necessary.
  • pc is the uppercase two-character agent code, which cannot be changed. For more information about agent codes, see Using agent commands.
  • : is the separator, which cannot be changed.

Example: jboss1:win2016:JE is the MSN for the JBoss® agent.

Some multi-instance agents that do not follow this MSN format are listed in Table 1.

The MSN is limited to 32 characters. For this MSN category, 28 characters are available between the instance name and the host name because the agent code and separators cannot be changed.
Important: If the length of the MSN exceeds 32 characters, part of the MSN is truncated and it does not display correctly in the Cloud APM console. For example, if you specify VeryLongInstanceName as your instance name, and your server name is Production09, your managed system name should be VeryLongInstanceName:Production09:PC. However, it is truncated to VeryLongInstanceName:Production0.

Special MSN format

Special MSN format applies to the agents whose MSNs do not follow the above two common MSN formats. These agents are listed in Table 1.

The special MSN is limited to 32 characters. In Table 1, only the italic strings in the MSN format column can be changed.

Table 1. Special MSN format
Agents MSN format MSN example
Amazon EC2 agent B5:ec2subnodename:INS B5:sales:INS
Amazon ELB agent
  • AL:instancenameA:APP
  • AL:instancenameC:CLA
  • AL:instancenameN:NET
  • AL:elb-inst3A:APP
  • AL:elb-inst3C:CLA
  • AL:elb-inst3N:NET
Azure Compute agent AK:azure_compute_subnode_name:AVM AK:azc-inst3:AVM
Citrix VDI agent VD:citrixsitename:XDS VD:xds1:XDS
DataPower® agent BN:datapowersystemname:DPS BN:datapower23:DPS
HTTP Server agent HU:hostname_alias:HUS HU:docker-ihs_httpd:HUS
IBM® Integration Bus agent monitoredbrokername:agentID:KQIB TRADEBRK:AGT1:KQIB
MQ Appliance agent MK:hostname_sectionname:ARM MK:bvtmin_linux150:ARM
Node.js agent NJ:hostname_port:NJA NJ:KVM-014179_3000:NJA
Oracle Database agent
  • RZ:dbconnection-instancename-hostname:ASM
  • RZ:dbconnection-instancename-hostname:DG
  • RZ:dbconnection-instancename-hostname:RDB
 RZ:11g-oracledbdemo-GVT-1BL:RDB
Ruby agent KM:hostname_appname:RAP KM:nc9098036112_Blog:RAP
SAP agent
  • SAP Instance: instancename-hostname_sid_instancenumber:Ins
  • SAP Process Integration: instancename-hostname:PI
  • SAP Solution Manager: instancename-hostname:Slm
  • SAP System: instancename-hostname:Sys
  • PS5-IBMSAP3V1_PS5_11:Ins
  • PS5-IBMSAP3V1:PI
  • PS8-IBMSAP3V3:Slm
  • PS5-IBMSAP3V1:Sys
SAP HANA Database agent
  • SAP Hana Database: S7:dbname-systemsid:HDB
  • SAP Hana System: instancename:hostname:S7
  • S7:HNA-HNA:HDB
  • HNA:PS8760:S7
SAP NetWeaver Java™ Stack agent
  • SAP NW Java AS Cluster: instancename:hostname:SV
  • SAP NW Java AS Instance: SV:systemsid-jvmid:NWJ
  • J01:VPT02F17:SV
  • SV:J01-83309750:NWJ
UNIX OS agent hostname:KUX worklight17:KUX
WebLogic agent WB:instancename:WLS WB:Server1:WLS
WebSphere® Applications agent
  • WebSphere Application Server: serveralias:hostname:KYNS
  • WebSphere Portal Server: serveralias:hostname:KYNR
  • WebSphere Process Server: serveralias:hostname:KYNP
 simpletrade:worklight17:KYNS
WebSphere MQ agent monitoredqmgrname:agentname:MQ TRADEQM:PoC:MQ
Windows OS agent Primary:hostname:NT Primary:TRADEIIS1:NT