本文說明 DCR 的 JSON 結構,適用於您需要直接使用其定義的案例。
- 關於本文所述 JSON 的操作細節,請參見「建立與編輯 DCR」。
- 關於不同情境的樣本,請參見
Azure 監視器。
屬性
資源層級 kind 屬性用以識別 DCR 的資料收集情境。 它是在資源層級定義的,也就是物件之外 properties 。 其他設定,包括 dataSources、 dataFlows和 transformations,則置於 properties下。
下表描述一般的DCR特性。 除了 kind,這些性質都被巢狀地包覆在 properties之下。
本文後面的 DCR 資料流程概述將描述資料收集與處理設定。
| 財產 | 說明 |
|---|---|
description |
使用者所定義之數據收集規則的選擇性描述。 |
dataCollectionEndpointId |
如果你在建立 DCR 時提供資料 收集端點(DCE ),則是 DCR 所使用的資源 ID。 此屬性不存在於不使用 DCE 的 DCR 中。 |
endpoints
1 |
包含 DCR 端點的 logsIngestion 和 metricsIngestion URL。 當且僅當 DCR 中的 kind 屬性為 Direct 時,本節及其屬性會被自動創建。 |
immutableId |
資料收集規則的唯一識別碼。 建立 DCR 時,會自動建立此屬性及其值。 |
kind |
指定 DCR 所使用的資料收集案例。 此參數將在下一節進一步說明。 |
1 2024年3月31日之前建立的DCRs不具備該 endpoints 物業。 它們需要一個獨立的資料 收集端點(DCE),由 dataCollectionEndpointId. 若要使用 DCR 擷取端點,請建立一個新的 DCR,並將 kind 設為 Direct。
種類
該 kind 屬性指定資料收集情境,而非單一資料來源類型。 情境決定了DCR使用的設定。
下表列出不同類型的 DCR 及其詳細數據。
| 種類 | 說明 |
|---|---|
Direct |
使用 日誌擷取 API 直接擷取。 只有在使用這種值時,才會為 DCR 建立端點。 |
AgentSettings |
透過 配置 Azure 監視器 代理設定,例如本地快取大小和 OTLP 監聽器埠口。properties.agentSettings |
Linux |
從 Linux 機器收集事件和效能數據。 |
PlatformTelemetry |
匯出平台指標。 |
Windows |
從 Windows 電腦收集事件和效能數據。 |
WorkspaceTransforms |
將 工作空間轉換 套用於支援的資料表。 此 DCR 路由標準輸入串流,卻未定義如何收集。 |
DCR 數據流概觀
下圖顯示 DCR 的基本流程。 下列各節將說明每個元件。
在收集情境中,資料會從 資料來源 經 輸入流 和 資料流 傳送到 目的地。 不是每個 DCR 都會用到所有元件。 下表說明每個屬性的角色與用途。 此表中的所有屬性皆置於 properties之下。
| 財產 | 角色與劇情 |
|---|---|
dataSources |
為 Azure 監視器 Agent(AMA)配置來自 Windows 事件、Syslog 及效能計數器的收集。
Linux
Windows DCR 則使用這些收集設定。 |
directDataSources |
透過 、 otelMetrics、 及 otelTraces配置直接的 OpenTelemetry 日誌、指標與追蹤。otelLogs |
streamDeclarations |
定義客戶定義架構資料的自訂輸入串流結構,包括透過日誌擷取 API 傳送或由 AMA 收集的資料。 Syslog 或 Windows 事件的多階段處理也可能產生需要宣告的自訂串流。 標準架構不需要自訂宣告。 |
dataFlows |
將輸入串流路由至目的地並指定擷取時間轉換。 工作空間轉換 DCR 路由標準輸入流,卻未定義如何收集這些資料。 |
destinations |
定義由資料流參考的命名目的地。 工作區轉換 DCR 只能將資料傳送到它所關聯的工作區。 |
transformations |
定義多階段轉換的命名處理器管線(預覽)。 資料來源或資料流透過 選擇一條管 transform線。 此性質與內列 dataFlows[].transformKql性分開。 |
references |
定義其他 DCR 部門使用的資源,例如 Application Insights 用於 OpenTelemetry 豐富化的參考,以及由資料流參考的豐富化資料。 |
agentSettings |
在主機上設定代理行為,包括本地快取大小與 OTLP 監聽器埠口。 |
ARM 範本參考描述了所選 API 版本的資源格式與屬性類型。 其資源格式是財產清單,而非需要填寫每個欄位的工作範例。 使用該設定來處理你的收藏情境。 多階段轉換需要API版本 2025-05-11 或更新版本,詳見 多階段DCR考量。
資料輸入
DCR 的資料輸入設定會指定資料如何到達 Azure 監視器,以及其輸入串流的結構。 集合設定與結構宣告有不同的用途,如下表所示。 有些情境需要兩者兼具,例如使用 AMA 進行文字日誌收集。
| Purpose | 財產 | 說明 |
|---|---|---|
| 集合設定 | dataSources |
設定 AMA 如何收集資料,例如 Windows 事件、Syslog、效能計數器及日誌檔案。 |
| 集合設定 | directDataSources |
設定直接的 OpenTelemetry 日誌、指標與追蹤資料。 請參閱 直接資料來源。 |
| 攝取終點 | endpoints |
提供 DCR 產生的擷取端點 URL,供直接將資料傳送至 Azure 監視器 的用戶端使用。 |
| 結構宣告 | streamDeclarations |
定義每個自訂輸入串流的結構,無論資料是透過擷取 API 還是來自代理程式。 |
備註
工作區轉換的 DCR 並不定義輸入收集。 他們會將標準輸入串流導向其對應的工作區。
透過日誌擷取 API streamDeclarations 傳送的資料,用來定義接收資料的結構。
使用 AMA 的文字日誌收集用於 dataSources 設定檔案收集及 streamDeclarations 定義輸入資料的結構。 多階段處理產生的自訂串流也需要串流宣告。
數據源
資料來源是獨特的監控資料來源,每個來源都有其獨特的格式與揭露方式。 每種資料來源類型都有一組獨特的參數,必須為每個資料來源設定。 資料來源通常會回傳已知的資料型別,所以你不需要在 DCR 裡定義這個結構。
例如,使用Azure 監視器代理(AMA)從虛擬機收集的事件與效能資料,會使用windowsEventLogs 和 performanceCounters 等資料來源。 你可以指定事件和效能計數器的條件,但不需要定義資料本身的結構,因為這個結構是已知的潛在輸入資料。
常見資料來源參數
以下參數描述資料來源命名、資料流與轉換。 此 transform 特性僅適用於支援多階段轉換的資料來源。
| 參數 | 說明 |
|---|---|
name |
用來識別 DCR 中數據源的名稱。 |
streams |
資料來源所收集的溪流清單。 若此串流為標準資料型態,如Windows事件,則顯示為 Microsoft-<TableName>。 如果是自訂類型,串流會顯示為 Custom-<TableName>。 |
transform |
(預告)從 transformations 應用到用戶端的區段中轉換的名稱。 使用此特性進行多階段轉換。 參見 多階段轉換。 |
有效的數據源類型
下表描述了常見的資料來源類型。 關於更多類型及其屬性,請參見 ARM 範本參考。
| 資料來源類型 | 說明 | 溪流 | 參數 |
|---|---|---|---|
eventHub |
來自 Azure 事件中樞的數據。 | Custom1 |
consumerGroup - 要從中收集的事件中樞取用者群組。 |
iisLogs |
來自 Windows 電腦的 IIS 記錄 | Microsoft-W3CIISLog |
logDirectories - IIS 記錄儲存在客戶端的目錄。 |
logFiles |
虛擬機上的文字或 JSON 日誌 | Custom1 |
filePatterns - 用於從用戶端收集日誌檔案的資料夾與檔案模式。format
-
json 或 text |
performanceCounters |
Windows 和 Linux 虛擬機器的效能計數器 | Microsoft-PerfMicrosoft-InsightsMetrics |
samplingFrequencyInSeconds - 應取樣效能數據的頻率。counterSpecifiers - 應收集的物件和計數器。 |
prometheusForwarder |
從 Kubernetes 叢集收集的 Prometheus 數據。 | Microsoft-PrometheusMetrics |
streams - 要收集的數據流labelIncludeFilter - 包含標籤的篩選條件清單以名稱-值對呈現。 目前只 microsoft_metrics_include_label 支援。 |
syslog |
在 Linux 虛擬機器上的 Syslog 事件 安全性應用裝置上常見事件格式的事件 |
Microsoft-SyslogMicrosoft-CommonSecurityLog 適用於 CEF |
facilityNames - 用於收集的設施logLevels - 要收集的記錄層級 |
windowsEventLogs |
虛擬機器上的 Windows 事件記錄檔 | Microsoft-Event |
xPathQueries - XPaths,指定應收集之事件的準則。 |
extension |
Azure 監視器代理程式所使用的擴充功能型數據源。 | 依延伸模組而異 |
extensionName - 延伸模組的名稱extensionSettings - 延伸模組所需之每個設定的值 |
1 這些數據源同時使用數據源和數據流宣告,因為它們收集的數據架構可能會有所不同。 數據源中使用的數據流應該是數據流宣告中定義的自定義數據流。
直接資料來源
該 directDataSources 物件包含 otelLogs、 otelMetrics以及 otelTraces OpenTelemetry 資料的集合。 每條目都包含名稱和溪流,並附有額外設施供豐富化。 關於屬性定義,請參見 DataCollectionRuleDirectDataSources。
ARM 參考資料也列出了 OpenTelemettry 的日誌、指標與追蹤資料 dataSources。 這些都是資源格式中獨立的收藏。 僅憑清單本身並不能建立代理人要求,或要求在兩個收藏間重複條目。
資料流宣告
宣告你送入 Log Analytics 工作空間的不同資料類型。 每個資料流都是物件,其索引鍵代表資料流名稱,開頭必須是 Custom- 。 串流包含你傳送的 JSON 資料中的完整頂層屬性清單。 您傳送至端點的資料型態不必符合目的地資料表的資料型態。 但在最上層輸入資料上的轉換輸出必須符合目的地型態。
數據類型
將以下資料型態指派給屬性:
stringintlongrealbooleandynamicdatetime
這個 guid 類型在串流宣告中沒有。 如果你的來源資料包含 GUID 值,請將這些欄位宣告為 string。 Tables API 支援這個型別, guid 但這些值實際上是以字串的形式儲存和查詢的。 欲了解更多資訊,請參閱Azure 監視器日誌<>中的
References
該 references 物件定義了 DCR 其他部門所使用的資源。 它不會將資料導向目的地。
-
applicationInsights定義了用於 OpenTelemetry 豐富化的命名 Application Insights 資源參考。 OpenTelemetry 資料來源的條目用於enrichWithReference選擇參考。 -
enrichmentData定義由資料流參考的豐富資料來源,包括儲存區塊。
關於支援欄位,請參見 DataCollectionRuleReferences。
代理設定
該 agentSettings 物件負責配置主機上的代理行為,包括本地快取大小及 OTLP 監聽器埠。 其 logs 與 metrics 集合包含 AMA 的命名設定與值。 有關支援的設定與設定說明,請參閱 Azure 監視器 Agent 設定。 關於資源結構,請參見 DataCollectionRuleAgentSettings。
目的地
在該 destinations 區塊中為每個傳送資料的目的地提供一個條目。 將這些目的地與該區段的 dataFlows 輸入串流相匹配。
常見的目的地參數
| 參數 | 說明 |
|---|---|
name |
名稱用於指涉該區段的 dataSources 目的地。 |
有效的目的地
下表列出可前往的目的地。
| 目的地 | 說明 | 必要參數 |
|---|---|---|
azureDataExplorer |
Azure Data Explorer |
resourceId - ADX 叢集的資源識別碼databaseName - ADX 叢集中資料庫名稱ingestionUri - 叢集的攝取 URI |
azureMonitorMetrics |
Azure 監視器度量值 | 不需要設定,因為訂用帳戶只有單一計量存放區。 |
logAnalytics |
Log Analytics 工作區 |
workspaceResourceId - 工作區的資源識別碼。workspaceID - 工作區的識別碼這個參數只指定工作區,而非資料傳送的表格。 如果是已知的目的地,那你就不需要指定表格。 自訂資料表請在資料來源中指定資料表。 |
microsoftFabric |
Microsoft Fabric Eventhouse |
tenantId - Fabric 工作區的租戶 IDdatabaseName - Fabric 事件倉資料庫名稱ingestionUri
-
Fabric eventhouse 資料庫的 URI 匯入 |
這很重要
一個資料流只能傳送至 DCR 中的一個 Log Analytics 工作區。 如果單一資料流使用相同工作區中的不同資料表,您可以有多個 dataFlow 項目。 如果您需要將資料從單一資料流傳送至多個 Log Analytics 工作區,請為每個工作區建立個別的 DCR。
數據流
資料流會將串流與目的地匹配。 每個資料流程可選擇性地指定一個資料擷取時間轉換,有時還能在 Log Analytics 工作空間中指定特定資料表。
數據流屬性
| 區段 | 說明 |
|---|---|
streams |
一個或多個標準輸入串流或定義於 的自訂串流。streamDeclarations 如果你想將多個資料來源傳送到同一目的地,可以在單一資料流中包含多個串流。 只有在資料流包含轉換時才使用單一串流。 當你想將特定資料來源傳送到同一 Log Analytics 工作區的多個資料表時,使用同一個資料流處理多個資料流。 |
destinations |
上述 destinations 一節中的一或多個目的地。 多路連接案例允許多個目的地。 |
transform |
(預告)從該區段進行的轉換 transformations 名稱,該轉換在擷取時應用。 與 transformKql互斥。 參見 多階段轉換。 |
transformKql |
套用至傳入資料流的選擇性轉換。 轉換必須了解傳入資料的結構描述,並依照目標資料表的結構描述輸出資料。 如果您使用轉換,則資料流程應只使用單一資料流。 與 transform互斥。 |
outputStream |
描述要將資料傳送至 destination 屬性下指定工作區中的哪個資料表。 當數據匯入至標準數據表時,outputStream的值具有格式Microsoft-[tableName];而匯入至自定義數據表時,則具有格式Custom-[tableName]。 每個資料流只允許一個目的地。此屬性不會用於來自 Azure 監視器的已知資料來源,例如事件和效能資料,因為會將這些資料傳送至預先定義的資料表。 |
Transformations
這很重要
多階段轉型目前正處於公開預覽階段。 本節需 API 版本或更高版本 2025-05-11 。 請參閱Microsoft Azure 預覽的補充使用條款,以了解適用於 Azure 測試版、預覽版或其他尚未正式發布的功能的法律條款。
本 transformations 節定義了可 dataSources 重複使用的命名轉換,由 和 dataFlows參考。 每個轉換定義一條處理器的管 線,依 序應用於資料。 關於概念細節,請參見 多階段變換 。
透過以下 transform 屬性為處理階段指派命名的轉換:用於 dataSources 用戶端處理或 dataFlows 資料擷取時間處理。 資料流支援在 中的 transformKql 內嵌 KQL 查詢,或在 中引用命名的多階段管線 transform,但兩者皆不能同時支援。
"transformations": [
{
"name": "my_transform",
"headerProcessor": {
"processor": "header.Syslog",
"configuration": { }
},
"processors": [
{
"processor": "filter.Basic",
"configuration": {
"any": [
{
"all": [
{
"columnName": "Facility",
"operator": "==",
"value": "auth"
}
]
}
]
}
}
]
}
]
轉換物件屬性
| 財產 | 類型 | Required | 說明 |
|---|---|---|---|
name |
字串 | Yes | 這種變身的獨特名稱。 參考資料: dataSources[].transform 及 dataFlows[].transform。 |
headerProcessor |
物件 | Yes | 標頭處理器建立起始結構。 一定是第一個元素。 請參見 標頭處理器。 |
processors |
陣列 | No | 有序的轉換處理器序列在標頭之後套用。 請參見 處理器類型。 |
處理器物件
每個處理器都是一個宣告式的建構單元,用以描述特定的資料轉換操作。
{
"processor": "{family}.{Name}",
"configuration": { }
}
| 財產 | 類型 | Required | 說明 |
|---|---|---|---|
processor |
字串 | Yes | 處理器名稱格式為 {family}.{Name}。 區分大小寫。 例如: filter.Basic 。 |
configuration |
物件 | Yes | 針對特定處理器的配置。 請參閱各個處理器區塊。 |
處理器類型
下表顯示用戶端與擷取端可用的處理器。
- 用戶端標頭處理器用於指派給資料來源的用戶端轉換。 由於已知接收資料的結構,因此不需要設定。
- 資料流的擷取端標頭處理器用於指派給資料流的匯入端轉換。
| 處理器名稱 | 家族 | Client-side | 攝取端 |
|---|---|---|---|
header.Syslog |
Header | Yes | No |
header.WindowsEvents |
Header | Yes | No |
header.WindowsPerformanceCounters |
Header | Yes | No |
header.LinuxPerformanceCounters |
Header | Yes | No |
header.TextLog |
Header | Yes | No |
header.IISLog |
Header | Yes | No |
header.WindowsFirewallLog |
Header | Yes | No |
header.StandardStream |
Header | No | Yes |
header.CustomStream |
Header | No | Yes |
filter.Basic |
篩選 | Yes | Yes |
map.Rename |
Map | Yes | Yes |
map.Drop |
Map | Yes | Yes |
parse.JsonPath |
Parse | Yes | Yes |
parse.XmlPath |
Parse | Yes | Yes |
parse.CEFAttribute |
Parse | Yes | Yes |
aggregate.Basic |
Aggregate | Yes | Yes |
enrich.DNSLookup |
擴充 | Yes | Yes |
transform.KQL |
Transform | No | Yes |
標頭處理器
標頭處理器接收原始資料並將其轉換為已知的結構化表格格式。 標頭處理器必須是任何轉換中第一個處理器。
標題。系統日誌
syslog 資料來源的用戶端標頭。
輸出結構:
| Column | 類型 |
|---|---|
| 時間生成 | 日期時間 |
| 設施 | 字串 |
| SeverityNumber | int |
| EventTime | 日期時間 |
| HostIP | 字串 |
| Message | 字串 |
| ProcessId | 字串 |
| Severity | 字串 |
| Host | 字串 |
| 識別 | 字串 |
| Timestamp | 日期時間 |
標題。WindowsEvents
Windows 事件日誌資料來源的用戶端標頭。
輸出結構:
| Column | 類型 |
|---|---|
| 時間生成 | 日期時間 |
| TimeCreated | 日期時間 |
| PublisherId(出版商識別碼) | 字串 |
| 出版者名稱 | 字串 |
| Channel | 字串 |
| 日誌電腦 | 字串 |
| 事件編號 | int |
| 事件類別 | int |
| EventLevel | 字串 |
| UserName | 字串 |
| RawXML | 字串 |
| 事件說明 | 字串 |
| 渲染資訊 | 字串 |
| EventRecordId | int |
標題。WindowsPerformanceCounters
Windows 效能計數器資料來源的用戶端標頭。
輸出結構:
| Column | 類型 |
|---|---|
| 時間生成 | 日期時間 |
| 計數器名稱 | 字串 |
| CounterValue | real |
| 取樣率 | int |
| 計數器 | 字串 |
| 執行個體 | 字串 |
標題。LinuxPerformanceCounters
Linux 效能計數器資料來源的用戶端標頭。
輸出結構:
| Column | 類型 |
|---|---|
| 時間生成 | 日期時間 |
| Timestamp | 日期時間 |
| 計數器名稱 | 字串 |
| 物件名稱 | 字串 |
| 實例名稱 | 字串 |
| Value | int |
| Host | 字串 |
標題。文字日誌
客戶端標頭用於自訂文字日誌檔案。
輸出結構:
| Column | 類型 |
|---|---|
| 時間生成 | 日期時間 |
| FilePath | 字串 |
| 原始數據 | 字串 |
| Computer | 字串 |
標題。國際國際科學研究院(IISLog)
用戶端標頭用於 IIS 日誌資料來源。
輸出結構:
| Column | 類型 |
|---|---|
| 時間生成 | 日期時間 |
| s_sitename | 字串 |
| s_computername | 字串 |
| s_ip | 字串 |
| cs_method | 字串 |
| cs_uri_stem | 字串 |
| cs_uri_query | 字串 |
| s_port | int |
| cs_username | 字串 |
| c_ip | 字串 |
| cs_version | 字串 |
| cs_User_Agent_ | 字串 |
| cs_Cookie_ | 字串 |
| cs_Referer_ | 字串 |
| cs_host | 字串 |
| sc_status | int |
| sc_substatus | int |
| sc_win32_status | int |
| sc_bytes | int |
| cs_bytes | int |
| time_taken | int |
標題。WindowsFirewallLog
Windows 防火牆日誌資料來源的用戶端標頭。
輸出結構:
| Column | 類型 |
|---|---|
| 時間生成 | 日期時間 |
| date | 字串 |
| 時間 | 字串 |
| 動作 | 字串 |
| 通訊協定 | 字串 |
| src_ip | 字串 |
| dst_ip | 字串 |
| src_port | 字串 |
| dst_port | 字串 |
| size | 字串 |
| TCP旗 | 字串 |
| TCPSYN | 字串 |
| TCPACK | 字串 |
| TCPWIN | 字串 |
| icmptype | 字串 |
| ICMPCODE | 字串 |
| 資訊 | 字串 |
| 路徑 | 字串 |
| pid | 字串 |
標題。標準串流
當輸入是標準串流,如 Microsoft-Syslog 或 Microsoft-Event 時,會使用。
{
"processor": "header.StandardStream",
"configuration": {
"streamId": "Microsoft-Syslog"
}
}
| 財產 | 類型 | Required | 說明 |
|---|---|---|---|
streamId |
字串 | Yes | 標準串流的識別碼,例如 Microsoft-Syslog。 |
輸出結構:與標準 Log Analytics 表格結構相同。 請參見 Log Analytics 表格參考 以了解依資源類型的結構。
標題。自訂串流
當輸入是定義於 streamDeclarations的自訂串流時,會使用。
{
"processor": "header.CustomStream",
"configuration": {
"streamId": "Custom-MyStream"
}
}
| 財產 | 類型 | Required | 說明 |
|---|---|---|---|
streamId |
字串 | Yes | 自訂串流的識別碼。 必須與定義於 的 streamDeclarations串流相匹配。 |
標頭處理器之後
這些處理器在轉換管線中會跟在標頭處理器之後執行。 並非所有處理器在兩個階段都能使用。 請參閱 處理器適用性表 ,以判斷哪些處理器在用戶端、擷取端或兩者皆支援。
過濾。基本版
根據狀況評估,會刪除整條紀錄。 條件以 OR 群組 AND 群組的形式結構化。
{
"processor": "filter.Basic",
"configuration": {
"any": [
{
"all": [
{
"columnName": "Facility",
"operator": "==",
"value": "auth"
}
]
}
]
}
}
| 財產 | 類型 | Required | 說明 |
|---|---|---|---|
any |
AND 群組陣列 | Yes | 頂尖的手術室小組。 若有 AND 群組評為真,則會保留紀錄。 |
每個 AND 群組都有 all 包含條件物件陣列的屬性:
| 財產 | 類型 | Required | 說明 |
|---|---|---|---|
columnName |
字串 | Yes | 專欄進行評估。 |
operator |
字串 | Yes | 比較運算子。 字串: ==, !=, contains, !contains, 。 數值:==, !=, >, <, >=, , 。 <= |
value |
字串、數字或布林值 | Yes | 參考值可以用來比較。 |
輸出結構:與輸入相同。 是刪除紀錄,不是欄位。
地圖。更名
重新命名欄位並可選擇性地更改其類型。
{
"processor": "map.Rename",
"configuration": {
"all": [
{
"columnName": "OldName",
"nameAs": "NewName",
"typeAs": "string"
}
]
}
}
| 財產 | 類型 | Required | 說明 |
|---|---|---|---|
columnName |
字串 | Yes | 現有欄位可改名或定型。 |
nameAs |
字串 | No | 新欄名。 若省略,欄位名稱仍保留。 |
typeAs |
字串 | No | 目標類型:string、、int、longreal、booldatetime、。 若施法失敗,則 null 會退回。 |
輸出結構:與輸入相同,只是欄位名稱與類型變更的欄位不同。
地圖。掉落
從資料中刪除一個或多個欄位。
{
"processor": "map.Drop",
"configuration": {
"columnNames": ["Column1", "Column2"]
}
}
| 財產 | 類型 | Required | 說明 |
|---|---|---|---|
columnNames |
字串陣列 | Yes | 還有柱子要掉落。 |
輸出結構:與輸入相同,唯獨欄位被省略。
解析。JsonPath
解析欄位中的 JSON 格式字串,並將指定的鍵擷取到新的欄位。
{
"processor": "parse.JsonPath",
"configuration": {
"columnName": "EventData",
"all": [
{
"path": "$.user.name",
"nameAs": "UserName",
"typeAs": "string"
}
]
}
}
| 財產 | 類型 | Required | 說明 |
|---|---|---|---|
columnName |
字串 | Yes | 欄位包含 JSON 字串。 |
all |
抽取物件陣列 | Yes | 鑰匙要提取。 |
擷取物件屬性:
| 財產 | 類型 | Required | 說明 |
|---|---|---|---|
path |
字串 | Yes | JSON路徑指向鍵,例如 $.key 或 $.nested.key。 |
nameAs |
字串 | Yes | 新的輸出欄位名稱。 |
typeAs |
字串 | No | 目標類型。 若施法失敗,則 null 會退回。 |
輸出結構:與輸入相同,且每個提取的鍵都有新的欄位。
解析。XmlPath
解析欄位中的 XML 格式字串,並將指定元素擷取到新的欄位。
{
"processor": "parse.XmlPath",
"configuration": {
"columnName": "RawXml",
"all": [
{
"path": "/Event/System/EventID",
"nameAs": "EventID",
"typeAs": "int"
}
]
}
}
配置屬性相符 parse.JsonPath,但 path 使用 XPath 語法(例如 /Event/System/EventID/Event/EventData/Data[@Name='SubjectUserName']或 )。
輸出結構:與輸入相同,且每個擷取元素新增欄位。
備註
有效的 XPath 語法由每個階段的解析器函式庫所控制。 進階的 XPath 表達式可能僅支援特定的執行位置。
解析。CEFAttribute
解析欄位中的 CEF(通用事件格式)資料,並將指定欄位擷取到新的欄位。
{
"processor": "parse.CEFAttribute",
"configuration": {
"columnName": "Message",
"all": [
{
"path": "deviceAction",
"nameAs": "Action",
"typeAs": "string"
}
]
}
}
配置屬性與 相符 parse.JsonPath,但 path 指定 CEF 金鑰名稱。
輸出結構:與輸入相同,且每個擷取欄位新增欄位。
總體。基本版
使用具有分組維度的聚合運算子彙整紀錄。
{
"processor": "aggregate.Basic",
"configuration": {
"batchingSettings": {
"timeWindow": "5m",
"maxBatchRows": 1000
},
"aggregates": [
{
"columnName": "CounterValue",
"operator": "avg",
"nameAs": "AvgValue"
},
{
"operator": "count",
"nameAs": "RecordCount"
}
],
"dimensionColumns": ["Host", "CounterName"]
}
}
| 財產 | 類型 | Required | 說明 |
|---|---|---|---|
batchingSettings.timeWindow |
字串 | Yes | 每個聚合批次的時間跨度,例如 5m 或 1h。 |
batchingSettings.maxBatchRows |
int | Yes | 每個聚合批次的最大列數。 |
aggregates |
陣列 | Yes | 聚合定義。 |
dimensionColumns |
字串陣列 | Yes | 分組欄位。 只 string 支援一種類型。 |
骨料入口物業:
| 財產 | 類型 | Required | 說明 |
|---|---|---|---|
columnName |
字串 | No | 欄位轉為彙整。 但對操作員來說並非必要 count 條件。 |
operator |
字串 | Yes | 聚合函數: sum, avg, min, max, count, 。 |
nameAs |
字串 | Yes | 輸出欄位名稱用於彙總後的值。 |
輸出結構:聚合會完全改變輸出結構。 輸出僅包含聚合欄位與維度欄位。 將彙整的資料導向到獨立的自訂資料表。
豐富。DNSLookkup
在欄位中查詢 IP 位址,並新增 DNS 名稱欄位。
{
"processor": "enrich.DNSLookup",
"configuration": {
"columnName": "IPAddress",
"nameAs": "DNSName"
}
}
| 財產 | 類型 | Required | 說明 |
|---|---|---|---|
columnName |
字串 | Yes | 欄位包含 IP 位址,供查詢。 |
nameAs |
字串 | Yes | 已解析的 DNS 名稱新增輸出欄位名稱。 |
輸出結構:與輸入相同,新增已解析 DNS 名稱欄位。 DNS 解析是盡力而為。 若查詢失敗,輸出欄位包含 null。
變形。KQL
為進階情境套用自訂 KQL 表達式。 此處理器僅在擷取端運作,並提供有限的 KQL 驗證。 現有用於 transformKql 資料流的 DCR 與此處理器有直接的遷移路徑。
{
"processor": "transform.KQL",
"configuration": {
"expression": "source | where SeverityNumber >= 4 | extend EnrichedMsg = strcat(Host, ': ', Message)"
}
}
| 財產 | 類型 | Required | 說明 |
|---|---|---|---|
expression |
字串 | Yes | KQL 查詢字串套用到輸入資料。 |
輸出結構:由 KQL 定義,無法靜態驗證。