diff --git a/docs/en/guides/Component-library-settings.md b/docs/en/guides/Component-library-settings.md index 60c166e341fb379b5a8d0cbf15b8cbc03fd8d088..649dd1dba0cd21fb24d4136a51de492b6689b516 100644 --- a/docs/en/guides/Component-library-settings.md +++ b/docs/en/guides/Component-library-settings.md @@ -1,25 +1,25 @@ # Component library settings -Component library settings are about your own or 3rd part libraries used in monitored application. +Component library settings are about your own or third-party libraries used in the monitored application. -In agent or SDK, no matter library name collected as ID or String(literally, e.g. SpringMVC), collector +In agent or SDK, regardless of whether the library name is collected as ID or String (literally, e.g. SpringMVC), the collector formats data in ID for better performance and less storage requirements. -Also, collector conjectures the remote service based on the component library, such as: +Also, the collector conjectures the remote service based on the component library. For example: if the component library is MySQL Driver library, then the remote service should be MySQL Server. -For those two reasons, collector require two parts of settings in this file: -1. Component Library id, name and languages. -1. Remote server mapping, based on local library. +For these two reasons, the collector requires two parts of settings in this file: +1. Component library ID, names and languages. +1. Remote server mapping based on the local library. **All component names and IDs must be defined in this file.** -## Component Library id -Define all component libraries' names and IDs, used in monitored application. -This is a both-way mapping, agent or SDK could use the value(ID) to represent the component name in uplink data. +## Component Library ID +Define all names and IDs from component libraries which are used in the monitored application. +This uses a two-way mapping strategy. The agent or SDK could use the value (ID) to represent the component name in uplink data. - Name: the component name used in agent and UI -- id: Unique ID. All IDs are reserved, once it is released. -- languages: Program languages may use this component. Multi languages should be separated by `,` +- ID: Unique ID. All IDs are reserved once they are released. +- Languages: Program languages may use this component. Multi languages should be separated by `,`. ### ID rules - Java and multi languages shared: (0, 3000) @@ -31,7 +31,7 @@ This is a both-way mapping, agent or SDK could use the value(ID) to represent th - PHP reserved: [8000, 9000) - C++ reserved: [9000, 10000) -Example +Example: ```yaml Tomcat: id: 1 @@ -48,7 +48,7 @@ H2: ``` ## Remote server mapping -Remote server will be conjectured by the local component. The mappings are based on Component library names. +The remote server will be conjectured by the local component. The mappings are based on names in the component library. - Key: client component library name - Value: server component name