本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# 管道宣告
<a name="pipe-object-declarations"></a>

使用*管道宣告*來連接來源（請參閱[來源宣告](source-object-declarations.md)）到一個接收器（請參閱[目的地宣告](sink-object-declarations.md)），以適用於 Microsoft Windows 的 Amazon Kinesis Kinesis 代理。管道宣告是以 JSON 物件來表示。Windows 版 Kinesis 代理程式啟動之後，系統即會從指定的管道來源收集日誌、事件或指標。然後，它們會被串流到使用該管道相關聯目的地的各種 AWS 服務。

下列為範例 管道宣告：

```
{
   "Id": "MyAppLogToCloudWatchLogs", 
   "SourceRef": "MyAppLog", 
   "SinkRef": "MyCloudWatchLogsSink" 
}
```

**Topics**
+ [設定管道](#kinesis-agent-pipe-configuration)
+ [設定 Windows 度量管道的 Kinesis 代理程式](#kinesis-agent-metric-pipe-configuration)

## 設定管道
<a name="kinesis-agent-pipe-configuration"></a>

所有管道宣告可以包含下列鍵/值對：

`Id`  
指定管道的名稱 (必要)。此項目在組態檔案中必須是唯一的。

`Type`  
指定當日誌資料從來源傳輸到目的地時管道要套用的轉換類型 (如果有)。唯一支援的值為 `RegexFilterPipe`。這個值可讓規則表達式篩選日誌記錄的基礎文字表示。使用篩選功能時只會將相關的日誌記錄向下游傳送到資料管道，而可以降低傳輸和儲存成本。這個鍵/值對是選用的。預設值是不提供轉換。

`FilterPattern`  
指定 `RegexFilterPipe` 管道的規則表達式，以用於篩選來源收集的日誌記錄，之後再傳輸至目的地。當規則表達式符合記錄的基礎文字呈現時，即會透過 `RegexFilterPipe` 類型管道傳輸日誌記錄。您仍可以使用 `RegexFilterPipe` 機制，來篩選在 `DirectorySource` 宣告中使用 `ExtractionPattern` 鍵/值對而產生的結構化日誌記錄。這是因為此機制會依據剖析之前的原始文字表示來運作。此鍵/值對是選用的，但如果管道指定 `RegexFilterPipe` 類型，您就必須提供此鍵/值對。  
下列為範例 `RegexFilterPipe` 管道宣告：  

```
{
	"Id": "MyAppLog2ToFirehose",
	"Type": "RegexFilterPipe",
	"SourceRef": "MyAppLog2",
	"SinkRef": "MyFirehose",
	"FilterPattern": "^(10|11),.*",
	"IgnoreCase": false,
	"Negate": false
}
```

`SourceRef`  
指定來源宣告的名稱 (`Id` 鍵/值對的值)，以定義為管道收集日誌、事件和指標資料的來源 (必要)。

`SinkRef`  
指定目的地宣告的名稱 (`Id` 鍵/值對的值)，以定義為管道接收日誌、事件和指標資料的目的地 (必要)。

`IgnoreCase`  
選用。接受值`true`或`false`。當設定為`true`，則正則表達式將以不區分大小寫的方式匹配記錄。

`Negate`  
選用。接受值`true`或`false`。當設定為`true`，管道將轉發*不*符合規則表達式。

如需使用 `RegexFilterPipe` 管道類型的完整組態檔案範例，請參閱 [使用管道](configuring-kaw-examples.md#configuring-kaw-examples-pipes)。

## 設定 Windows 度量管道的 Kinesis 代理程式
<a name="kinesis-agent-metric-pipe-configuration"></a>

您可以使用名為的內建指標來源`_KinesisTapMetricsSource`，可產生關於 Windows 適用的 Kinesis 代理程式的度量。如果有`CloudWatch`接收器聲明與`Id`的`MyCloudWatchSink`，以下範例管道宣告會將 Windows 產生的指標傳輸到該目的地：

```
{
   "Id": "KinesisAgentMetricsToCloudWatch",
   "SourceRef": "_KinesisTapMetricsSource",
   "SinkRef": "MyCloudWatchSink"
}
```

如需 Windows 專用的 Kinesis 代理程式內建指標來源的詳細資訊，請參閱[Windows 內建指標來源適用的 Kinesis 代理程式](source-object-declarations.md#kinesis-agent-builin-metrics-source)。

如果組態檔案也會串流 Windows 效能計數器指標，則不建議您對 Windows 指標和 Windows 效能計數器指標使用相同的目的地，而 Kinesis 使用個別的管道和目的地。