개요

이 페이지에서는 Technology Partners가 어떻게 로그 파이프라인을 생성할 수 있는지에 대해 알아봅니다. 통합에서 Datadog으로 로그를 전송하려면 로그 파이프라인이 필요합니다.

Datadog으로 로그를 전송하는 통합을 개발할 때, 사용자에게 최상의 경험을 제공할 수 있도록 다음 가이드를 따르세요.

모범 사례

로그 파이프라인을 생성하기 전에 아래의 지침과 권장 사항을 참고하세요.

통합은 지원되는 Datadog 로그 엔드포인트를 사용해야 합니다

통합은 Datadog이 로그 수집을 위해 제공하는 지원되는 엔드포인트 중 하나를 사용해야 합니다. 또는 Logs Ingestion HTTP 엔드포인트를 사용하여 Datadog에 로그를 전송할 수 있습니다.

통합은 모든 Datadog 사이트를 지원해야 합니다

상황에 따라 사용자가 다양한 Datadog 사이트 중에서 선택할 수 있어야 합니다. 사이트 차이점에 대한 자세한 내용은 Datadog 사이트 시작하기를 참고하세요.

Datadog 사이트 엔드포인트는 http-intake.logs.입니다.

통합 설정 시 사용자 지정 태그 추가를 허용하세요

태그는 통합 로그 페이로드의 JSON 본문에 키-값 속성으로 설정할 수 있습니다. Datadog은 사용자가 통합에 대해 사용자 지정 태그를 설정할 수 있도록 허용하는 것을 권장합니다. 통합이 API를 통해 로그를 전송하는 경우, ddtags=<TAGS> 쿼리 파라미터를 사용하여 태그를 설정할 수 있습니다.

통합의 로그 source 태그를 통합 이름으로 설정합니다

Datadog은 애플리케이션에 대한 source 태그를 <integration_name>(source:okta)로 설정할 것을 권장합니다. Datadog UI에서 다시 매핑할 수 없으므로 Datadog 엔드포인트로 로그를 전송하기 전에 반드시 source를 설정해야 합니다.

source 태그는 소문자로 작성해야 하며, 통합 파이프라인 및 대시보드를 활성화하는 데 사용되므로 사용자가 편집할 수 없어야 합니다.

가능하면 JSON 본문에 배열이 포함된 로그를 전송하지 마세요

Datadog에서 로그 데이터를 보낼 때 배열을 사용하는 것이 가능하지만, 배열은 패싯할 수 없으므로 사용하지 않는 것이 좋습니다.

Datadog API 키를 기록하지 마세요

Datadog API 키는 API 요청 시 Header 또는 HTTP Path를 통해 전달할 수 있습니다. 자세한 내용은 Send Logs API 문서를 참고하세요. 설정에서 API 키를 기록하지 않도록 주의하세요.

Datadog Application Keys를 사용하지 마세요

Datadog Application Keys는 HTTP 엔드포인트를 사용하여 로그를 전송하는 데 필요하지 않습니다.

로그 통합 자산 생성하기

Datadog 파트너 계정 내에서 직접 로그 통합 자산을 만들고 디자인할 수 있습니다.

로그 통합은 파이프라인과 관련 패싯이라는 두 가지 자산 세트로 구성됩니다. 다양한 기술 및 애플리케이션의 로그를 중앙에서 관리하면 여러 가지 고유한 특성을 얻을 수 있습니다. 기본 대시보드를 사용하려면 Technology Partner Integrations가 통합을 생성할 때 Datadog의 표준 명명 규칙을 따라야 합니다.

Datadog Integration 디자인을 마무리하고 Datadog의 로그 엔드포인트로 로그를 성공적으로 전송한 후, 로그 파이프라인과 패싯을 정의하여 통합의 로그를 풍부하게 하고 구조화합니다.

Datadog Technology Partner와 통합 개발 샌드박스 액세스에 관한 정보는 통합 구축에서 확인하세요.

파이프라인 개요

Datadog으로 전송된 로그는 파이프라인 프로세서를 사용하여 로그 파이프라인에서 처리됩니다. 이 프로세서를 통해 사용자는 속성 정보를 파싱, 재매핑 및 추출하여 플랫폼 전반에서 사용할 수 있도록 로그를 풍부하게 하고 표준화할 수 있습니다.

파이프라인 생성

파이프라인 프로세서로 지정된 로그를 처리하기 위해 로그 파이프라인을 생성합니다.

