No relevant resource is found in the selected language.

This site uses cookies. By continuing to browse the site you are agreeing to our use of cookies. Read our privacy policy>Search

Reminder

To have a better experience, please upgrade your IE browser.

upgrade

eSight V300R010C00SPC200, 300, and 500 Self-Service Integration Guide 10

Rate and give feedback:
Huawei uses machine translation combined with human proofreading to translate this document to different languages in order to help you better understand the content of this document. Note: Even the most advanced machine translation cannot match the quality of professional translators. Huawei shall not bear any responsibility for translation accuracy and it is recommended that you refer to the English document (a link for which has been provided).
Configuring the Generation of Performance Northbound File

Configuring the Generation of Performance Northbound File

Before the third-party system reads data through the northbound FTP interface to obtain NE performance data, users must define the performance data to be exported.

Procedure

  1. Configure the directory for storing performance northbound files in configuration item NBIFileStoragePath of the nbi.xml file. The default path is data/nbi.
  2. Create an XML file, for example, export1.xml, in <Installation directory>/AppBase/etc/oms.nbi/pm or its subdirectories, to define performance indicators to be exported.

    Read the following information before configuring files.

    • On eSight, indicators are arranged in the following tree structure:

      Resource type

      |——Indicator group A

      |——Indicator 1

      |——Indicator 2

      |——...

      |——Indicator group B

      |——Indicator 1

      |——Indicator 2

      |——...

      Figure 5-1 shows an example.

      Figure 5-1 Indicators in the tree structure
    • Based on the indicator division mode, the format of configuration files is as follows. The value of the key attribute needs to be configured to the key information of indicator groups and indicators. For details about the key information, contact Huawei technical support engineers.
      <?xml version="1.0" encoding="UTF-8"?>
      <indexes>
      <!-- Method 1: Report all indicators of a resource type. -->
          <index resourceType="resourceType1" all="true"></index>
      <!-- Method 2: Report all indicators of a resource type in an indicator group. -->
          <index resourceType="resourceType2">
               <measUnit  key="scalartest2" all="true"> </measUnit>
          </index>
      <!-- Method 3: Report a specified indicator. -->
          <index resourceType="resourceType3">
               <measUnit  key="measUnitKey" >
               <measType key="measTypeKey1"/>
               <measType key="measTypeKey2"/>
               </measUnit>
          </index>
      </indexes>
      • ResourceType indicates the type of resources, which cannot be empty. If the resource type is empty or invalid, data is not exported.
      • The value of the all attribute can be true or false. If it is true, the sub-node configuration is invalid. That is, all indicators of a resource type or all indicators in an indicator group of a resource type are exported.
      • The key attribute in measUnit indicates the indicator group, which cannot be empty. If it is empty or invalid, data of the indicator group is not exported.
      • The key attribute in measType indicates the indicator, which cannot be empty. If it is empty or invalid, the indicator data is not exported.

  3. Create a configuration file in <Installation directory>/AppBase/etc/oms.nbi/pm and define the device types for which indicator data will be exported to performance northbound files.

    • The configuration file must be named in the *_north.xml format and the suffix must be lowercase letters.
    • The configuration file format is as follows:
      <?xml version="1.0" encoding="UTF-8"?>
      <plugin>
      <!-- Method 1: A specified indicator for a specified device type -->
      <export file="/north/huawei/export1.xml" file="/north/huawei/export2.xml" device=" Device type A, Device type B" />
      <!-- Method 2: All indicators of a specified device -->
      <export all="true" device=" Device type C, Device type D... " />
      <!-- Method 3: All devices supporting the indicator -->
          <export  file="/north/huawei/export3.xml" device="*" />
      <!-- Method 4: All indicators of all devices -->
          <export  all="true" device="*" />
      </plugin>
      • The file attribute indicates a specified indicator configuration file, that is, the configuration file created in Step 1. The root path of the file is <Installation directory>/AppBase/etc/oms.nbi/pm. The path is separated by slashes (/). The case attribute of the path and file name must be consistent with the actual ones. When configuring multiple file attributes, the union of all indicator configuration files is used.
      • The device attribute indicates the device type. You can set multiple device types and separate them with commas (,). If the device attribute is set to the wildcard (*), all device types are supported.
      • The value of the all attribute can be true or false. If it is true, all device type indicators are exported to performance northbound files. The file attribute is invalid. If it is false, the indicators in specified in the files of the file attribute are obtained.
    • When multiple *_north.xml files are configured, the union defined in the XML files is generated into a performance northbound file.

