Rozhraní API pro příjem protokolů ve službě Azure Monitor

  • Článek

Rozhraní API pro příjem protokolů ve službě Azure Monitor umožňuje odesílat data do pracovního prostoru služby Log Analytics pomocí volání rozhraní REST API nebo klientských knihoven. Rozhraní API umožňuje odesílat data do podporovaných tabulek Azure nebo do vlastních tabulek, které vytvoříte. Schéma tabulek Azure můžete také rozšířit vlastními sloupci , aby přijímaly další data.

Základní operace

Data je možné odesílat do rozhraní API pro příjem protokolů z libovolné aplikace, která může volat rozhraní REST API. Může se jednat o vlastní aplikaci, kterou vytvoříte, nebo se jedná o aplikaci nebo agenta, která rozumí způsobu odesílání dat do rozhraní API. Aplikace odesílá data do koncového bodu shromažďování dat (DCE), což je jedinečný spojovací bod pro vaše předplatné Azure. Určuje pravidlo shromažďování dat (DCR), které zahrnuje cílovou tabulku a pracovní prostor a přihlašovací údaje registrace aplikace s přístupem k zadanému řadiči domény.

Data odesílaná vaší aplikací do rozhraní API musí být naformátovaná ve formátu JSON a musí odpovídat struktuře očekávané dcR. Nemusí nutně odpovídat struktuře cílové tabulky, protože řadič domény může obsahovat transformaci , která převede data tak, aby odpovídala struktuře tabulky. Cílovou tabulku a pracovní prostor můžete upravit úpravou dcR beze změny volání nebo zdrojových dat rozhraní API.

Diagram znázorňující přehled rozhraní API pro příjem dat protokolů

Konfigurace

Následující tabulka popisuje jednotlivé komponenty v Azure, které musíte nakonfigurovat, abyste mohli použít rozhraní API pro příjem protokolů.

Poznámka:

Skript PowerShellu, který automatizuje konfiguraci těchto komponent, najdete v ukázkovém kódu pro odesílání dat do služby Azure Monitor pomocí rozhraní API pro příjem protokolů.

Komponenta Function
Registrace a tajný kód aplikace Registrace aplikace se používá k ověření volání rozhraní API. Musí být udělena oprávnění k dcR popsanému níže. Volání rozhraní API zahrnuje ID aplikace (klienta) a ID adresáře (tenanta) aplikace a hodnotu tajného kódu aplikace.

Viz Vytvoření aplikace Microsoft Entra a instančního objektu, který má přístup k prostředkům a vytvořit nový tajný klíč aplikace.
Koncový bod shromažďování dat (DCE) DCE poskytuje koncový bod pro odeslání aplikace. Jeden řadič domény může podporovat více řadičů domény, takže můžete použít existující DCE, pokud už jeden máte ve stejné oblasti jako pracovní prostor služby Log Analytics.

Viz Vytvoření koncového bodu shromažďování dat.
Tabulka v pracovním prostoru služby Log Analytics Než do ní budete moct odesílat data, musí existovat tabulka v pracovním prostoru služby Log Analytics. Můžete použít některou z podporovaných tabulek Azure nebo vytvořit vlastní tabulku pomocí některé z dostupných metod. Pokud k vytvoření tabulky použijete Azure Portal, vytvoří se pro vás DCR, včetně transformace, pokud je to potřeba. Pokud máte jinou metodu, musíte dcR vytvořit ručně, jak je popsáno v další části.

Viz Vytvoření vlastní tabulky.
Pravidlo shromažďování dat (DCR) Azure Monitor používá pravidlo shromažďování dat (DCR) k pochopení struktury příchozích dat a toho, co s ním dělat. Pokud se struktura tabulky a příchozích dat neshoduje, řadič domény může obsahovat transformaci , která převede zdrojová data tak, aby odpovídala cílové tabulce. Pomocí transformace můžete také filtrovat zdrojová data a provádět jakékoli jiné výpočty nebo převody.

Pokud vytvoříte vlastní tabulku pomocí webu Azure Portal, vytvoří se řadič domény a transformace za vás na základě zadaných ukázkových dat. Pokud používáte existující tabulku nebo vytvoříte vlastní tabulku pomocí jiné metody, musíte řadič domény vytvořit ručně pomocí podrobností v následující části.

Po vytvoření dcR musíte udělit přístup k aplikaci, kterou jste vytvořili v prvním kroku. V nabídce Monitorování na webu Azure Portal vyberte pravidla shromažďování dat a pak řadič domény, který jste vytvořili. Vyberte řízení přístupu (IAM) pro DCR a pak vyberte Přidat přiřazení role a přidejte roli Vydavatel metrik monitorování.

Ruční vytvoření DCR

Pokud odesíláte data do tabulky, která už existuje, musíte řadič domény vytvořit ručně. Začněte s ukázkovým rozhraním DCR pro rozhraní API pro příjem protokolů a upravte následující parametry v šabloně. Pak pomocí některé z metod popsaných v tématu Vytvoření a úprava pravidel shromažďování dat (DCR) ve službě Azure Monitor vytvořte DCR.

