配置性能北向文件的生成

操作步骤

1. 在“nbi.xml”文件中配置配置项NBIFileStoragePath，用于指定性能北向文件保存的目录。缺省值为data/nbi。
2. 在<安装目录>/AppBase/etc/oms.nbi/pm或其子目录下创建xml文件，例如export1.xml，定义要导出的性能指标。

   虚拟资源（FS/FC/vCenter/ESX）目录为“<安装目录>/AppBase/etc/virtual”，详细请参见《eSight 维护指南》中“维护参考 > 配置文件参考 > 虚拟资源管理 > pm_export.xml。

   在配置文件前请先了解如下信息：

   • eSight按照如下的树形结构划分指标：

     资源类型

     |——指标组A

     |——指标1

     |——指标2

     |——……

     |——指标组B

     |——指标1

     |——指标2

     |——……

     具体示例如图5-1所示。

     图5-1 指标树形结构
     
   • 按照指标的划分方式，配置文件的格式如下。其中，key属性的值需要配置为指标组和指标的key信息。若不了解key信息相关内容，可联系华为技术支持工程师。

     <?xml version="1.0" encoding="UTF-8"?>
     <indexes>
         <!-- 方式一： 资源类型的所有指标上报 -->
         <index resourceType="resourceType1" all="true"></index>
         <!--  方式二：资源类型的某指标组的所有指标上报 -->
         <index resourceType="resourceType2">
              <measUnit  key="scalartest2" all="true"> </measUnit>
         </index>
         <!-- 方式三： 指定具体的指标上报 -->
         <index resourceType="resourceType3">
              <measUnit  key="measUnitKey" >
              <measType key="measTypeKey1"/>
              <measType key="measTypeKey2"/>
              </measUnit>
         </index>
     </indexes>

     • resourceType为资源类型。该取值不能为空。当配置为空或者无效的资源类型时则不导出此资源类型。
     • all属性，取值范围为true或false。取值为true时，下级节点的配置不生效，即表示导出某资源类型下的所有指标、或者资源类型下某指标组中的所有指标。
     • measUnit中key属性为指标组。该取值不能为空，当配置为空或者无效则不导出该指标组。
     • measType中key属性为指标。该取值不能为空，为空或者无效则不导出该指标。

3. 在<安装目录>/AppBase/etc/oms.nbi/pm下创建配置文件，定义导出哪些设备类型的指标数据到北向文件中。
   • 配置文件的文件名格式要求为*_north.xml，且后缀必须为小写。
   • 配置文件格式要求如下：

     <?xml version="1.0" encoding="UTF-8"?>
     <plugin>
         <!-- 方式一：具体设备类型的具体指标 -->
         <export  file="/north/huawei/export1.xml"  file="/north/huawei/export2.xml" device="设备类型A,设备类型B" />
         <!-- 方式二：具体设备的所有指标 -->
         <export  all="true" device="设备类型C,设备类型D…" />
         <!-- 方式三：指标支持的所有设备 -->
         <export  file="/north/huawei/export3.xml" device="*" />
         <!-- 方式四：所有设备的所有指标 -->
         <export  all="true" device="*" />
     </plugin>

     • file属性为具体的指标配置文件，即步骤1中创建的配置文件。文件路径是以<安装目录>/AppBase/etc/oms.nbi/pm作为根路径。路径分隔符统一使用“/”。路径以及文件名的大小写必须与实际一致。配置多个file属性时，取所有指标配置文件的并集。
     • device属性为设备类型。可以配置多个设备类型，使用“,”分隔。设备类型配置为通配符“*”时，表示所有设备类型都支持。
     • all属性，取值范围true或false。取值为true时，表示导出设备类型所有的指标到北向文件，file属性不生效。取值为false时，才读取file属性中文件所定义的指标。
   • 配置了多个*_north.xml时，将取这些xml中定义的并集生成北向文件。

操作结果

性能FTP北向接口默认兼容历史版本，支持通过配置方式变更接口，具体版本控制方式如下：

1、 优化之前版本记为1模式，优化之后版本记为2模式

2、约束：一套eSight系统在同一时刻只能支持1模式或2模式，不可以同时支持；

3、 约束：升级版本和新安装版本一律默认为1模式；

