통합 대시보드 만들기

개요

Datadog 대시보드를 사용하면 주요 메트릭을 표시하고 추적하여 인프라스트럭처 및 통합을 효율적으로 모니터링할 수 있습니다. Datadog은 다양한 기능과 통합을 위한 기본 대시보드 세트를 제공합니다. 대시보드 목록을 통해 액세스할 수 있습니다.

Datadog 통합을 만들었다면, 통합의 활용 가치를 높이기 위해 즉시 사용 가능한 대시보드를 만들 수 있습니다. 이 가이드에서는 통합 대시보드를 만드는 단계와 모범 사례를 제공합니다.

Datadog 통합을 만드려면 새 통합 만들기를 참조하세요.

통합 대시보드 만들기

새 대시보드 만들기

Datadog에서 새 대시보드를 만듭니다.

대시보드에 구성 요소를 추가할 때 가이드의 모범 사례를 참고하세요.

대시보드 내보내기

오른쪽 상단에 있는 내보내기 버튼을 사용하여 대시보드를 JSON으로 내보내고 대시보드 JSON 내보내기를 선택합니다. 대시보드 제목에 따라 파일 이름을 지정합니다 (예: your_integration_name_overview.json).

이 파일을 통합 assets/dashboards 폴더에 저장합니다. 그리고 manifest.json 파일에 에셋을 추가합니다. 통합 파일 구조 및 매니페스트 파일에 대한 자세한 내용은 통합 에셋 레퍼런스를 참조하세요.

풀 리퀘스트 열기

풀 리퀘스트(PR)를 열어 대시보드 JSON 파일과 업데이트된 매니페스트 파일을 integrations-extras GitHub 리포지토리의 해당 통합 폴더에 추가합니다. Datadog은 모든 integration-extras PR을 검토합니다. 승인되면 Datadog이 PR을 병합하고 통합 대시보드가 프로덕션에 푸시됩니다.

프로덕션 환경에서 대시보드 확인하기

먼저, 관련 통합 타일이 Datadog에 Installed 되어 있는지 확인합니다. 관련 기본 대시보드를 보려면 통합을 설치해야 합니다.

대시보드 목록에서 대시보드를 찾습니다. 대시보드 목록 페이지와 미리 설정된 대시보드 내에서 로고가 올바르게 제공되는지 확인합니다.

대시보드 모범 사례 따르기

통합 대시보드에는 다음 정보가 포함되어야 합니다:

대시보드의 예
  • 배너 이미지, 간결한 카피, 유용한 링크, 뛰어난 타이포그래피 계층 구조로 시선을 사로잡는 About 그룹
  • 가장 중요한 통계가 상단에 주석으로 표시되는 Overview 그룹
  • 간단한 그래프 제목 및 title-case 그룹 이름
  • 고밀도 모드에서의 대칭성
  • 형식이 잘 갖춰진 간결한 노트
  • 관련 그룹, 그룹 안의 노트, 그룹 내 그래프 사이의 색상 조정

일반 가이드라인

  • 새 대시보드를 만들 때 기본 대시보드 유형을 선택합니다.

  • 대시보드 제목에 통합 이름을 입력합니다. 좋은 대시보드 제목의 예는 Scylla 또는 Cilium Overview 입니다. 참고: 대시보드 제목에서 대시보드 URL이 생성되므로 대시보드 제목에 -(하이픈)을 사용하지 마십시오.

  • 대시보드 헤더에 로고를 추가합니다. 아이콘이 이미 존재하고 integration_id가 아이콘 이름과 일치하는 경우 통합 로고가 자동으로 헤더에 표시됩니다.

  • 간단한 설명과 유용한 링크가 포함된 About 그룹을 추가합니다. About 섹션에는 데이터가 아닌 콘텐츠가 포함되어야 합니다. About 섹션을 전체 너비로 만들지 마세요.

  • About 섹션을 수정하고 배너 표시 옵션을 선택합니다. 그런 다음 다음 파일 위치에 따라 배너 이미지에 링크할 수 있습니다: /static/images/integration_dashboard/your-image.png

  • 가장 중요한 몇 가지 메트릭이 포함된 Overview 그룹을 대시보드 상단에 배치합니다. Overview 그룹에는 데이터를 포함할 수 있습니다.

  • 대시보드가 1280px 너비와 2560px 너비에서 어떻게 보이는지 확인합니다. 대시보드가 각각 작은 노트북과 큰 모니터에 표시되는 방식입니다. 대시보드의 가장 일반적인 화면 너비는 1920, 1680, 1440, 2560 및 1280px입니다. 모니터가 고밀도 모드를 사용하기에 충분히 크지 않다면 브라우저 확대/축소 컨트롤을 사용하여 축소합니다.

