指定裝置套件元素資訊

如何產生裝置套件 › 將必要資訊新增至裝置套件配置檔 › 指定裝置套件元素資訊

指定裝置套件元素資訊

在裝置套件配置 XML 檔案中指定輸入檔案資訊的值之後，請在 XML 檔案的適當區段中指定輸入裝置套件元素資訊的值。

每個裝置套件都包含三種元素類型，即 DevicePackHeader、DevicePackData 與 DevicePackKPI：

DevicePackHeader

裝置套件使用您在此指定的值，提供新裝置與裝置元件名稱，這些資訊會顯示在 CA Performance Center 中的 [清查] 索引標籤上。這個資訊的一部份也是新度量系列的名稱。

DevicePackHeader 元素共有六種類型。您必須提供這六種類型中的五種，其說明如下：

附註：以下使用 Huawei2000WDM 的範例 CSV 資料說明各種類型：

範例檔案名稱：PM_IG500011_15_201109092200Z_01.csv

範例檔案內容：

[1] DeviceID, DeviceName, ResourceName, CollectionTime, GranularityPeriod

[2] 3145804, ARE_Electrical, Shelf0-52TOM-3(RX1/TX1)-OCH:1, 2013-05-09 10:15, 15

[3] 3145804, ARE_Electrical, Shelf0-52TOM-4(RX2/TX2)-OCH:1, 2013-05-09 10:15, 15

行 [1] 是 CSV 標頭。 CSV 標頭行包含以分隔符號分隔的欄名稱。這些欄名稱在檔案中永不會重複出現。
行 [2] 與 [3] 是 CSV 資料。 CSV 資料行包含某些以分隔符號分隔的資訊。每個欄名稱與資料中的資訊之間會有一對一的對應存在。每個資料行只會有一個欄名稱值。
在第一個資料行中，[資源名稱] 欄的值為 Shelf0-52TOM-3(RX1/TX1)-OCH:1。在第二個資料行中，[資源名稱] 欄的值為 Shelf0-52TOM-4(RX2/TX2)-OCH:1。
附註：
- 檔案中位於標頭上方的所有內容皆為註解。檔案中位於標頭後面的所有內容皆為資料。
- CSV 檔案不包含行號。前述範例中提供行號是為了說明範例。
- 應用程式不支援在一個 CSV 檔案中使用多個標頭。對於具有多個標頭的 CSV 檔案，建議您將單一 CSV 檔案分割為數個較小的 CSV 檔案。視需要建立不限數量的 CSV 檔案，讓每個 CSV 檔案僅包含一個標頭及其資料。

裝置

為從中產生或接收輸入資料檔案的裝置或「元素管理系統」(EMS) 指定名稱或識別碼，並使用此裝置套件進行監控。

附註：就應用程式所支援的 CSV 格式而言，每個 CSV 檔案只會有一個 Device 值。

此值會在 CA Performance Center 中的 [清查] 索引標籤中顯示為新裝置。

範例：

ARE_Electrical ("DeviceName" 欄的值) 或 3145804_ ARE_Electrical ("DeviceID" 欄加上 "DeviceName" 欄的值)

附註：用以附加多個值的預設字元為底線 (_)。

Branch

在輸入資料檔案名稱或檔案內容中指定識別碼 (或外部來源所提供的識別碼)，用以唯一識別相同裝置中的其他資料檔。

附註：就應用程式所支援的 CSV 格式而言，每個 CSV 檔案通常只會有一個 Branch 值。

在 CA Performance Center 中，新的度量系列會以裝置套件名稱與 Branch 的值來命名。

範例：

IG500011 (規則運算式對檔案名稱套用的群組擷取值)

規則運算式：^PM_(IG.*)_\d\d_.*$

BranchDesc

在輸入資料檔案中指定具有 Device 元素與 Branch 元素的識別碼，用以唯一識別檔案中的每一行。 BranchDesc 是分支說明的簡短格式。此值由一欄或兩個或更多欄的組合所組成。當您使用 Device 與 Branch 來識別檔案中的每一行時，建議您提供以 Branch 作為前置詞或尾碼而具有意義的字串，以組成 BranchDesc。