1. Pipelines 페이지에서 + New Pipeline을 클릭합니다.
2. Filter 필드에 Technology Partner 로그의 로그 소스를 정의하는 고유 source 태그를 입력합니다. 예를 들어, Okta 통합은 source:okta입니다. 참고: Datadog으로 전송되기 전 통합을 통해 전송되는 로그에 올바른 소스 태그가 적용되었는지 확인하세요.
3. (선택 사항) 태그와 설명을 추가합니다.
4. 생성을 클릭합니다.

파이프라인을 설정한 후 프로세서를 추가하여 로그를 더욱 구조화하고 정보를 강화합니다.

파이프라인 프로세서 추가

파이프라인 프로세서를 정의하기 전에 Datadog의 Standard Attributes를 검토하세요.

파이프라인 내에서 프로세서를 사용하여 데이터를 보강하고 재구성하며 로그 속성을 생성하세요. 모든 로그 프로세서 목록은 프로세서 문서를 참고하세요.

필수 조건

애플리케이션의 로그 속성을 Datadog Standard Attributes에 매핑합니다

Attribute Remapper를 사용하여 가능한 경우 속성 키를 Datadog Standard Attributes에 매핑합니다. 예를 들어, 네트워크 서비스 클라이언트 IP 값의 속성은 network.client.ip로 리매핑해야 합니다.

로그 service 태그를 원격 측정 데이터를 생성하는 서비스 이름에 매핑합니다

[Service Remapper]]7를 사용하여 service 속성을 리매핑합니다. 소스와 서비스가 동일한 값을 공유하는 경우, service 태그를 source 태그에 리매핑합니다. service 태그는 소문자여야 합니다.

로그의 내부 타임스탬프를 공식 Datadog 타임스탬프에 매핑합니다

Date Remapper를 사용하여 로그의 공식 타임스탬프를 정의합니다. 로그의 타임스탬프가 표준 날짜 속성에 매핑되지 않으면 Datadog은 타임스탬프를 수집 시점으로 설정합니다.

로그의 사용자 지정 상태 속성을 공식 Datadog status 속성에 매핑합니다

Status Remapper를 사용하여 로그의 status를 리매핑하거나, Category Processor를 사용하여 범위에 매핑된 상태(HTTP 상태 코드처럼)를 리매핑합니다.

로그의 사용자 지정 메시지 속성을 공식 Datadog message 속성에 매핑합니다

애플리케이션 로그가 표준 메시지 속성에 매핑되지 않는 경우 Message Remapper를 사용하여 로그의 공식 메시지를 정의합니다. 이를 통해 사용자는 원하는 텍스트를 입력하여 로그를 검색할 수 있습니다.

로그 내 사용자 지정 속성에 대한 네임스페이스를 설정합니다

Datadog Standard Attribute에 매핑되지 않는 일반 로그 속성은 Facets에 매핑된 경우 네임스페이스를 지정해야 합니다. 예를 들어, file은 integration_name.file로 다시 매핑됩니다. Attribute Remapper를 사용하여 속성 키를 새로운 네임스페이스 속성으로 설정하세요.

1. 새로 만든 파이프라인을 확장하고 Add Processor를 클릭하여 프로세서를 사용하여 파이프라인을 구축하세요.
2. 통합 로그가 JSON 형식이 아닌 경우 Grok Processor를 추가하여 속성 정보를 추출하세요. Grok 프로세서는 속성을 파싱하고 로그를 보강한 후 재매핑 또는 추가 처리합니다.
3. 로그 속성을 추출한 후 가능한 경우 Attribute Remappers를 사용하여 Datadog의 Standard Attributes로 다시 매핑합니다.
4. Date Remapper를 사용하여 통합 로그의 타임스탬프를 공식 Datadog 타임스탬프로 설정합니다.
5. 고급 처리 및 데이터 변환을 위해 추가 프로세서를 활용하세요. 예를 들어, Arithmetic Processor는 속성을 기반으로 정보를 계산하는 데 사용할 수도 있고, String Builder Processor는 여러 문자열 속성을 연결하는 데 사용할 수도 있습니다.

팁