4、 支持通过扩展点方式支持1模式动态切换为2模式，也支持在2模式下切换为1模式。

配置完成后，eSight会根据用户在客户端上设置的性能指标采集周期，周期性的将性能数据生成北向文件。并依据nbi.xml中NBIFileStoragePath配置项的配置将文件上传到对应目录下。

例如，假设nbi.xml中NBIFileStoragePath配置项使用的是缺省值/data/nbi，则在<安装目录>/AppBase/var/iemp/data/nbi/pmdatatemp/PerformanceFiles下以YYYYMMDD格式每天创建一文件夹，放置当天导出的所有历史性能结果文件，可以查看到带有时间戳的性能北向文件。

PM_IGifXTrafficStat_15_20140905_0700_partition_default.csv (1模式)

PM2_interface_ifXTrafficStat_900_20140905_150000_partition_default.csv (2模式)

第三方系统以nbi.xml 文件中配置的用户名以及认证方式登录eSight FTP服务器后，缺省根目录为如下文件夹：

│ ├─PerformanceFiles

│ │ └─20140905

PM_IGifXTrafficStat_15_20140905_0700_partition_default.csv (1模式)

PM2_interface_ifXTrafficStat_900_20140905_150000_partition_default.csv (2模式)

模式1

• 文件名称格式
  PM_IGNNNN_granularity_YYYYMMDD_HHMM_partition_XXX_N.csv

  • NNNN：指标组key
  • granularity：采集周期（单位为分，如果为0表示采集周期设置为半分钟，当前 eSight 的默认设置中小于一分钟的采集周期只有30秒）
  • YYYYMMDD：采集日期（UTC时间），如20140905，表示2014年9月5日
  • HHMM：采集时间（UTC时间），24小时制，如0700表示采集时间7时0分
  • partition_XXX：分区信息，默认分区为partition_default
  • N：文件序号，该序号为可选内容，编号格式为1等，相同文件名递增
• 文件内容格式

  内容格式以PM_IGifXTrafficStat_5_20140909_1630_partition_default.csv文件为样例进行介绍。

  • 使用excel打开csv文件后内容样式如下：

  • 以文本方式打开文件后的样式如下：

    第一行

    "Interface Traffic Statistics","Interface Traffic Statistics","53",

    第二行

    "DeviceID","DeviceName","ResourceID","ResourceName","CollectionTime","GranularityPeriod","ifOutBandRate","ifHCInOctetsSpeed","ifHCOutOctetsSpeed","ifInBandRate",

    第三行及以后

    "NE=34603118","SMM","Ethernet0/0/3","Ethernet0/0/3","1409900400000","15","0.00","143.03","75.73","0.00",

    "NE=34603118","SMM","Ethernet0/0/0","Ethernet0/0/0","1409900400000","15","0.00","18.33","18.41","0.00",

    • 第一行：指标组名称、指标组描述、测量对象总数
    • 第二行：文件中第三行以后每一属性的名称，前六个属性固定：设备DN、设备名称、资源DN、资源名称、采集时间（UTC绝对时间，单位毫秒）、采集周期（单位分钟），第七列以后为该指标中性能指标名称，具体指标描述参见eSight提供的性能指标清单
      表5-11 数据文件各字段说明（模式1）

      序号	字段名称	字段描述
      1	DeviceID	设备DN
      2	DeviceName	设备名称
      3	ResourceID	资源DN
      4	ResourceName	资源名称
      5	CollectionTime	采集时间（本地时间）
      6	-	第七列以后为该指标中性能指标名称（其中，“字段名称”对应性能指标清单中的I列“指标KEY”，“字段描述”对应性能指标清单中的B列“指标”）

    • 第三行及以后：为与第二行属性名称相对应的属性实际值
    • 文件分割：以按Enter键、换行两个字符分割每一行，以""（英文双引号）括起来CSV表格中每一单元格，以逗号（英文逗号）分割同一行中不同的单元格
    • 每一测量对象的唯一标识：第一列网元DN+第三列资源DN，第三列资源DN与查询OpenAPI接口返回值中的测量对象DN一一对应

模式2