附註：就應用程式所支援的 CSV 格式而言，每個 CSV 檔案中每行通常會有一個以上的 BranchDesc 值。在一般情況下，BranchDesc 會是一欄或多欄組合的值。

範例：

Shelf0-52TOM-3(RX1/TX1)-OCH:1 ("ResourceName" 欄的值)

DeviceIP

指定裝置或 EMS 的 IP 位址。

附註：IP 位址不可為 127.0.0.1。

預設值：255.255.255.255

Delta

指定裝置或 EMS 據以產生 CSV 檔案的時間間隔 (以秒為單位)。

預設值：900 秒

附註：此元素值會提供為 <Path> 的一部份，因此在此先略過。

UTC

指定檔案中每個資料行的產生時間與時間格式。

預設值：現行時間 (採用 UTC 格式)。

應用程式會在內部將時間值轉換為 UTC。

範例：

2013-05-09 10:15 ("GranularityPeriod" 欄的值，採用 "yyyy-MM-dd HH:mm" 格式)

附註：如果您使用應用程式從靜態檔案取得資料，或不知道時間格式，請不要輸入值。處理資料時將使用預設時間。如果使用應用程式從靜態檔案取得資料，請在 EMS 整合設定檔中將 IGNORE_DOWNLOAD_HISTORY 參數值設定為 True。

DevicePackData

裝置套件使用您指定的資訊以便於新的度量系列中提供度量。這些資料元素會在儀表板中顯示為度量。度量名稱由那些您希望這個應用程式視為資料欄位的欄位名稱組成。

應用程式提供計數器度量特別的支援。您提供所有計數器度量 (欄位名稱) 的清單。

預設：度量名稱為量測計。

DevicePackKPI (關鍵效能指標元素)

裝置套件使用您指定的資訊建立不同於 CSV 中所提供的新度量與新度量系列。關鍵效能指標 (KPI) 是效能監控功能中的重要測量值。應用程式可支援 KPI 的識別與計算。

您可以根據特定值或多個值的組合，來評估關鍵效能指標。

您可以選擇是否指定 DevicePackKPI。

若要在裝置套件配置 XML 檔案中指定裝置套件元素資訊，請分別導覽至下列每個區段。在每個區段中，為您要產生之裝置套件指定所需的值。

請依循下列步驟:

為 DevicePackHeader Device 元素指定下列值：
重要！ 請確定您所提供的資訊正確無誤，讓應用程式能夠正確產生裝置套件。
裝置
```
<Device fixedValue="">
```
指定要在 CA Performance Center 的 [清查] 索引標籤中顯示為新裝置的名稱。

若要使用固定名稱，而不從這個裝置套件的檔案名稱或檔案內容讀取值，請指定此屬性。

如果您使用此屬性，即無須進一步完成 <Device> 的其他資訊。所有檔案都會與此裝置名稱產生關聯。

如果您未使用此屬性，則可以透過三種方式提供 <Device> 的資訊：
- 使用檔案名稱
- 使用檔案中的註解
- 使用檔案中的標頭
FileName
```
<FileName prefix="" suffix="">
```
```
<Value fileNamePattern="" isValueRegEx="true"></Value>
```
```
<Value fileNamePattern="" isValueRegEx="true"></Value>
```
```
</FileName>
```
如果檔案名稱中包含裝置名稱，請使用 <FileName>。

若要從字串擷取值，請提供規則運算式群組。如果未提供群組，此值將會空白。

如果各檔案的裝置名稱不相同，請使用 fileNamePattern 屬性，提供特定檔案名稱模式的專用規則運算式。

請確定 fileNamePattern 屬性是一般規則運算式 (沒有任何群組)。此運算式可比對檔案名稱，若找到相符項目，則會將 <Value> 的值 (具有 Group 的規則運算式) 套用至 FileName，以取得裝置名稱。