Parametr Popis
region Oblast pro vytvoření dcR. Musí se shodovat s oblastí DCE a pracovním prostorem služby Log Analytics.
dataCollectionEndpointId ID prostředku vašeho DCE.
streamDeclarations Změňte seznam sloupců na sloupce v příchozích datech. Název datového proudu nemusíte měnit, protože to stačí, aby odpovídal názvu streams v dataFlowssouboru .
workspaceResourceId ID prostředku pracovního prostoru služby Log Analytics Název nemusíte měnit, protože to musí odpovídat destinations názvu v dataFlowssouboru .
transformKql Dotaz KQL, který se použije na příchozí data. Pokud schéma příchozích dat odpovídá schématu tabulky, můžete použít source pro transformaci, která příchozí data předá beze změny. V opačném případě použijte dotaz, který transformuje data tak, aby odpovídala schématu tabulky.
outputStream Název tabulky pro odeslání dat Pro vlastní tabulku přidejte předponu Custom-table-name><. Pro předdefinované tabulky přidejte předponu Microsoft-table-name><.

Klientské knihovny

Kromě volání rozhraní REST API můžete k odesílání dat do rozhraní API pro příjem protokolů použít následující klientské knihovny. Knihovny vyžadují stejné součásti popsané v konfiguraci. Příklady použití každé z těchto knihoven najdete v ukázkovém kódu pro odesílání dat do služby Azure Monitor pomocí rozhraní API pro příjem protokolů.

Volání rozhraní REST API

Pokud chcete odesílat data do služby Azure Monitor pomocí volání rozhraní REST API, proveďte volání POST přes protokol HTTP. Podrobnosti potřebné pro toto volání jsou popsány v této části.

Identifikátor URI koncového bodu

Identifikátor URI koncového bodu používá následující formát, ve kterém Data Collection EndpointDCR Immutable ID identifikuje DCE a DCR. Neměnné ID se vygeneruje pro DCR při jeho vytvoření. Můžete ho načíst ze zobrazení JSON DCR na webu Azure Portal. Stream Name odkazuje na datový proud v DCR, který by měl zpracovávat vlastní data.

{Data Collection Endpoint URI}/dataCollectionRules/{DCR Immutable ID}/streams/{Stream Name}?api-version=2023-01-01

Příklad:

https://my-dce-5kyl.eastus-1.ingest.monitor.azure.com/dataCollectionRules/dcr-000a00a000a00000a000000aa000a0aa/streams/Custom-MyTable?api-version=2023-01-01

Hlavičky

Následující tabulka popisuje hlavičky pro volání rozhraní API.

Hlavička Povinný? Popis
Autorizace Ano Nosný token získaný prostřednictvím toku přihlašovacích údajů klienta. Použijte hodnotu cílové skupiny tokenů pro váš cloud:

Veřejný cloud Azure – https://monitor.azure.com
Microsoft Azure provozovaný cloudem 21Vianet – https://monitor.azure.cn
Cloud Azure US Government – https://monitor.azure.us
Typ obsahu Ano application/json
Kódování obsahu No gzip
x-ms-client-request-id No IDENTIFIKÁTOR GUID formátovaný řetězcem Toto je ID požadavku, které může Microsoft používat pro všechny účely řešení potíží.

Text

Tělo volání obsahuje vlastní data, která se mají odesílat do služby Azure Monitor. Tvar dat musí být pole JSON se strukturou položek, která odpovídá formátu očekávanému datovým proudem v DCR. Pokud je potřeba odeslat jednu položku v rámci volání rozhraní API, měla by se data odeslat jako pole s jednou položkou.

Příklad:

[
{
    "TimeGenerated": "2023-11-14 15:10:02",
    "Column01": "Value01",
    "Column02": "Value02"
}
]

Ujistěte se, že je tělo požadavku správně zakódované v kódování UTF-8, aby se zabránilo problémům s přenosem dat.

Příklad

Příklad volání rozhraní API pomocí PowerShellu najdete v ukázkovém kódu pro odesílání dat do služby Azure Monitor pomocí rozhraní API pro příjem protokolů.

Podporované tabulky

Data odesílaná do rozhraní API pro příjem dat je možné odeslat do následujících tabulek:

Tabulky Popis
Vlastní tabulky Libovolná vlastní tabulka, kterou vytvoříte v pracovním prostoru služby Log Analytics. Cílová tabulka musí existovat před odesláním dat. Vlastní tabulky musí mít příponu _CL .
Tabulky Azure V současné době se podporují následující tabulky Azure. Do tohoto seznamu mohou být přidány další tabulky, protože jejich podpora je implementovaná.

Poznámka:

Názvy sloupců musí začínat písmenem a mohou obsahovat až 45 alfanumerických znaků a podtržítka (_). _ResourceId, id, , _SubscriptionId_ResourceId, , TenantId, Type, UniqueIda Title jsou vyhrazené názvy sloupců. Vlastní sloupce, které přidáte do tabulky Azure, musí mít příponu _CF.

Limity a omezení

Omezení související s rozhraním API pro příjem protokolů najdete v tématu Omezení služby Azure Monitor.

Další kroky