HTTP 데이터 수집기 API를 사용하여 Azure Monitor에 로그 데이터 보내기(더 이상 사용되지 않음)
이 문서에서는 HTTP 데이터 수집기 API를 사용하여 REST API 클라이언트에서 Azure Monitor로 로그 데이터를 전송하는 방법을 보여 줍니다. 스크립트 또는 애플리케이션에서 수집한 데이터의 서식을 지정하고, 요청에 포함하고, 해당 요청에 대한 Azure Monitor의 인증을 받는 방법을 설명합니다. Azure PowerShell, C# 및 Python 예제가 제공됩니다.
참고 항목
Azure Monitor HTTP 데이터 수집기 API는 더 이상 사용되지 않으며 2026년 9월 14일부터 더 이상 작동하지 않습니다. 이는 로그 수집 API로 바뀌었습니다.
개념
HTTP 데이터 수집기 API를 사용하여 REST API를 호출할 수 있는 클라이언트에서 Azure Monitor의 Log Analytics 작업 영역으로 로그 데이터를 전송할 수 있습니다. 클라이언트는 Azure 또는 다른 클라우드에서 관리 데이터를 수집하는 Azure Automation의 Runbook이거나 Azure Monitor를 사용하여 로그 데이터를 통합하고 분석하는 대체 관리 시스템일 수 있습니다.
Log Analytics 작업 영역의 모든 데이터는 특정 레코드 종류의 레코드로 저장됩니다. JSON(JavaScript Object Notation)에서 여러 레코드로 HTTP 데이터 수집기 API에 보낼 데이터의 서식을 지정합니다. 데이터를 제출하면 개별 레코드가 요청 페이로드의 각 레코드에 대한 저장소에 만들어집니다.
요청 만들기
HTTP 데이터 수집기 API를 사용하려면 JSON에서 전송할 데이터가 포함된 POST 요청을 만듭니다. 다음 세 개 표에는 각 요청에 필요한 속성이 나와 있습니다. 이 문서의 뒷부분에서 각각의 속성에 대해 자세히 설명합니다.
요청 URI
Attribute | 속성 |
---|---|
메서드 | 게시 |
URI | https://<CustomerId>.ods.opinsights.azure.com/api/logs?api-version=2016-04-01 |
내용 유형 | application/json |
URI 매개 변수 요청
매개 변수 | 설명 |
---|---|
CustomerID | Log Analytics 작업 영역에 대한 고유 식별자입니다. |
리소스 | API 리소스 이름: /api/logs |
API 버전 | 이 요청에 사용하는 API의 버전입니다. 현재 버전은 2016-04-01입니다. |
요청 헤더
헤더 | 설명 |
---|---|
Authorization | 권한 부여 서명입니다. 문서의 뒷부분에 HMAC-SHA256 헤더를 만드는 방법이 나와 있습니다. |
Log-Type | 제출 중인 데이터의 레코드 종류를 지정합니다. 문자, 숫자 및 밑줄(_)만 포함할 수 있으며 100자를 초과할 수 없습니다. |
x-ms-date | RFC 1123 형식의 요청이 처리된 날짜입니다. |
x-ms-AzureResourceId | 데이터를 연결해야 하는 Azure 리소스의 리소스 ID입니다. _ResourceId 속성을 채우고 데이터가 리소스 컨텍스트 쿼리에 포함되도록 허용합니다. 이 필드를 지정하지 않으면 데이터가 리소스 컨텍스트 쿼리에 포함되지 않습니다. |
time-generated-field | 데이터 항목의 타임스탬프가 포함된 데이터의 필드 이름입니다. 필드를 지정하면 그 내용이 TimeGenerated에 사용됩니다. 이 필드를 지정하지 않으면 TimeGenerated의 기본값은 메시지가 수집된 시간입니다. 메시지 필드의 내용은 ISO 8601 형식 YYYY-MM-DDThh:mm:ssZ를 따라야 합니다. 생성 시간 값은 받은 시간보다 2일 이전이거나 미래 2일 이후일 수 없습니다. 이러한 경우 메시지가 수집되는 시간이 사용됩니다. |
Authorization
Azure Monitor HTTP 데이터 수집기 API에 대한 모든 요청에는 인증 헤더가 포함되어야 합니다. 요청을 인증하려면 요청을 수행하는 작업 영역에 대한 기본 키 또는 보조 키를 통해 요청을 서명합니다. 그런 다음 요청의 일부로 해당 서명을 전달합니다.
권한 부여 헤더의 형식은 다음과 같습니다.
Authorization: SharedKey <WorkspaceID>:<Signature>
WorkspaceID는 Log Analytics 작업 영역에 대한 고유 식별자입니다. 서명은 요청에서 구성되고 SHA256 알고리즘을 사용하여 계산된 해시 기반 메시지 인증 코드(HMAC)입니다. 그런 다음 Base64 인코딩을 사용하여 인코딩합니다.
이 형식을 사용하여 SharedKey 서명 문자열을 인코딩합니다.
StringToSign = VERB + "\n" +
Content-Length + "\n" +
Content-Type + "\n" +
"x-ms-date:" + x-ms-date + "\n" +
"/api/logs";
서명 문자열의 예는 다음과 같습니다.
POST\n1024\napplication/json\nx-ms-date:Mon, 04 Apr 2016 08:00:00 GMT\n/api/logs
서명 문자열이 있을 때는 UTF-8 문자열에서 HMAC-SHA256 알고리즘을 사용하여 인코딩한 다음 결과를 Base64로 인코딩합니다. 이 형식을 사용합니다.
Signature=Base64(HMAC-SHA256(UTF8(StringToSign)))
다음 섹션의 샘플은 권한 부여 헤더를 만드는 데 도움이 되는 예제 코드입니다.
요청 본문
메시지의 본문은 JSON에 있어야 합니다. 다음 형식으로 속성 이름과 값 쌍을 갖는 하나 이상의 레코드를 포함해야 합니다. 속성 이름에는 문자, 숫자 및 밑줄(_)만 사용할 수 있습니다.
[
{
"property 1": "value1",
"property 2": "value2",
"property 3": "value3",
"property 4": "value4"
}
]
다음 형식을 사용하여 단일 요청에서 여러 레코드를 일괄 처리할 수 있습니다. 모든 레코드는 동일한 레코드 형식 이어야 합니다.
[
{
"property 1": "value1",
"property 2": "value2",
"property 3": "value3",
"property 4": "value4"
},
{
"property 1": "value1",
"property 2": "value2",
"property 3": "value3",
"property 4": "value4"
}
]
레코드 유형 및 속성
Azure Monitor HTTP 데이터 수집기 API를 통해 데이터를 제출할 때 사용자 지정 레코드 종류를 정의합니다. 현재는 다른 데이터 형식과 솔루션으로 만든 기존 레코드 형식에 데이터를 쓸 수 없습니다. Azure Monitor는 들어오는 데이터를 읽은 다음, 입력된 값의 데이터 형식과 일치하는 속성을 만듭니다.
데이터 수집기 API에 대한 각 요청에는 레코드 종류의 이름과 함께 Log-Type 헤더가 포함되어야 합니다. 이 사용자 지정 로그를 다른 로그 형식과 구분하기 위해 입력한 이름에는 접미사 _CL이 자동으로 추가됩니다. 예를 들어 이름으로 MyNewRecordType을 입력할 경우 Azure Monitor는 MyNewRecordType_CL 형식의 레코드를 만듭니다. 이렇게 하면 사용자가 만든 형식 이름과 Microsoft가 현재 또는 향후에 포함한 이름 사이의 충돌을 방지할 수 있습니다.
속성의 데이터 형식을 식별하기 위해 Azure Monitor는 속성 이름에 접미사를 추가합니다. 속성에 null 값이 있으면 속성이 해당 레코드에 포함되지 않습니다. 이 표는 속성 데이터 형식과 해당하는 접미사를 나열합니다.
속성 데이터 형식 | 접미사 |
---|---|
문자열 | _s |
부울 | _b |
두 배 | _d |
Date/time | _t |
GUID(문자열로 저장) | _g |
참고 항목
GUID로 표시되는 문자열 값에는 _g 접미사가 지정되고 들어오는 값에 대시가 포함되지 않더라도 GUID로 형식이 지정됩니다. 예를 들어 "8145d822-13a7-44ad-859c-36f31a84f6dd" 및 "8145d82213a744ad859c36f31a84f6dd"는 "8145d822-13a7-44ad-859c-36f31a84f6dd"로 저장됩니다. 이 문자열과 다른 문자열의 유일한 차이점은 이름에 _g가 있고 대시가 입력에 없는 경우 삽입된다는 것입니다.
Azure Monitor가 각 속성에 사용하는 데이터 형식은 새 레코드의 레코드 종류가 이미 있는지 여부에 따라 달라집니다.
- 레코드 종류가 없는 경우 Azure Monitor는 JSON 형식 유추를 통해 새 레코드 종류를 만들어 새 레코드에 포함된 각 속성의 데이터 형식을 결정합니다.
- 레코드 종류가 있는 경우 Azure Monitor는 기존 속성에 따라 새 레코드를 만들려고 합니다. 새 레코드에 포함된 속성의 데이터 형식이 일치하지 않고 기존 형식으로 변환할 수 없거나, 레코드가 존재하지 않는 속성을 포함하는 경우 Azure Monitor는 관련 접미사가 있는 새 속성을 만듭니다.
예를 들어 다음 제출 항목은 number_d, boolean_b, string_s 등의 세 가지 속성이 있는 레코드를 만듭니다.
모든 값을 문자열 형식으로 지정하여 다음 항목을 제출하면 속성이 변경되지 않습니다. 값을 기존 데이터 형식으로 변환할 수 있습니다.
그러나 이 다음 제출을 실행하면 Azure Monitor가 새 속성 boolean_d 및 string_d를 만듭니다. 이러한 값은 변경할 수 없습니다.
레코드 종류가 생성되기 전에 다음 항목을 제출하면 Azure Monitor는 number_s, boolean_s 및 string_s의 세 가지 속성을 가진 레코드를 만듭니다. 이 항목에서 각각의 초기 값은 문자열 형식이 됩니다.
예약된 속성
다음 속성은 예약되어 있으며 사용자 지정 레코드 형식에서 사용하면 안 됩니다. 페이로드에 이러한 속성 이름이 포함되어 있으면 오류가 발생합니다.
- 테넌트
- TimeGenerated
- RawData
데이터 제한
Azure Monitor 데이터 수집 API에 게시된 데이터에는 특정 제약 조건이 적용됩니다.
- Azure Monitor 데이터 수집기 API에 대한 게시당 최대 30MB. 이는 단일 게시물에 대한 크기 제한입니다. 단일 게시물의 데이터가 30MB를 초과하는 경우 데이터를 보다 작은 크기의 청크로 분할하여 동시에 보내야 합니다.
- 필드 값은 최대 32KB입니다. 필드 값이 32KB보다 크면 데이터가 잘립니다.
- 특정 형식에 대해 권장하는 값은 최대 50개 필드입니다. 이는 사용 편의성 및 검색 환경 관점에서의 실용적인 제한입니다.
- Log Analytics 작업 영역에 있는 테이블은 최대 500개의 열(이 문서에서는 필드라고 함)만 지원합니다.
- 열 이름은 최대 45자입니다.
반환 코드
HTTP 상태 코드 200는 처리를 위한 요청을 받았다는 것을 의미합니다. 이 코드는 작업이 성공적으로 완료되었음을 나타냅니다.
서비스에서 반환할 수 있는 전체 상태 코드는 다음 표에 나열되어 있습니다.
코드 | 상태 | 오류 코드 | 설명 |
---|---|---|---|
200 | OK | 요청이 성공적으로 수락되었습니다. | |
400 | Bad request | InactiveCustomer | 작업 영역이 닫혔습니다. |
400 | Bad request | InvalidApiVersion | 지정한 API 버전이 서비스에서 인식되지 않았습니다. |
400 | Bad request | InvalidCustomerId | 지정한 작업 영역 ID가 올바르지 않습니다. |
400 | Bad request | InvalidDataFormat | 잘못된 JSON이 제출되었습니다. 응답 본문에 오류 해결 방법에 관한 추가 정보가 포함될 수 있습니다. |
400 | Bad request | InvalidLogType | 지정한 로그 형식에 특수 문자 또는 숫자가 포함되어 있습니다. |
400 | Bad request | MissingApiVersion | API 버전을 지정하지 않았습니다. |
400 | Bad request | MissingContentType | 콘텐츠 형식을 지정하지 않았습니다. |
400 | Bad request | MissingLogType | 필요한 값 로그 형식을 지정하지 않았습니다. |
400 | Bad request | UnsupportedContentType | 콘텐츠 형식이 application/json으로 설정되지 않았습니다. |
403 | 금지 | InvalidAuthorization | 서비스가 요청을 인증하지 못했습니다. 작업 영역 ID 및 연결 키가 올바른지 확인합니다. |
404 | Not Found | 제공된 URL이 잘못되었거나 요청이 너무 큽니다. | |
429 | 요청이 너무 많음 | 서비스 계정에서 많은 양의 데이터가 발생했습니다. 요청을 나중에 다시 시도하세요. | |
500 | Internal Server Error | UnspecifiedError | 서비스에 내부 오류가 발생했습니다. 요청을 다시 시도하세요. |
503 | Service Unavailable | ServiceUnavailable | 현재 서비스가 요청을 받을 수 없습니다. 요청을 다시 시도하세요. |
쿼리 데이터
Azure Monitor HTTP 데이터 수집기 API에서 제출한 데이터를 쿼리하려면 _CL에서 지정하고 추가한 LogType과 형식이 같은 레코드를 검색합니다. 예를 들어 MyCustomLog를 사용한 경우 MyCustomLog_CL
이 포함된 레코드를 모두 반환합니다.
샘플 요청
이 섹션에는 다양한 프로그래밍 언어를 사용하여 Azure Monitor HTTP 데이터 수집기 API에 데이터를 제출하는 방법을 보여 주는 샘플이 있습니다.
각 샘플에서 다음을 수행하여 권한 부여 헤더에 대한 변수를 설정합니다.
- Azure Portal에서 Log Analytics 작업 영역을 찾습니다.
- 에이전트를 선택합니다.
- 작업 영역 ID 오른쪽에서 복사 아이콘을 선택한 다음, 이 ID를 고객 ID 변수의 값으로 붙여넣습니다.
- 기본 키 오른쪽에서 복사 아이콘을 선택한 다음, 이 ID를 공유 키 변수의 값으로 붙여넣습니다.
또는 로그 형식 및 JSON 데이터에 대한 변수를 변경할 수 있습니다.
# Replace with your Workspace ID
$CustomerId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
# Replace with your Primary Key
$SharedKey = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
# Specify the name of the record type that you'll be creating
$LogType = "MyRecordType"
# Optional name of a field that includes the timestamp for the data. If the time field is not specified, Azure Monitor assumes the time is the message ingestion time
$TimeStampField = ""
# Create two records with the same set of properties to create
$json = @"
[{ "StringValue": "MyString1",
"NumberValue": 42,
"BooleanValue": true,
"DateValue": "2019-09-12T20:00:00.625Z",
"GUIDValue": "9909ED01-A74C-4874-8ABF-D2678E3AE23D"
},
{ "StringValue": "MyString2",
"NumberValue": 43,
"BooleanValue": false,
"DateValue": "2019-09-12T20:00:00.625Z",
"GUIDValue": "8809ED01-A74C-4874-8ABF-D2678E3AE23D"
}]
"@
# Create the function to create the authorization signature
Function Build-Signature ($customerId, $sharedKey, $date, $contentLength, $method, $contentType, $resource)
{
$xHeaders = "x-ms-date:" + $date
$stringToHash = $method + "`n" + $contentLength + "`n" + $contentType + "`n" + $xHeaders + "`n" + $resource
$bytesToHash = [Text.Encoding]::UTF8.GetBytes($stringToHash)
$keyBytes = [Convert]::FromBase64String($sharedKey)
$sha256 = New-Object System.Security.Cryptography.HMACSHA256
$sha256.Key = $keyBytes
$calculatedHash = $sha256.ComputeHash($bytesToHash)
$encodedHash = [Convert]::ToBase64String($calculatedHash)
$authorization = 'SharedKey {0}:{1}' -f $customerId,$encodedHash
return $authorization
}
# Create the function to create and post the request
Function Post-LogAnalyticsData($customerId, $sharedKey, $body, $logType)
{
$method = "POST"
$contentType = "application/json"
$resource = "/api/logs"
$rfc1123date = [DateTime]::UtcNow.ToString("r")
$contentLength = $body.Length
$signature = Build-Signature `
-customerId $customerId `
-sharedKey $sharedKey `
-date $rfc1123date `
-contentLength $contentLength `
-method $method `
-contentType $contentType `
-resource $resource
$uri = "https://" + $customerId + ".ods.opinsights.azure.com" + $resource + "?api-version=2016-04-01"
$headers = @{
"Authorization" = $signature;
"Log-Type" = $logType;
"x-ms-date" = $rfc1123date;
"time-generated-field" = $TimeStampField;
}
$response = Invoke-WebRequest -Uri $uri -Method $method -ContentType $contentType -Headers $headers -Body $body -UseBasicParsing
return $response.StatusCode
}
# Submit the data to the API endpoint
Post-LogAnalyticsData -customerId $customerId -sharedKey $sharedKey -body ([System.Text.Encoding]::UTF8.GetBytes($json)) -logType $logType
대안 및 고려 사항
데이터 수집기 API는 Azure Logs에 자유 형식 데이터를 수집해야 하는 대부분의 요구 사항을 충족하지만, API의 일부 제한을 극복하기 위한 대안이 필요할 수도 있습니다. 주요 고려 사항을 비롯한 옵션이 다음 표에 나와 있습니다.
대체 | 설명 | 가장 적합한 용도 |
---|---|---|
사용자 지정 이벤트: Application Insights의 네이티브 SDK 기반 수집 | 일반적으로 애플리케이션 내에서 SDK를 통해 계측되는 Application Insights는 사용자 지정 이벤트를 통해 사용자 지정 데이터를 전송할 수 있는 기능을 제공합니다. |
|
Azure Monitor Logs의 데이터 수집기 API | Azure Monitor Logs의 데이터 수집기 API는 데이터를 수집하는 완전히 개방형 방식입니다. JSON 개체에 형식이 지정된 모든 데이터는 여기에서 전송할 수 있습니다. 전송된 데이터는 처리 과정을 거쳐 Monitor Logs의 다른 데이터와 상관 관계를 지정하거나 다른 Application Insights 데이터와 상관 관계를 지정할 수 있게 됩니다. 데이터를 Azure Blob Storage에 파일로 쉽게 업로드할 수 있으며, 여기에서 파일이 처리되어 Log Analytics에 업로드됩니다. 구현 샘플은 데이터 수집기 API를 사용하여 데이터 파이프라인 만들기를 참조하세요. |
|
Azure Data Explorer | 이제 일반 공급되는 Azure Data Explorer는 Application Insights Analytics 및 Azure Monitor Logs를 구동하는 데이터 플랫폼입니다. 원시 형식의 데이터 플랫폼을 사용하면 클러스터(Kubernetes RBAC(역할 기반 액세스 제어), 보존율, 스키마 등)를 통해 완전한 유연성을 얻을 수 있지만 관리 오버헤드가 필요합니다. Azure Data Explorer는 CSV, TSV 및 JSON 파일을 비롯한 다양한 수집 옵션을 제공합니다. |
|
다음 단계
로그 검색 API를 사용하여 Log Analytics 작업 영역에서 데이터를 검색합니다.
Azure Monitor에 대한 Logic Apps 워크플로를 사용하여 데이터 수집기 API로 데이터 파이프라인을 만드는 방법을 알아봅니다.