如果裝置名稱是固定值，就不需要提供規則運算式。此時應提供此固定值，然後將 isValueRegEx 屬性變更為 "false"。

比對會根據您所提供的順序執行，且會將第一個相符項目作為裝置。

您可以選擇提供可新增或附加至裝置名稱的前置詞或尾碼。

範例：
```
<FileName prefix="CA" suffix="Texas">
```
```
	<Value fileNamePattern="^.* PEB-U-NTHS_ifstat .*$"
```
```
isValueRegEx="true">^.*-(.*)_.*$</Value>
```
```
</FileName>
```
Filename = Bulk_PEB-U-NTHS_ifstat_24-12141617-58_up_1272018000.sts

Filename 符合 fileNamePattern

屬性 isValueRegEx 為 true，因此您將值 "^.*-(.*)_.*$" 套用至 Filename，以取得 "PEB-U-NTHS"

套用前置詞與尾碼，以取得 "CA_PEB-U-NTHS_Texas"

裝置名稱為 CA_PEB-U-NTHS_Texas

範例：
```
<FileName prefix="CA" suffix="Texas">
```
```
	<Value fileNamePattern=".*_ifstat_.*"
```
```
isValueRegEx="true">^.*_(.*)_.*$</Value>
```
```
	<Value fileNamePattern=".*system.*" 
```
```
isValueRegEx="false">Localhost</Value>
```
```
</FileName>
```
針對名稱與 fileNamePattern 中提供的模式相符的所有檔案，套用此規則運算式以取得裝置。

Filename = Bulk_PEB-U-NTHS_ifstat_24-12141617-58_up_1272018000.sts

裝置名稱為 CA_PEB-U-NTHS_Texas

Filename = Bulk_NPE-M-WiFi_ifstat_24-12141617-58_up_1272018000.sts

裝置名稱為 CA_ NPE-M - WiFi _Texas

Filename = Bulk_system_24-12141617-58_up_1272018000.sts

裝置名稱為 CA_ Localhost_Texas

Filename = Bulk_data_24-12141617-58.csv

裝置名稱為 null (空白)。
Comment
```
<Comment prefix="" suffix="">
```
```
	<LineNumber></LineNumber>
```
```
	<RegEx></RegEx>
```
```
</Comment>
```
如果裝置名稱位於檔案的註解區段中，請使用此屬性。

註解區段必須是 CSV 檔案的第一個項目，隨後是標頭與資料。

<LineNumber> 可指定從此行號的字串中選取裝置名稱。

<RegEx> 可指定對給定的行使用群組擷取規則運算式 (RegEx)。

若未提供規則運算式，則會將整行視為裝置。

若未提供行號，則會將第一個相符的規則運算式視為裝置。

您可以選擇提供可新增或附加至裝置名稱的前置詞或尾碼。
標頭
```
<Headers>
```
```
<Header prefix="" suffix="">
```
```
		<ColumnName></ColumnName>
```
```
		<RegEx></RegEx>
```
```
	</Header>
```
```
</Headers>
```
如果裝置名稱位於檔案的標頭區段中，請使用此屬性。

從名稱與 <ColumnName> 的值相符的欄中選取裝置名稱。在 CSV 檔案中，標頭是由欄名稱組成。每欄名稱會以分隔符號隔開。分隔符號也會將 CSV 中的所有資料行分隔，且僅對應於一個欄名稱。

<RegEx> 可指定要對指定欄名稱的值使用的群組擷取規則運算式。

若未提供規則運算式，則會將該欄的完整值視為裝置。

若未提供 <ColumnName>，則會將 <RegEx> 套用至整個資料行以取得值。

您可以選擇提供可新增或附加至裝置名稱的前置詞或尾碼。

如果值位於多欄中，請提供相同數量的 <Header> 屬性。值會依照它們在每個此類的 <Header> 中出現的順序附加，以形成最終值。

附註：若有多個標頭，則會透過 _ 連結這些值。
順序
```
<Sequence prefix="" suffix="">
```
```
	<SeqElement></SeqElement>
```
```
	<SeqElement></SeqElement>
```
```
</Sequence>
```
<Sequence> 是選用項目。