위젯 및 그룹화

  • 통합에서 지원하는 메트릭을 조사하여 관련 카테고리로 그룹화하는 것을 고려해 보세요. 통합의 성과 및 개요에 핵심이 되는 중요한 메트릭은 맨 위에 표시해야 합니다.

  • 노트 위젯 대신 그룹 위젯을 사용해 섹션의 제목과 그룹을 지정하세요. 그룹을 나란히 표시하려면 부분 너비 그룹을 사용하세요. 대부분의 대시보드는 그룹 안의 모든 위젯을 표시해야 합니다.

    그룹 위젯의 예
  • 시계열 위젯은 작은 디스플레이에서 찌그러져 보이지 않도록 열 너비가 최소 4열 이상이어야 합니다.

  • 스트림 위젯은 가독성을 위해 대시보드 너비의 절반인 6열 이상이어야 합니다. 대시보드 끝에 배치하여 스크롤이 걸리지 않도록 합니다. 스트림 위젯을 그룹으로 묶어 접을 수 있도록 배치하는 것이 유용합니다. 대시보드에서 모니터링하는 서비스가 이벤트를 보고하는 경우에만 이벤트 스트림을 추가합니다. sources:service_name을 사용하세요.

  • 다양한 위젯 유형과 크기를 혼합하여 사용해 보세요. 대시보드가 최대한 명확하다는 확신이 들 때까지 시각화 및 서식 지정 옵션을 탐색해 보세요. 때로는 전체 대시보드가 시계열로 구성되어도 괜찮지만, 때로는 다양한 유형이 가독성을 향상시킬 수 있습니다. 가장 일반적으로 사용되는 메트릭 위젯은 시계열, 쿼리 값테이블입니다. 사용 가능한 위젯 유형에 대한 자세한 내용은 지원되는 대시보드 위젯 목록을 참조하세요.

  • 고밀도 모드에서 대시보드의 왼쪽과 오른쪽 절반이 대칭을 이루도록 하세요. 대형 모니터를 사용하는 사용자는 기본적으로 고밀도 모드에서 대시보드를 보게 되므로 그룹 관계가 타당하고 대시보드가 보기 좋게 표시되는 것이 중요합니다. 이를 위해 그룹 높이를 조정하고 왼쪽과 오른쪽 절반 사이에서 그룹을 이동할 수 있습니다.

    대칭 대시보드의 예
  • 템플릿 변수를 사용하면 대시보드에서 하나 이상의 위젯을 동적으로 필터링할 수 있습니다. 템플릿 변수는 모니터링되는 서비스를 사용하는 모든 사용자 또는 계정에서 액세스할 수 있는 범용 변수여야 합니다. 모든 관련 그래프가 관련 템플릿 변수 필터를 수신하고 있는지 확인합니다.

    참고: *=scope를 템플릿 변수로 추가하면 사용자가 자신의 모든 태그에 액세스할 수 있으므로 유용합니다.

복사

  • 그래프 제목은 가장 중요한 정보를 담아 간결하게 지정합니다. ‘∼의 수’와 같은 일반적인 문구는 피합니다.

    간결한 제목 (good)장황한 제목 (bad)
    노드당 이벤트노드당 쿠버네티스 이벤트 수
    보류 중인 작업: [$node_name][$node_name]에서 보류 중인 총 작업 수
    읽기/쓰기 작업읽기/쓰기 작업 수
    서버 연결 - 속도서버에 대한 연결 속도
    로드Memcached 로드
  • 특히 위젯이 같은 이름의 커스텀 단위를 가진 쿼리 값인 경우 그룹의 모든 위젯에서 그룹 제목이나 통합 이름을 반복하지 마세요.

  • 시계열 위젯의 경우 항상 별칭 수식을 사용합니다.

  • 그룹 제목은 title case (전치사, 관사 등을 제외한 제목의 모든 단어를 대문자로 표기), 위젯 제목은 sentence case (문장의 첫 글자만 대문자로 표기)여야 합니다.

  • 범례를 표시하는 경우 이해하기 쉬운 별칭을 사용해야 합니다.

  • 그래프 제목은 쿼리한 메트릭을 요약해야 합니다. 단위 유형은 메타데이터에서 자동으로 표시되므로 그래프 제목에 표시하지 마세요. 쿼리 계산이 다른 유형의 단위를 나타내는 경우는 예외입니다.

시각적 스타일

  • 사용 사례에 맞게 노트의 서식을 지정하세요. 사전 설정된 “캡션”, “주석”, “헤더"를 사용하거나 원하는 스타일 조합을 선택하세요. 글머리 기호 목록이나 코드 블록처럼 복잡한 서식을 포함하거나 긴 노트에는 가장 작은 글꼴 크기를 사용하지 마세요.

  • 색상은 스타일을 위한 것이 아니라 중요한 관계를 강조하고 가독성을 높이기 위해 사용합니다. 여러 그룹이 서로 연관되어 있는 경우, 모든 그룹에 동일한 그룹 헤더 색상을 적용하세요. 한 그룹에 녹색 헤더 색상을 적용했다면 그 노트도 녹색으로 만들어 보세요. 두 그룹이 서로 연관되어 있지만 한 그룹이 더 중요한 경우, 중요한 그룹에는 “선명한” 색상을, 덜 중요한 그룹에는 “옅은” 색상을 사용해 보세요. 그룹 헤더는 흰색으로 두어도 되며, 색상을 과도하게 사용하지 않도록 주의하세요. 예를 들어, 대시보드의 모든 그룹에 선명한 파란색을 적용하지 않으며, 회색 헤더를 사용하지 않습니다.

    대시보드의 색상 관련 데이터 예
  • 범례를 사용해 보세요. 범례를 사용하면 각 계열 위로 마우스를 가져가거나 위젯을 최대화하지 않고도 그래프를 쉽게 읽을 수 있습니다. 범례를 쉽게 읽으려면 시계열 별칭을 사용해야 합니다. 범례 자동 모드는 공간이 부족할 때 범례를 숨기고 여유가 있을 때 표시하는 유용한 옵션입니다.

    대시보드 범례의 예
  • 사용자가 두 그래프를 나란히 비교하도록 하려면 두 그래프의 x축이 정렬되어 있는지 확인하세요. 한 그래프에 범례가 표시되고 다른 그래프에 범례가 표시되지 않으면 x축이 정렬되지 않습니다. 둘 다 범례가 표시되는지 또는 둘 다 표시되지 않는지 확인합니다.

  • 시계열의 경우 메트릭 유형에 따라 표시 유형을 결정합니다.

    메트릭 유형표시 유형
    볼륨 (예: 연결 수)area
    개수 (예: 오류 수)bars
    여러 그룹 또는 기본값lines