• 文件名称格式
  PM2_resType_NNNN_granularity_YYYYMMDD_HHMMSS_partition_XXX_N.csv

  • PM2：表示模式2样式

  • resType：资源类型，如interface为新增资源类型，考虑不同resType会有相同指标组key的情况，所以新增resType到文件名中以便于区分。其中关于资源类型resType等信息需要由各业务提供，参考资料：eSight性能指标模板参考
  • NNNN：指标组key
  • granularity：采集周期，如300：表示采集周期单位为300秒
  • YYYYMMDD：采集日期（本地时间），如20140905，表示2014年9月5日
  • HHMMSS：采集时间（本地时间），24小时制，如150000表示采集时间15时0分0秒
  • partition_XXX：分区信息，默认分区为partition_default
  • N：文件序号，该序号为可选内容，编号格式为1等，相同文件名递增
• 文件内容格式

  内容格式以PM2_interface_ifXTrafficStat_300_20170316_191500_partition_default.csv文件为样例进行介绍。

  • 使用excel打开csv文件后内容样式如下：

  • 以文本方式打开文件的样式如下：

    第一行

    "DeviceID","DeviceName","DeviceIP","ResourceID","ResourceName","CollectionTime","GranularityPeriod","ifOutBandRate","ifHCInOctetsSpeed","ifHCOutOctetsSpeed","ifInBandRate",

    第二行及以后

    "NE=34603015","MSR30-20","10.137.59.242","GigabitEthernet0/1","GigabitEthernet0/1","20170316191500","900","0.00","143.03","75.73","0.00",

    "NE=34603013","cisco_2900_10.137.59.241","10.137.59.241","GigabitEthernet0/1","GigabitEthernet0/1","20170316191500","900","0.00","142.32","18.3","0.00",

    • 第一行：文件中第二行以后每一属性的名称，前七个属性固定：设备DN、设备名称、设备IP、资源DN、资源名称、采集时间（本地时间）、采集周期（单位秒），第八列以后为该指标中性能指标名称，具体指标描述参见eSight提供的性能指标清单
      表5-12 数据文件各字段说明（模式2）

      序号	字段名称	字段描述
      1	DeviceID	设备DN
      2	DeviceName	设备名称
      3	DeviceIP	设备IP
      4	ResourceID	资源DN
      5	ResourceName	资源名称
      6	CollectionTime	采集时间（本地时间）
      7	-	第八列以后为该指标中性能指标名称（其中，“字段名称”对应性能指标清单中的I列“指标KEY”，“字段描述”对应性能指标清单中的B列“指标”）

    • 第二行及以后：为与第一行属性名称相对应的属性实际值
    • 文件分割：以按Enter键、换行两个字符分割每一行，以""（英文双引号）括起来CSV表格中每一单元格，以逗号（英文逗号）分割同一行中不同的单元格
    • 每一测量对象的唯一标识：第一列网元DN+第四列资源DN，第四列资源DN与查询OpenAPI接口返回值中的测量对象DN一一对应

• 文件名称中YYYYMMDD_HHMM表述的时间为UTC时间（世界标准时间或世界协调时间），并非带时区的本地时间，比如北京时间 2014-09-24 18:00 生成性能文件的时间为PM_IGifXTrafficStat_15_20140924_1000_partition_default.csv。结果文件中E列“CollectionTime”时间也为UTC时间。
• 文件名称中YYYYMMDD_HHMMSS表述的时间为默认为本地时间，比如北京时间 2014-09-24 18:00:00 生成性能文件的时间为PM2_interface_ifXTrafficStat_900_20140924_180000_partition_default.csv。结果文件中F列“CollectionTime”默认时间也为本地时间。
• 生成的csv文件中，以""（英文双引号）括起来CSV表格中每一单元格，如果单元格中的值符合以下条件，会在开头添加制表符（"\t"）以防止受到CSV注入攻击，第三方解析到CSV文件单元格中的值后，应先判断是否以"\t"开头，如果是则需要将"\t"去除后再进行下一步处理。
  1. 字段值为整数且位数达到9位及9位以上；
  2. 字段值以"="开头，且不含","；
  3. 字段值以"+"开头，且不含","；
  4. 字段值以"-"开头，且不含","；
  5. 字段值以"@"开头，且不含","；