如果您要將多個值結合為一個值，請使用 <Sequence>。

範例：
```
<Sequence prefix="" suffix="">
```
```
	<SeqElement>FileName</SeqElement>
```
```
	<SeqElement>Comment</SeqElement>
```
```
</Sequence>
```
將選取自 <FileName> 與 <Comment> 的值相結合，以取得最終值。

可接受的值：FileName、Comment 或 Header

您可以選擇提供可新增或附加至裝置名稱的前置詞或尾碼。

附註：若有多個順序，則會透過 _ 連結這些值。
指定 DevicePackHeader Branch 元素的值。
Branch 值結合了裝置套件名稱值以形成新的度量系列。

附註：Branch DevicePackHeader 元素的選項與 Device DevicePackHeader 元素的選項相同。
指定 DevicePackHeader BranchDesc 元素的值。
BranchDesc 值結合了 Branch 值以形成新的裝置元件。這些裝置元件顯示在 CA Performance Center 中的 [清查] 索引標籤中。

附註：BranchDesc DevicePackHeader 元素的選項與 Device DevicePackHeader 元素的選項相同
指定 DevicePackHeader DeviceIP 元素的值。
附註：DeviceIP DevicePackHeader 元素的選項與 Device DevicePackHeader 元素的選項相同
指定 DevicePackHeader UTC 元素的值。
附註：UTC DevicePackHeader 元素的選項，與 Device、Branch 和 BranchDesc DevicePackHeader 元素的選項大致相同，差別在於另有一屬性會說明此檔案所使用的 timeFormat 格式。

下列資訊說明此一新屬性如何成為 <UTC> 標籤的一部份：
```
<UTC fixedValue="" timeFormat="">
```
附註：如果您使用應用程式從靜態檔案取得資料，請不要提供 [檔案名稱]、[註解] 和 [標頭] 的值。

下表說明您可以使用的 timeFormat 格式：

字母	日期或時間元件	表示法	範例
G	年代指示符號	文字	AD
y	年	年	1996; 96
M	一年中的月份	月	July; Jul; 07
w	一年中的週次	Number	27
W	一個月中的週次	Number	2
D	一年中的某日	Number	189
d	一個月中的某日	Number	10
F	一個月中的星期幾	Number	2
E	一週中的某日	文字	Tuesday; Tue
a	AM 或 PM 標記	文字	PM
H	一日中的時刻 (0-23)	Number	0
k	一日中的時刻 (1-24)	Number	24
K	以 AM 或 PM 表示的時刻 (0-11)	Number	0
h	以 AM 或 PM 表示的時刻 (1-12)	Number	12
m	一小時中的分鐘	Number	30
s	一分鐘中的秒	Number	55
S	毫秒	Number	978
z	時區	一般時區	Pacific Standard Time; PST; GMT-08:00
Z	時區	RFC 822 時區	-0800

為 DevicePackData 元素指定下列值。這些值會在 CA Performance Center 儀表板中顯示為度量。
```
<DevicePackData  endOfData=””>
```
```
	<Range fileNamePattern="">
```
```
		<Column>
```
```
			<Start></Start>
```
```
			<End></End>
```
```
		</Column>
```
```
		<Column>
```
```
			<Start></Start>
```
```
			<End></End>
```
```
		</Column>
```
```
	</Range>
```
```
</DevicePackData>
```
DevicePackData

指定要在 CSV 檔案中擷取實際資料的位置。

endOfData
指定應用程式如何識別已到達檔案中的資料結尾。提供用來與每一行比對的規則運算式。與此規則運算式相符的第一行，會被視為此檔案的資料結尾。在應用程式偵測到資料結尾時，即會移至下一個檔案。 endOfData 是選用項目；如果 endOfData 保留為空白，應用程式即會讀取至最後一行。

範例：
```
endOfData=”##EOF##”
```
前述範例顯示，應用程式會讀取檔案的所有行，直到到達符合 "##EOF##" 的一行為止。在找到相符項目時，該檔案的處理隨即停止，並開始處理下一個檔案。

