本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# 管道声明
<a name="pipe-object-declarations"></a>

使用*管道声明*连接源（请参阅[源声明](source-object-declarations.md)）添加到一个接收器（请参阅[接收器声明](sink-object-declarations.md)）在 Amazon Kinesis 代理 Microsoft Windows。管道声明表示为一个 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` 类型管道传输日志记录。所生成的结构化日志记录（例如，在 `DirectorySource` 声明中使用 `ExtractionPattern` 键/值对时），仍可使用 `RegexFilterPipe` 机制来筛选。这是因为此机制在解析之前对原始文本表示进行操作。此键/值对是可选的，但在管道指定 `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 生成指标的 Kinesis 代理传输到该接收器：

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

有关 Windows 的 Kinesis 代理内置指标源的更多信息，请参阅[Windows 内置指标源的 Kinesis 代理](source-object-declarations.md#kinesis-agent-builin-metrics-source)。

如果配置文件还流式传输 Windows 性能计数器指标，我们建议您使用单独的管道和接收器，而不是为 Windows 指标和 Windows 性能计数器指标使用相同的接收器。