메트릭과 태그 이름을 지정할 때 참고할 수 있는 모범 사례가 있나요?
이름 규칙은 중요한 기술입니다. 그렇기 때문에 합의하기가 가장 어려운 결정이기도 합니다. 깨끗하고, 읽기 쉬우며, 유지 관리가 가능한 텔레메트리 데이터를 확보하려면 메트릭, 태그, 서비스에 대한 이름 규칙을 정의해야 합니다. 다음은 몇 가지 권장 사항입니다.
- 의미를 명확하게 설명하는 이름을 제공하세요. 메트릭이나 태그는 값의 목적이나 의미를 명확하게 설명합니다.
- 아래에 설명된 형식과 제한 사항을 준수하세요.
- 여러 의미를 가질 수 있는 약어는 피하세요.
- 팀, 앱, 서비스 전체에서 동일한 규칙을 적용하세요.
- 다른 태그나 메트릭과 충돌을 일으킬 수 있는 예약 키워드는 피하세요.
- 메트릭 이름에는 데이터를 생성하는 애플리케이션이나 서비스를 나타내는 네임스페이스를 접두사로 붙이세요.
- 어떠한 종류의 개인 정보나 민감한 데이터를 사용하지 마세요.
메트릭 이름 규칙 및 모범 사례
- 메트릭 이름은 문자로 시작해야 합니다.
- ASCII 영숫자, 밑줄, 마침표만 포함할 수 있습니다. 다른 문자는 밑줄로 변환됩니다.
- 200자를 초과할 수 없습니다 (UI를 고려해 100자 미만으로 하는 것이 좋습니다).
- 유니코드는 지원되지 않습니다.
에이전트가 보고하는 메트릭은 의사 계층적 점선 형식입니다 (예:http.nginx.response_time). 의사 계층 구조인 이유는 실제로 계층을 적용하는 것이 아니라 특정 관계를 유추하기 때문입니다 (예: “호스트A와 호스트B가http.nginx.*를 보고하므로, 웹 프론트엔드일 것이다”).
참고: Datadog에서 메트릭 이름은 대소문자를 구분합니다.
태그 이름 규칙 및 모범 사례
Datadog은 모범 사례로써 태그를 할당할 때 통합 서비스 태깅을 사용할 것을 권장합니다. 통합 서비스 태깅은 표준 태그 3가지(env, service, version)를 사용하여 Datadog 원격 측정 데이터와 결합합니다. 사용자의 환경에서 통합형 태깅을 설정하는 방법을 자세히 알아보려면 통합 서비스 태깅 가이드를 참조하세요.
- 태그는 문자로 시작해야 합니다.
- 영숫자, 밑줄, 빼기 기호, 콜론, 마침표, 슬래시를 포함할 수 있습니다. 다른 문자는 밑줄로 변환됩니다.
- 끝에 붙은 밑줄은 변환된 문자에서 유래했든 원래 태그 값에 있었든 제거됩니다.
- 연속된 밑줄은 하나의 밑줄로 축소됩니다.
- 태그는 키와 값을 포함하여 최대 200자까지 가능하며 유니코드를 지원합니다. 이 제한을 초과하는 문자는 잘립니다.
- 태그는 소문자로 변환됩니다.
- 최적의 기능을 위해
key:value 구문을 사용하는 것이 좋습니다.
일반적으로 사용되는 메트릭 태그 키는 instance, name, role입니다.
참고 자료