您可以提供多個 <Range> 屬性。

您所使用的每個 <Range> 屬性表示：
```
fileNamePattern 
```
如果指定的 <Range> 適用於特定檔案，請使用 fileNamePattern。如果 fileNamePattern 保留為空白，則會將指定的 <Range> 套用至所有檔案。

指定要作為開頭的欄號 (而非名稱)，以及要作為結尾的欄號 (而非名稱)。如果您不要將所有欄都視為資料，請使用此屬性。

預設值：將所有欄都視為資料。

範例：
```
<Range fileNamePattern="PM_IG.*" >
```
```
	<Column>
```
```
		<Start>4</Start>
```
```
		<End>7</End>
```
```
	</Column>
```
```
	<Column>
```
```
		<Start>8</Start>
```
```
		<End>11</End>
```
```
	</Column>
```
```
</Range>
```
前述範例顯示下列資訊：
- Range 僅適用於名稱以 "PM_IG" 開頭的檔案。
- 應用程式只會將下列欄視為含有資料 (報告中顯示的度量)：
欄號 4、欄號 5、欄號 6 與欄號 7；欄號 8、欄號 9、欄號 10 與欄號 11。
(選擇性) 為 DevicePackKPI 元素指定下列值：
```
<DevicePackKPI>
```
```
<Range fileNamePattern=""    addAsNewBranch="false">
```
```
	<MetricsAsCounter></MetricsAsCounter>
```
```
	<Expression name=""></Expression>
```
```
	<Expression name=""></Expression>
```
```
</Range>
```
```
<Range fileNamePattern=""   addAsNewBranch ="true">
```
```
	<Expression name=""></Expression>
```
```
	<Expression name=""></Expression>
```
```
</Range>
```
若要指定包含 KPI 資訊的 <Range> 是否專用於特定檔案，請使用 fileNamePattern 屬性。此屬性如果空白，將會用於所有檔案。建議您提供 fileNamePattern 屬性的值，使應用程式能夠正確評估每個 CSV 檔案的 KPI 資訊。

若要指定要將 KPI 資訊新增為個別分支，或是將其納入現有分支中，請使用 addAsNewBranch 屬性。以下是 addAsNewBranch 屬性所使用的值：

true

指定要新增為新的分支，並將其視為此裝置套件的個別或新的度量系列。

新的度量系列名為：<DevicePackName>KPI<BranchName>。

false

指定要納入現有分支中，成為此裝置套件現有度量系列的一部份。

此時會新增新度量，但不會產生新的度量系列。

true 或 false 以外的任何字串

指定要新增為新分支，並使用此字串作為此新分支的名稱。

新的度量系列名為：<DevicePackName> <String>。

MetricsAsCounter

指定執行 KPI 計算時，要作為計數器的度量 (欄位名稱)。

計數器代表一組變數，其值為隨時間增加的未指派整數。這個數字永遠不會變小，只會增加。

您可以以逗號分隔清單指定一個以上的度量。

範例：

<MetricsAsCounter>Column Name1, Column Name2</MetricsAsCounter>

每個 <Expression> 都會指定用以評估 KPI 的欄名稱，以及執行評估的方式。評估完成後會取得一個值，此值會以 name 的值作為度量名稱，新增為新的度量。

<Expression> 的值必須是有效的數學運算式。目前支援四個運算子：+、-、*、/ 分別代表加、減、乘、除。在 <Expression> 中可以使用括弧 ( 和 )。

每個此類 <Expression> 都至少要有一個欄名稱。 <Expression> 中所使用的欄名稱必須完全符合 CSV 檔案中的欄名稱。

您可以透過多種方式來建構 <Expression>，如下列範例 CSV 檔案所說明。

範例 CSV 檔案內容：

Citrix,Type_of_service,Location,Bytes Sent,Bytes Received, Response time,SystemUpTime

citrix_1,USAC,Spain,31464,49232,1461,1000