Operation Result

Northbound performance FTP interfaces are backward compatible by default. You can modify the interfaces through the pm.nbi.properties file. The description is as follows:

1. Mode 1 is used before optimization, and mode 2 is used after optimization.

2. Constraint: Only mode 1 or mode 2 is supported in one set of eSight system at a time.

3. Constraint: Mode 1 is used in an upgraded version and a newly installed version by default.

4. Modes 1 and 2 can be switched to each other through the nbiOptimizationVersion field.

After the configuration, eSight generates performance data to performance northbound files based on the performance data collection period configured on clients. Then, eSight uploads these files to the directory specified in the configuration item NBIFileStoragePath in nbi.xml.

For example, if the default value /data/nbi is used for the configuration item NBIFileStoragePath in the nbi.xml file, a directory named in YYYYMMDD format is created in <Installation directory>/AppBase/var/iemp/data/nbi/pmdatatemp/PerformanceFiles every day to store all the historical performance result files exported on the day. You can view the performance northbound files with timestamps.

PM_IGifXTrafficStat_15_20140905_0700_partition_default.csv (mode 1)

PM2_interface_ifXTrafficStat_900_20140905_150000_partition_default.csv (mode 2)

After a third party logs in to the eSight FTP server using the user name, password, and authentication mode defined in the nbi.xml file, the following folder exists in the default root directory:

│ ├─PerformanceFiles

│ │ └─20140905

PM_IGifXTrafficStat_15_20140905_0700_partition_default.csv (mode 1)

PM2_interface_ifXTrafficStat_900_20140905_150000_partition_default.csv (mode 2)

Remarks: The following describes the fields in the name of a performance result file:

PM_IGNNNN_granularity_YYYYMMDD_HHMM_partition_XXX_N.csv

Field description:

  • NNNN: indicates the key of an indicator group.
  • granularity: indicates the collection period, in minutes. The value 0 indicates the collection period of 30s. Currently, eSight supports the collection period of only 30 seconds by default if the collection period is less than 1 minute.
  • YYYYMMDD: indicates the collection time (UTC time). For example, 20140905 indicates September 5, 2014.
  • HHMM: indicates the collection time (UTC time) in the 24-hour format. For example, 0700 indicates 07:00.
  • partition_XXX: indicates the partition information. The default partition is partition_default.
  • N: indicates the file number. This field is optional. The value is a positive integer increasing from 1.

PM2_resType_NNNN_granularity_YYYYMMDD_HHMMSS_partition_XXX_N.csv

Field description:

  • PM2: indicates mode 2.
  • resType: indicates the resource type. For example, interface is a new resource type. This field is added to distinguish the same indicator group key for different resource types. Information about the resource type resType is provided by each service. A reference is as follows: eSight Performance Indicator Template.
  • NNNN: indicates the key of an indicator group.
  • granularity: indicates the collection period, in minutes, for example, 300s.
  • YYYYMMDD: indicates the collection time (local time). For example, 20140905 indicates September 5, 2014.
  • HHMMSS: indicates the collection time (local time) in the 24-hour format. For example, 150000 indicates 15:00:00.
  • partition_XXX: indicates the partition information. The default partition is partition_default.
  • N: indicates the file number. This field is optional. The value is a positive integer increasing from 1.

    YYYYMMDD_HHMM in the file name indicates the UTC and not the local time with a time zone. For example, a performance result file is generated at 18:00 on September 24, 2014 (Beijing time), so the file is named PM_IGifXTrafficStat_15_20140924_1000_partition_default.csv. In the performance result file, CollectionTime in column E also indicates the UTC time.

    YYYYMMDD_HHMMSS in the file name indicates the local time. For example, a performance result file is generated at 18:00:00 on September 24, 2014 (Beijing time), so the file is named PM2_interface_ifXTrafficStat_900_20140924_180000_partition_default.csv. In the performance result file, CollectionTime in column F also indicates the local time.

Translation
Download
Updated: 2019-10-30

Document ID: EDOC1100044386

Views: 17750

Downloads: 87

Average rating:
This Document Applies to these Products
Related Version
Related Documents
Share
Previous Next