외부 이벤트 모니터 이벤트 수락¶
POST /api/v1/push-events/{secret}/{subUri}
개요¶
외부 이벤트를 수신하고, 해당 이벤트에 따라 이벤트 데이터를 생성합니다.
참고: secret 및 subUri 정보가 모니터에 기록된 정보와 일치하지 않으면 해당 이벤트는 무시됩니다.
경로 매개변수¶
| 매개변수명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| secret | string | Y | 외부 이벤트 모니터 secret (새 모니터 생성 시 secret 필드에 해당; 이 값이 모니터 구성과 일치하지 않으면 이벤트가 무시됨) |
| subUri | string | Y | 외부 이벤트 모니터 subUri (새 모니터 생성 시 jsonScript.subUri 필드에 해당; 이 값이 모니터 구성과 일치하지 않으면 이벤트가 무시됨) |
Body 요청 매개변수¶
| 매개변수명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| event | json | Y | 이벤트 데이터 비어 있음 허용: False |
| extraData | json | 추가 데이터. 최종적으로 이벤트의 df_meta.extra_data 필드에 추가됨 비어 있음 허용: False $required: False |
매개변수 추가 설명¶
매개변수 설명:
body 요청 매개변수 본문 구조 설명
| 매개변수명 | 매개변수 유형 | 필수 전송 여부 | 매개변수 설명 |
|---|---|---|---|
| event | json | 예 | 이벤트 데이터 |
| extraData | json | 아니요 | 추가 데이터. 최종적으로 이벤트의 df_meta.extra_data 필드에 추가됨. key:value 형식이면 됨 |
event 요청 매개변수 본문 구조 설명
| 매개변수명 | 매개변수 유형 | 필수 전송 여부 | 매개변수 설명 |
|---|---|---|---|
| date | int | 아니요 | 이벤트 시간 (단위: 초) |
| status | string | 예 | 이벤트 상태. 선택 가능: fatal, critical, error, warning, info, ok |
| title | string | 아니요 | 이벤트 제목 |
| message | string | 아니요 | 이벤트 내용 |
| dimension_tags | json | 아니요 | 차원 태그. 예: |
| check_value | float | 아니요 | 검사 값 |
| 사용자 정의 필드 | str | 아니요 | 2024-09-04 사용자 정의 필드. 이벤트 최상위 필드로 사용되며 제한 조건을 충족해야 함 |
event.{사용자 정의 필드} 제한 조건 설명
동일한 필드명에 다른 유형이 보고되어 후속 문제가 발생하는 것을 방지하기 위해 사용자 정의 필드는 다음 제한 조건을 충족해야 합니다.
- 필드 값은 반드시 문자열 유형이어야 함 (예: "abc", "123")
- 필드명은 밑줄(_) 또는 df_로 시작할 수 없음
- 필드명은 dimension_tags 분해 필드명, labels 분해 필드명과 중복될 수 없음
- 필드명은 다음 예약 필드를 사용할 수 없음 (사용자 정의 필드는 모두 직접 정의한 접두사로 시작하는 것을 권장, 예: ext_xxx, biz_xxx 등으로 구분):
- date
- status
- source
- title
- message
- dimension_tags
- check_value
- time
- time_us
- timestamp
- workspace_uuid
- workspace_name
- extra_data
- create_time
요청 예시¶
curl 'https://openapi.guance.com/api/v1/push-events/<secret>/<subUri>' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"event":{"status":"warning","title":"title1","message":"message1","dimension_tags":{"heros":"caiwenji"},"check_value":20},"extraData":{"name":"xxxxxxxx"}}' \
--compressed