API 키 및 인증
Telemetry API 요청은 팀 API 키를 사용합니다. 키를 프로덕션 자격 증명처럼 취급합니다. 명명된 워크로드에 대해 키를 생성하고, 필요한 최소 범위를 제공하고, 소스 제어 외부에 저장하고, 워크로드가 폐기되면 취소합니다.
팀 설정 → API 키를 열어 키를 생성하거나 관리하세요. 전체 값은 자격 증명이므로 공유 문서나 이슈가 아닌 대상 비밀 관리자에 복사하세요.
가장 좁은 범위를 선택하세요
Telemetry는 세 가지 범위를 지원합니다.
| 범위 | 다음 용도로 사용하세요. |
|---|---|
read |
쿼리, 테이블 검색, 스키마 및 읽기 전용 보고 |
write |
이벤트 수집 및 지원되는 쓰기 작업 |
read-and-write |
데이터를 전송하고 쿼리해야 하는 신뢰할 수 있는 서버 또는 자동화 |
이벤트만 내보내는 애플리케이션에는 일반적으로 write가 필요합니다. 보고 작업에는 일반적으로 read가 필요합니다. 브라우저, 모바일 애플리케이션, 공개 저장소 또는 사용자 작성 스크립트에 팀 키를 제공하지 마십시오.
키 보내기
HTTP 엔드포인트는 키를 원시 Authorization 값 또는 전달자 토큰으로 허용합니다.
curl https://api.telemetry.sh/tables \
-H "Authorization: Bearer $TELEMETRY_API_KEY"
SDK 초기화에서는 동일한 API 키를 허용합니다. 서버 측 코드에서 초기화를 유지하고 환경 변수 또는 비밀 관리자 조회를 사용합니다.
import telemetry from "telemetry-sh";
telemetry.init(process.env.TELEMETRY_API_KEY);
NEXT_PUBLIC_와 같은 공개 빌드 시간 접두사를 사용하거나 키를 클라이언트 구성으로 직렬화하지 마세요.
워크로드별로 키 분리
프로덕션 수집, 준비, 예약된 보고 및 코딩 에이전트 설정에 고유 키를 사용합니다. 워크로드별 키는 순환 및 사고 대응을 더 작게 만듭니다. 하나의 보고 키를 취소해도 이벤트 수집이 중단되어서는 안 됩니다.
소유자와 목적에 따라 키 이름을 지정하세요. 키 값 자체를 기록하지 않고 키가 배포된 위치, 범위, 예상 순환 소유자를 기록합니다.
안전하게 순환 및 취소
먼저 대체 키를 생성하여 워크로드에 배포하고 성공적인 요청을 확인한 후 이전 키를 취소합니다. read-and-write 키를 순환할 때 수집 및 쿼리 경로를 모두 실행합니다.
커밋, 로그, 스크린샷, 프롬프트 또는 공개 클라이언트 번들에 키가 나타나면 손상된 것으로 간주하세요. 즉시 취소하고 교체한 후 영향을 받은 팀 테이블과 쿼리 활동을 검토하세요.
로그 API, 쿼리 API 및 민감한 데이터 지침을 계속 진행하세요.