citrix_2,USAC,Colombia, 32732,44824,1004,1900

citrix_3,USAC,London, 10732,24824,300,3000
```
<MetricsAsCounter>SystemUpTime<MetricsAsCounter>
```
```
<Expression name=”UpTimeInMinutes”>SystemUpTime/60<Expression>
```
在這個範例中，每個資料行都將建立一個名為 UpTimeInMinutes 的新度量，並以 0 作為第一個資料行的值。 (1900-1000)/60 = 15.00 為第二個資料行，(3000-1900)/60 = 18.33 為第三個資料行。
```
<Expression name="ByteOutPercentage">(Bytes Sent / 100)</Expression>
```
在此範例中，會為每個資料行建立名為 ByteOutPercentage 的新度量，且顯示的第一個資料行會具有 31464/100 = 314.64 之類的值，另外兩個資料行也類似於此。

附註：出現在「CSV 標頭」之後、endOfData 之前的字行，會被視為資料行。
```
<Expression name="ByteOutPercentage">(Bytes Sent,>,20000) / 100</Expression>
```
對於 [已傳送位元組] 欄中的值大於 20000 的每個資料行，會建立名為 ByteOutPercentage 的新度量。在此範例中，第三個資料行不符合此條件。

下列資訊說明支援的條件運算子：

<

小於

只有在 A 小於 B 時，(A,<,B) 才會是 true。

>

大於

只有在 A 大於 B 時，(A,>,B) 才會是 true。

=

等於

只有在 A 等於 B 時，(A,=,B) 才會是 true。

>=

大於或等於

只有在 A 大於或等於 B 時，(A,>=,B) 才會是 true。

<=

小於或等於

只有在 A 小於或等於 B 時，(A,<=,B) 才會是 true。

!=

不等於

只有在 A 不等於 B 時，(A,!=,B) 才會是 true。
- 使用條件運算式的語法如下：(ColumnName, operator, Number)
- 請在語法兩側加上括弧。
- 數字可以是整數或十進位數 (實數)。
請確認 ColumnName 與 CSV 檔案中顯示的完全相同，否則應用程式會報告找不到該欄的錯誤。

附註：只有在 addAsNewBranch 為 true 時，KPI 計算才會忽略不符合此條件的資料行。如果 addAsNewBranch 為 false，則會使用預設值 0 作為此運算式的值。使用此預設值，可確保每個現有的度量系列都會有相同數量的度量。
```
<Expression name="TotalByteTransaction">Bytes Sent + Bytes Received</Expression>
```
對於每個資料行都會建立名為 TotalByteTransaction 的新度量，且第一個資料行會的值會是 31464 + 49232 = 80696，其他資料行也類似於此。
```
<Expression name="AverageResponseTime">sum(Response Time) / CSV_TOTAL_DATA_LINE </Expression>
```
對於每個檔案都會建立新的分支。此分支會有名為 AverageResponseTime 的新度量。 AverageResponseTime 的值為 (1461+1004+300)/3 = 921.6。

CSV_TOTAL_DATA_LINE 是應用程式的關鍵字，用以說明指定檔案的資料行總數。

附註：對於必須就個別檔案評估的 KPI，會建立新的分支。因此，您會使用 addAsNewBranch=”true” 或 addAsNewBranch=”some_name” 來指定。預設行為是將檔案新增為新分支。

應用程式支援下列累加運算子，供您指定個別檔案的 KPI：

sum(columnName)

新增 columnName 的值，並傳回所有資料行的總值。

sum(columnName,<,100)

新增 columnName 的值，並針對 columnName 的值大於 100 的所有資料行傳回其總值。

count(columnName,!=,100)

傳回此 CSV 檔案中 columnName 的值不等於 100 的總行數。

附註：任何無效的運算式在應用程式處理 CSV 檔案時都會被報告為錯誤。根據 <OnFailure> 的值，應用程式會略過目前的檔案，或結束處理。

此時會指定 DevicePackKPI 元素的值。

裝置套件元素資訊是在配置 XML 檔案中指定的。