생성¶
POST /api/v1/error_track_rule/add
개요¶
오류 추적 소스 규칙을 생성합니다.
호출 전 확인 및 사용 단계¶
현재 Key에는 errorCenter.errorTrackRuleManage 권한이 필요하며, 현재 워크스페이스에만 적용됩니다. 먼저 type을 결정한 다음, 해당 인덱스/앱/서비스 목록에서 실제 sources를 가져와야 하며, 이전 예시의 wsAdmin/acnt_/group_을 그대로 사용해서는 안 됩니다. *는 전체 소스 표시이며, []는 와일드카드가 아닙니다. 알 수 없는 소스는 저장에 성공하더라도 유효한 매칭을 생성하지 못할 수 있습니다. logging에서 외부 스토리지에 바인딩된 활성 인덱스를 명시적으로 지정하면 거부되며, 그 외 소스는 항목별 존재 여부 검증을 수행하지 않습니다.
생성 시 이름 고유성 검사와 공개 멱등 키가 없으므로, 동일한 이름의 반복 요청은 여러 규칙을 생성할 수 있습니다. 타임아웃/500이 발생하면 먼저 목록에서 이름/내용으로 확인하고, 무작정 생성을 재시도하지 마세요.
이 엔드포인트는 규칙을 저장하고 데이터베이스에 커밋하며, 이 컨트롤러에서 하위 동기화를 호출하거나 과거 데이터 재계산을 수행하지 않고, 배포/스캔 작업도 반환하지 않습니다. HTTP 200은 이번 저장 응답만 확인하며, 이후 오류 산출과 실제 처리 범위는 비즈니스 데이터로 검증해야 합니다. extend에는 공개된 고정 실행 하위 키가 없으므로, 자유 객체를 알림/임계값 엔진으로 간주해서는 안 됩니다. 커밋 전 엔터티 스냅샷을 반환하며, 신규 id는 null일 수 있고 sourcesInfo나 신원 부가 요약이 없습니다. 상세를 다시 조회하면 최종 id와 RUM 요약을 얻을 수 있습니다.
요청 헤더¶
| 파라미터명 | 타입 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예: <DF-API-KEY>획득 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 발급받아 입력합니다. |
Body 요청 파라미터¶
| 파라미터명 | 타입 | 필수 | 설명 |
|---|---|---|---|
| sources[*] | any | 문자열을 권장하며, 인덱스 name/appId/서비스 service 또는 *입니다. 원래 선언에는 요소 타입 제약이 없습니다. 객체/배열 등은 저장 후 RUM 목록 요약이나 하위 처리에서 500을 유발할 수 있으므로 인터페이스의 차단에 의존할 수 없습니다. 계정/팀/역할 UUID가 아닙니다. 예: payment_web획득 또는 입력 방법: type=logging이면 로그 인덱스 목록에서 name을 가져오고 isBindCustomStore=1을 제외합니다. type=rum이면 RUM 앱 요약 목록에서 appId를 가져옵니다. type=tracing이면 서비스 목록에서 service를 가져옵니다. 와일드카드는 리터럴 값 *를 사용합니다. |
|
| extend.사용자 정의 키 | any | 임의의 JSON 값으로 객체/배열/문자열/숫자/불리언/null이 가능합니다. 고정된 필수 하위 키가 없으며, 자격 증명을 넣지 마세요. 예: payment획득 또는 입력 방법: 호출 측의 규칙 표시 정보입니다. |
|
| desc | string | 선택적 문자열로 최대 256자이며 빈 값을 허용합니다. 생성 시 생략하면 빈 값으로, 수정 시 생략해도 비워지며 기존 값을 유지하지 않습니다. 빈 문자열 허용: True null 허용: False 최대 길이: 256 예: 跟踪支付Web应用错误획득 또는 입력 방법: 규칙 관리자가 용도/범위 설명을 입력합니다. |
|
| extend | json | 선택적 JSON 객체로, 루트가 null/배열/문자열이면 406이 반환됩니다. 생성 시 생략하면 {}, 수정 시 생략해도 {}로 기존 값을 전체 교체하며, {}를 제출하면 비워집니다. 이 Studio 구현은 객체만 저장하므로, 임의의 하위 키를 근거로 임계값/알림/정규식 등의 실행 기능을 추론해서는 안 됩니다. null 허용: False 예: {"ownerTeam": "payment"}획득 또는 입력 방법: 호출 측이 규칙 유지 및 표시 정보를 저장할 수 있으며, 공개된 고정 실행 하위 구성은 없습니다. |
|
| name | string | Y | 필수 문자열로 최대 128자입니다. 선언상 비어 있지 않음을 강제하지 않지만, 비어 있지 않은 값을 권장합니다. 동일한 이름에 대한 이 인터페이스의 고유성 검사가 없으므로 이름을 멱등 키로 사용하지 마세요. 수정 시에도 필수이며 전체 교체됩니다. null 허용: False 최대 길이: 128 예: 支付Web错误聚合획득 또는 입력 방법: 호출 측이 식별 가능한 규칙 이름을 입력합니다. |
| sources | array | 선택적 배열로 생략하면 []입니다. 수정 시 값을 지정하면 전체 교체되고, 생략해도 비워지며, []는 와일드카드가 아니므로 모든 소스는 ["*"]로 명시해야 합니다. 현재 항목별 유효 문자열/존재 여부를 검증하지 않으므로, 클라이언트는 실제 이름/식별자를 사용해야 합니다. 알 수 없는 값의 저장이 매칭 유효성을 보장하지 않습니다. logging에서 현재 활성 상태인 외부 바인딩 인덱스를 지정하면 404가 반환됩니다. *는 외부 인덱스를 개별적으로 점검하지 않으므로, 저장 성공으로 외부 인덱스 지원을 보장할 수 없습니다. null 허용: False 예: ["payment_web"]획득 또는 입력 방법: type=logging이면 로그 인덱스 목록에서 name을 가져오고 isBindCustomStore=1을 제외합니다. type=rum이면 RUM 앱 요약 목록에서 appId를 가져옵니다. type=tracing이면 서비스 목록에서 service를 가져옵니다. 와일드카드는 리터럴 값 *를 사용합니다. |
|
| type | string | Y | 필수이며 logging/tracing/rum 중 하나입니다. 수정 시에도 필수이고 타입 변경이 허용되지만, 반드시 새 타입에 맞는 sources를 함께 재구성해야 하며 앱 ID/인덱스 이름/서비스 이름을 혼용할 수 없습니다. null 허용: False 선택 가능한 값: ['logging', 'tracing', 'rum'] 예: rum획득 또는 입력 방법: 오류 데이터 소스에 따라 선택합니다. logging은 로그, tracing은 분산 추적, rum은 실제 사용자 모니터링입니다. |
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/error_track_rule/add' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"name":"支付Web错误聚合","desc":"跟踪支付Web应用错误","type":"rum","sources":["payment_web"],"extend":{"ownerTeam":"payment"}}'
응답¶
HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 타입 | 설명 |
|---|---|---|
| content | object | 저장된 규칙 엔터티 스냅샷입니다. |
| content.id | integer 또는 null | 데이터베이스 행 ID이며 경로 탐색에 사용되지 않습니다. 커밋 전 스냅샷에서는 null일 수 있습니다. |
| content.uuid | string | 오류 추적 규칙 UUID로, issetrule_ 접두사가 붙습니다. 오류 처리 메타데이터 isset_ 또는 텔레메트리 issue_id가 아닙니다. |
| content.status | integer | 데이터베이스 상태: 0 활성, 2 비활성, 3 소프트 삭제(조회 시 3은 제외). |
| content.creator | string | 생성 주체 UUID로, 이 공개 엔드포인트에서는 일반적으로 생성 Key 리소스 wsak_입니다. 과거 레코드는 다른 주체일 수 있으며, sys 메타데이터가 자동으로 초기화되지 않습니다. |
| content.updator | string | 최근 업데이트 주체이며, 업데이트가 없으면 비어 있을 수 있습니다. |
| content.createAt | integer | Unix 초 단위 생성 시간입니다. |
| content.updateAt | integer | Unix 초 단위 업데이트 시간이며, 생성 후 업데이트가 없으면 보통 -1입니다. |
| content.deleteAt | integer | Unix 초 단위 삭제 시간이며, 삭제되지 않았으면 보통 -1입니다. |
| content.workspaceUUID | string | 현재 Key가 속한 워크스페이스입니다. |
| content.name | string | 규칙 이름이며 동일한 이름을 허용합니다. |
| content.desc | string | 규칙 설명입니다. |
| content.type | string | logging/tracing/rum. |
| content.sources | array | 저장된 소스 배열이며, 클라이언트는 문자열만 사용해야 합니다. 과거의 비문자열 값은 허용 범위 내에서 처리해야 합니다. |
| content.sources[] | JSON | 정상적으로는 인덱스 이름/appId/서비스 이름 또는 *입니다. 역할이나 계정 ID가 아닙니다. |
| content.extend | object 또는 null | 저장된 확장 값으로, 정상적으로는 객체로 기록됩니다. 과거 값은 허용 범위 내에서 처리해야 합니다. |
| content.extend.사용자 정의 키 | JSON | 사용자 정의 저장 값이며 고정된 실행 의미는 없습니다. |
| content.declaration | object 또는 null | 현재 워크스페이스의 공용 선언입니다. |
{
"code": 200,
"content": {
"id": null,
"uuid": "issetrule_example",
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"workspaceUUID": "wksp_example",
"name": "支付Web错误聚合",
"desc": "跟踪支付Web应用错误",
"type": "rum",
"sources": [
"payment_web"
],
"extend": {
"ownerTeam": "payment"
},
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참고하세요.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 요청 필드 누락 또는 필드 값이 선언된 검증 조건 위반 | 파라미터 파싱 실패 | 파라미터 위치, 필드명, 타입, 값을 확인합니다. |
| 400 | ft.RequestJsonFormatError | 요청 JSON 구문이 유효하지 않음 | 요청 JSON 형식 오류 | content.reason, line, column에 따라 JSON을 수정합니다. |
| 400 | ft.JsonFormatError | JSON 최상위가 객체가 아님 | 일부 json 파일 형식 오류 | 규칙 객체를 제출합니다. |
| 404 | ft.NotSupportExternalLogIndexCfg | type=logging이고 sources가 현재 워크스페이스의 활성 isBindCustomStore=1 인덱스를 명시적으로 지정 | 외부 인덱스 구성 미지원 | 내장 인덱스를 선택하거나 지원되는 소스로 변경합니다. *로 우회하여 외부 인덱스가 지원된다고 추론하지 마세요. |
| 500 | ft.InternalServerError | 데이터베이스, 과거 객체 또는 처리되지 않은 저장/응답 구성 예외 | 내부 오류 | 먼저 규칙 목록/상세를 다시 읽어 실제 저장 여부를 확인합니다. 생성에는 멱등 키가 없으므로 결과가 불확실한 요청을 반복 제출하지 마세요. |