InfoGrab DocsInfoGrab Docs

이벤트 정의 가이드

요약

이벤트 사전은 현재 진행 중인 작업이며, 이 프로세스는 변경될 수 있습니다. 이 가이드는 이벤트 사전과 그 구현 방법을 설명합니다. 이 프로세스는 모든 내부 이벤트를 문서화하고 일관성을 보장하기 위한 것입니다. 모든 이벤트 정의는 다음 디렉터리에 저장됩니다:

이벤트 사전은 현재 진행 중인 작업이며, 이 프로세스는 변경될 수 있습니다.

이 가이드는 이벤트 사전과 그 구현 방법을 설명합니다.

이벤트 정의 및 검증#

이 프로세스는 모든 내부 이벤트를 문서화하고 일관성을 보장하기 위한 것입니다. 모든 내부 이벤트에는 이러한 정의가 필요합니다. 이벤트 정의는 JSON Schema를 준수해야 합니다.

모든 이벤트 정의는 다음 디렉터리에 저장됩니다:

제거된 이벤트는 /removed 하위 폴더에 저장됩니다:

자세한 내용은 이벤트 라이프사이클 가이드를 참조하세요.

각 이벤트는 다음 필드로 구성된 별도의 YAML 파일에 정의됩니다:

필드 필수 여부 추가 정보
description 예 이벤트에 대한 설명입니다.
internal_events 아니요 Internal Events에 사용되는 이벤트의 경우 항상 true입니다.
category 아니요 레거시 이벤트에 필요합니다. Internal Events에는 사용하지 않아야 합니다.
action 예 이벤트의 고유한 이름입니다. 소문자, 숫자, 밑줄만 허용됩니다. <operation>_<target_of_operation>_<where/when> 형식을 사용합니다. 예: publish_go_module_to_the_registry_from_pipeline — <operation> = publish, <target> = go_module, <when/where> = to_the_registry_from_pipeline
identifiers 아니요 이벤트와 함께 전송되는 식별자 목록입니다. project, user, namespace, feature_enabled_by_namespace_ids 중 하나 이상으로 설정할 수 있습니다.
product_group 예 이벤트를 소유하는 그룹입니다.
product_categories 아니요 이벤트가 나타내는 기능 카테고리 목록입니다. 일부 이벤트는 여러 카테고리에 해당하거나 카테고리가 없을 수 있습니다.
milestone 아니요 이벤트가 도입된 마일스톤입니다.
status 아니요 이벤트의 상태입니다. active, removed, 또는 null 중 하나로 설정할 수 있습니다.
milestone_removed 아니요 이벤트가 제거된 마일스톤입니다.
removed_by_url 아니요 이벤트를 제거한 머지 리퀘스트의 URL입니다.
introduced_by_url 아니요 이벤트를 도입한 머지 리퀘스트의 URL입니다.
tiers 예 추적되는 기능이 사용 가능한 티어입니다. free, premium, ultimate 중 하나 이상으로 설정할 수 있습니다.
additional_properties 아니요 이벤트와 함께 전송되는 추가 속성 목록입니다. 각 추가 속성에는 description 필드가 있는 레코드 항목이 있어야 합니다. 이벤트 정의 파일에 이벤트와 함께 전송될 모든 추가 속성을 추가해야 합니다. 기본 제공 속성은 label(문자열), property(문자열), value(숫자)입니다. 기본 제공 옵션이 충분하지 않은 경우 사용자 정의 속성을 추가할 수 있습니다.

이벤트 정의에서 action 속성 변경#

이벤트 정의에서 action 필드 변경을 고려할 때 다음 사항을 알아두어야 합니다:

  • 이벤트 이름을 변경하는 것은 기존 이벤트를 삭제하고 새 이벤트를 생성하는 것과 동일합니다. 이벤트가 어떤 메트릭에도 사용되지 않는 경우에는 허용됩니다.

  • YAML 파일의 이름이 새 action 이름과 일치하는지 확인하여 혼란을 방지하세요. 이렇게 하면 이벤트 정의의 명확성과 일관성을 유지하는 데 도움이 됩니다.

이벤트 정의 예시#

다음은 내부 이벤트에 대한 YAML 파일 예시입니다:

description: A user visited a product analytics dashboard
internal_events: true
action: visit_product_analytics_dashboard
identifiers:
- project
- user
- namespace
product_group: group::product analytics
milestone: "16.4"
introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/128029
tiers:
- ultimate