• 로그 속성을 다시 매핑할 때 preserveSource:false를 사용하여 원래 속성을 제거하세요. 이렇게 하면 혼란을 줄이고 중복을 제거할 수 있습니다.
• 최적의 grok 파싱 성능을 유지하려면 %{data:} 및 %{regex(".*"):}와 같은 와일드카드 매처를 사용하지 마세요. 파싱 구문은 최대한 구체적으로 작성하세요.
• 프로세서 작성 및 표준 속성 활용에 대한 전반적인 개요는 무료 과정 Going Deeper with Logs Processing에서 확인해 보세요.

패싯 개요

패싯(Facet)은 검색 결과를 필터링하고 범위를 좁히는 데 사용할 수 있는 구체적인 질적 또는 양적 속성입니다. 패싯은 검색 결과를 필터링하는 데 반드시 필요한 것은 아니지만, 사용자가 검색을 세분화할 수 있는 기준(차원)을 이해하는 데 중요한 역할을 합니다.

파이프라인이 발행되면 Datadog에서 표준 속성에 대한 패싯을 자동으로 추가합니다. 해당 속성을 Datadog Standard Attribute로 다시 매핑해야 하는지 검토하세요.

모든 속성이 패싯으로 사용되지는 않습니다. 통합에서 패싯이 필요한 주요 이유는 다음과 같습니다.

• 패싯은 로그 필터링에 직관적인 인터페이스를 제공합니다. Log Management 자동 완성 기능에 활용되어 사용자가 로그에서 주요 정보를 찾고 집계할 수 있도록 합니다.
• 패싯을 사용하면 가독성이 낮은 속성의 이름을 이해하기 쉬운 레이블로 바꿀 수 있습니다. 예: @deviceCPUper → Device CPU Utilization Percentage.

Log Explorer에서 패싯을 생성할 수 있습니다.

패싯 생성

패싯을 올바르게 정의하는 것이 중요합니다. Datadog의 Log Management 제품 전반에 걸쳐 분석, 모니터, 집계 기능에서 인덱싱된 로그의 유용성을 향상시키기 때문입니다.

Log Management 전반에 자동 완성 기능을 추가하여 애플리케이션 로그를 더 쉽게 찾을 수 있습니다.

필수 조건

사용자 지정 패싯에 매핑된 속성은 먼저 네임스페이스를 지정해야 합니다

Datadog Standard Attribute에 매핑되지 않는 일반 사용자 지정 속성은 사용자 지정 패싯과 함께 사용할 때 네임스페이스를 지정해야 합니다. Attribute Remapper를 사용하면 통합 이름으로 속성의 네임스페이스를 지정할 수 있습니다. 예를 들어, attribute_name은 integration_name.attribute_name로 리매핑됩니다.

사용자 정의 패싯은 기존 Datadog 패싯을 복제해서는 안 됩니다

기존의 기본 제공 Datadog 패싯과 혼동을 피하기 위해, 이미 Datadog Standard Attributes에 매핑된 패싯과 중복되는 사용자 정의 패싯은 생성하지 마세요.

사용자 지정 패싯은 source 이름 아래에 그룹화해야 합니다

사용자 지정 패싯을 생성할 때 그룹을 지정해야 합니다. Group 값을 통합 이름과 동일하게 source로 설정하세요.

사용자 지정 패싯은 매핑된 속성과 동일한 데이터 유형을 가져야 합니다

패싯 데이터 유형(String, Boolean, Double, Integer)을 매핑된 속성과 동일한 유형으로 설정하세요. 유형이 일치하지 않으면 패싯이 의도한 대로 사용되지 않고 잘못 입력될 수 있습니다.

패싯 또는 측정값 추가

1. 패싯이나 측정값을 추가하려는 속성이 포함된 로그를 클릭합니다.
2. 로그 패널에서 속성 옆에 있는 톱니바퀴 아이콘을 클릭합니다.
3. Create facet/measure for @attribute를 선택합니다.
4. 측정값의 단위를 정의하려면 Advanced options을 클릭합니다. 속성이 어떻게 나타나는지에 따라 단위를 선택하세요. 참고: 속성이 어떻게 나타나는지에 따라 측정값의 단위을 정의하세요.
5. Facet List를 확인하는데 도움이 되는 패싯 Group을 지정합니다. 패싯 그룹이 없으면 New group을 선택하고 소스 태그와 일치하는 그룹 이름을 입력한 후 새 그룹에 대한 설명을 추가하세요.
6. 패싯을 생성하려면 Add를 클릭합니다.

패싯 구성 및 편집

