Logboekopname-API in Azure Monitor

Met de Logboekopname-API in Azure Monitor kunt u gegevens verzenden naar een Log Analytics-werkruimte vanaf elke REST API-client. Met deze API kunt u gegevens uit vrijwel elke bron verzenden naar ondersteunde ingebouwde tabellen of naar aangepaste tabellen die u maakt. U kunt zelfs het schema van ingebouwde tabellen uitbreiden met aangepaste kolommen.

Notitie

De Logboekopname-API werd eerder aangeduid als de API voor aangepaste logboeken.

Basisbewerking

Uw toepassing verzendt gegevens naar een eindpunt voor gegevensverzameling (DCE), een uniek verbindingspunt voor uw abonnement. De nettolading van uw API-aanroep bevat de brongegevens die zijn opgemaakt in JSON. De aanroep:

  • Hiermee geeft u een regel voor gegevensverzameling (DCR) op die de indeling van de brongegevens begrijpt.
  • Mogelijk filtert en transformeert deze voor de doeltabel.
  • Hiermee wordt deze omverwijst naar een specifieke tabel in een specifieke werkruimte.

U kunt de doeltabel en werkruimte wijzigen door de DCR te wijzigen zonder dat de REST API-aanroep- of brongegevens worden gewijzigd.

Diagram met een overzicht van de OPNAME-API voor logboeken.

Ondersteunde tabellen

Aangepaste tabellen

De Logboekopname-API kan gegevens verzenden naar elke aangepaste tabel die u maakt en naar bepaalde ingebouwde tabellen in uw Log Analytics-werkruimte. De doeltabel moet bestaan voordat u er gegevens naartoe kunt verzenden. Aangepaste tabellen moeten het _CL achtervoegsel hebben.

Ingebouwde tabellen

De Logboekopname-API kan gegevens verzenden naar de volgende ingebouwde tabellen. Andere tabellen kunnen aan deze lijst worden toegevoegd als ondersteuning voor deze tabellen wordt geïmplementeerd. Kolommen die boven op ingebouwde tabellen worden uitgebreid, moeten het achtervoegsel _CFhebben. Kolommen in een aangepaste tabel hebben dit achtervoegsel niet nodig. Kolomnamen kunnen bestaan uit alfanumerieke tekens en de tekens _ en -, en moeten beginnen met een letter.

Verificatie

Verificatie voor de Logboekopname-API wordt uitgevoerd op de DCE, die gebruikmaakt van standaard Azure Resource Manager-verificatie. Een algemene strategie is het gebruik van een toepassings-id en toepassingssleutel, zoals beschreven in Zelfstudie: Opnametijdtransformatie toevoegen aan Azure Monitor-logboeken.

Brongegevens

De brongegevens die door uw toepassing worden verzonden, zijn opgemaakt in JSON en moeten overeenkomen met de structuur die door de DCR wordt verwacht. Deze hoeft niet noodzakelijkerwijs overeen te komen met de structuur van de doeltabel, omdat de DCR een transformatie kan bevatten om de gegevens te converteren zodat deze overeenkomen met de structuur van de tabel.

Regel voor gegevensverzameling

Regels voor gegevensverzameling definiëren gegevens die worden verzameld door Azure Monitor en geven aan hoe en waar die gegevens moeten worden verzonden of opgeslagen. De REST API-aanroep moet een DCR opgeven die moet worden gebruikt. Eén DCE kan meerdere DCR's ondersteunen, zodat u een andere DCR voor verschillende bronnen en doeltabellen kunt opgeven.

De DCR moet de structuur van de invoergegevens en de structuur van de doeltabel begrijpen. Als de twee niet overeenkomen, kan een transformatie worden gebruikt om de brongegevens te converteren zodat deze overeenkomen met de doeltabel. U kunt de transformatie ook gebruiken om brongegevens te filteren en andere berekeningen of conversies uit te voeren.

Gegevens verzenden

Als u gegevens wilt verzenden naar Azure Monitor met de Logboekopname-API, doet u een POST-aanroep naar de DCE via HTTP. Details van de oproep worden beschreven in de volgende secties.

Eindpunt-URI

De eindpunt-URI gebruikt de volgende indeling, waarbij en Data Collection EndpointDCR Immutable ID de DCE en DCR identificeren. Stream Name verwijst naar de stroom in de DCR die de aangepaste gegevens moet verwerken.

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

Notitie

U kunt de onveranderbare id ophalen uit de JSON-weergave van de DCR. Zie Gegevens verzamelen van de DCR voor meer informatie.

Kopteksten

Header Vereist? Waarde Beschrijving
Autorisatie Yes Bearer (bearer-token verkregen via de clientreferentiestroom)
Content-Type Yes application/json
Content-Encoding No gzip Gebruik het gzip-compressieschema voor prestatieoptimalisatie.
x-ms-client-request-id No GUID met tekenreeksindeling Aanvraag-id die door Microsoft kan worden gebruikt voor het oplossen van problemen.

Hoofdtekst

De hoofdtekst van de aanroep bevat de aangepaste gegevens die naar Azure Monitor moeten worden verzonden. De vorm van de gegevens moet een JSON-object of matrix zijn met een structuur die overeenkomt met de indeling die door de stroom in de DCR wordt verwacht. Daarnaast is het belangrijk om ervoor te zorgen dat de aanvraagbody correct is gecodeerd in UTF-8 om problemen met gegevensoverdracht te voorkomen.

Voorbeeldoproep

Zie Aangepaste logboeken verzenden naar Azure Monitor-logboeken met behulp van de Azure Portal of Aangepaste logboeken verzenden naar Azure Monitor-logboeken met behulp van Resource Manager-sjablonen voor voorbeeldgegevens en een API-aanroep met behulp van de API voor logboekopname.

Limieten en beperkingen

Zie Azure Monitor-servicelimieten voor limieten met betrekking tot de Logboekopname-API.

Volgende stappen