이벤트 정의 가이드

GitLab v19.1
원문 보기
요약

이벤트 사전은 현재 진행 중인 작업이며, 이 프로세스는 변경될 수 있습니다. 이 가이드는 이벤트 사전과 그 구현 방법을 설명합니다. 이 프로세스는 모든 내부 이벤트를 문서화하고 일관성을 보장하기 위한 것입니다. 모든 이벤트 정의는 다음 디렉터리에 저장됩니다:

이벤트 사전은 현재 진행 중인 작업이며, 이 프로세스는 변경될 수 있습니다.

이 가이드는 이벤트 사전과 그 구현 방법을 설명합니다.

이벤트 정의 및 검증#

이 프로세스는 모든 내부 이벤트를 문서화하고 일관성을 보장하기 위한 것입니다. 모든 내부 이벤트에는 이러한 정의가 필요합니다. 이벤트 정의는 JSON Schema를 준수해야 합니다.

모든 이벤트 정의는 다음 디렉터리에 저장됩니다:

제거된 이벤트는 /removed 하위 폴더에 저장됩니다:

자세한 내용은 이벤트 라이프사이클 가이드를 참조하세요.

각 이벤트는 다음 필드로 구성된 별도의 YAML 파일에 정의됩니다:

필드 필수 여부 추가 정보
description 예 이벤트에 대한 설명입니다.
internal_events 아니요 Internal Events에 사용되는 이벤트의 경우 항상 true입니다.
category 아니요 레거시 이벤트에 필요합니다. Internal Events에는 사용하지 않아야 합니다.
action 예 이벤트의 고유한 이름입니다. 소문자, 숫자, 밑줄만 허용됩니다. <operation>_<target_of_operation>_<where/when> 형식을 사용합니다. 예: publish_go_module_to_the_registry_from_pipeline — <operation> = publish, <target> = go_module, <when/where> = to_the_registry_from_pipeline
identifiers 아니요 이벤트와 함께 전송되는 식별자 목록입니다. project, user, namespace, feature_enabled_by_namespace_ids 중 하나 이상으로 설정할 수 있습니다.
product_group 예 이벤트를 소유하는 그룹입니다.
product_categories 아니요 이벤트가 나타내는 기능 카테고리 목록입니다. 일부 이벤트는 여러 카테고리에 해당하거나 카테고리가 없을 수 있습니다.
milestone 아니요 이벤트가 도입된 마일스톤입니다.
status 아니요 이벤트의 상태입니다. active, removed, 또는 null 중 하나로 설정할 수 있습니다.
milestone_removed 아니요 이벤트가 제거된 마일스톤입니다.
removed_by_url 아니요 이벤트를 제거한 머지 리퀘스트의 URL입니다.
introduced_by_url 아니요 이벤트를 도입한 머지 리퀘스트의 URL입니다.
tiers 예 추적되는 기능이 사용 가능한 티어입니다. free, premium, ultimate 중 하나 이상으로 설정할 수 있습니다.
additional_properties 아니요 이벤트와 함께 전송되는 추가 속성 목록입니다. 각 추가 속성에는 description 필드가 있는 레코드 항목이 있어야 합니다. 이벤트 정의 파일에 이벤트와 함께 전송될 모든 추가 속성을 추가해야 합니다. 기본 제공 속성은 label(문자열), property(문자열), value(숫자)입니다. 기본 제공 옵션이 충분하지 않은 경우 사용자 정의 속성을 추가할 수 있습니다.

이벤트 정의에서 action 속성 변경#

이벤트 정의에서 action 필드 변경을 고려할 때 다음 사항을 알아두어야 합니다:

  • 이벤트 이름을 변경하는 것은 기존 이벤트를 삭제하고 새 이벤트를 생성하는 것과 동일합니다. 이벤트가 어떤 메트릭에도 사용되지 않는 경우에는 허용됩니다.

  • YAML 파일의 이름이 새 action 이름과 일치하는지 확인하여 혼란을 방지하세요. 이렇게 하면 이벤트 정의의 명확성과 일관성을 유지하는 데 도움이 됩니다.

이벤트 정의 예시#

다음은 내부 이벤트에 대한 YAML 파일 예시입니다:

description: A user visited a product analytics dashboard
internal_events: true
action: visit_product_analytics_dashboard
identifiers:
- project
- user
- namespace
product_group: group::product analytics
milestone: "16.4"
introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/128029
tiers:
- ultimate