1. 로그 패널에서 구성하거나 그룹화하려는 속성 옆에 있는 톱니바퀴 아이콘을 클릭합니다.
2. Edit facet/measure for @attribute을 선택합니다. 해당 속성에 대한 패싯이 아직 없으면 Create facet/measure for @attribute를 선택합니다.
3. 완료되면 Add* 또는 Update를 클릭합니다.

팁

• 가능한 경우 측정값 단위를 지정해야 합니다. 측정값 단위에는 단위를 할당할 수 있습니다. millisecond 또는gibibyte와 같은 단위를 사용하는 두 가지 단위 계열(TIME, BYTES)이 있습니다.
• 패싯에 설명을 지정할 수 있습니다. 사용자가 패싯을 가장 효과적으로 사용할 수 있도록 명확한 설명을 추가하는 것이 좋습니다.
• preserveSource:true 옵션을 사용하여 속성을 다시 매핑하고 원본을 유지하는 경우, 단일 속성에만 패싯을 정의합니다.
• 파이프라인 .yaml 구성 파일에서 패싯을 수동으로 구성할 때 패싯에 source가 할당됩니다. 이는 속성이 캡처된 위치를 나타내며, 속성의 경우 log로, 태그의 경우 tag로 표시될 수 있습니다.

통합 검토 및 배포

Datadog은 이 페이지에 명시된 지침 및 요구 사항을 기반으로 로그 통합을 검토하고 GitHub를 통해 Technology Partner에게 피드백을 제공합니다. Technology Partner는 이를 검토하고 그에 따라 수정 작업을 진행합니다.

검토 프로세스를 시작하려면 Logs Configuration 페이지의 Export 아이콘을 사용하여 로그 파이프라인과 관련 사용자 정의 패싯을 내보내세요.

통합을 통해 Datadog으로 전송될 모든 속성이 포함된 샘플 원시 로그를 포함하세요. 원시 로그는 Datadog으로 전송되기 전에 소스 애플리케이션에서 직접 생성된 원시 메시지로 구성됩니다.

로그 파이프라인을 내보낼 때 두 개의 YAML 파일이 포함됩니다.

• 사용자 정의 패싯, 속성 리매퍼, grok 파서를 포함하는 로그 파이프라인이 있는 파일입니다. 내보낸 파일의 이름은 pipeline-name.yaml입니다.
• 원시 샘플 로그가 포함되어 있고, 비어있는 result 섹션이 있는 파일입니다. 내보낸 파일의 이름은 pipeline-name_test.yaml입니다.

참고: 브라우저에 따라 파일 다운로드를 허용하도록 설정을 조정해야 할 수도 있습니다.

이 파일들을 다운로드한 후 GitHub의 통합 풀 리퀘스트로 이동하여 Assets > Logs 디렉터리에 파일을 추가하세요. Logs 폴더가 아직 없다면 직접 생성할 수 있습니다.

풀 리퀘스트에서 자동으로 검증이 실행되며, 제공된 원시 샘플을 기준으로 파이프라인의 유효성을 검사합니다. 검증 결과는 pipeline-name_test.yaml 파일의 result 섹션으로 설정할 수 있습니다. 검증을 다시 실행한 후 감지되는 이슈가 없으면, 로그 검증이 성공적으로 완료됩니다.

일반적인 세 가지 검증 오류는 다음과 같습니다.

1. 두 YAML 파일의 id 필드: 파이프라인을 통합에 연결하려면 id 필드가 통합 manifest.json 파일의 app_id 필드와 일치하는지 확인하세요.
2. 제공한 원시 로그를 파이프라인에 실행한 result를 제공하지 않는 경우입니다. 검증 결과 출력이 정확하다면 해당 출력을 원시 예제 로그가 포함된 YAML 파일의 result 필드에 추가하세요.
3. 로그 페이로드에 넣어 보내는 대신 service를 파라미터로 보내는 경우 yaml 파일 내 로그 샘플 아래에 있는 service 필드를 포함해야 합니다.

검증이 통과되면 Datadog은 새로운 로그 통합 자산을 생성하고 배포합니다. 질문이 있으시면 풀 리퀘스트에 댓글로 남겨주세요. Datadog 담당자가 영업일 기준 2~3일 이내에 답변해 드립니다.

참고 자료

추가 유용한 문서, 링크 및 기사:

기존 Datadog 로그 통합 보기설명서 로그 패싯에 대해 알아보기설명서 로그 탐색기에 대해 알아보기설명서 로그 파이프라인에 대해 알아보기설명서