Create an automation

• 1: Create a Slack automation
• 2: Create a webhook automation

1 - Create a Slack automation

이 페이지에서는 Slack 자동화를 만드는 방법을 보여줍니다. 웹훅 자동화를 만들려면 웹훅 자동화 생성를 대신 참조하세요.

Slack 자동화를 생성하려면 다음과 같은 단계를 수행합니다.

1. Slack 통합 추가를 통해 Weights & Biases가 Slack 인스턴스 및 채널에 게시할 수 있도록 승인합니다.
2. Slack 자동화 생성를 통해 감시할 이벤트와 게시할 채널을 정의합니다.

Slack에 연결

팀 관리자는 팀에 Slack 대상을 추가할 수 있습니다.

1. W&B에 로그인하고 팀 설정 페이지로 이동합니다.

2. Slack 채널 통합 섹션에서 Slack 연결을 클릭하여 새 Slack 인스턴스를 추가합니다. 기존 Slack 인스턴스에 대한 채널을 추가하려면 새로운 통합을 클릭합니다.

   필요한 경우 브라우저에서 Slack에 로그인합니다. 메시지가 표시되면 선택한 Slack 채널에 게시할 수 있는 권한을 W&B에 부여합니다. 페이지를 읽은 다음 채널 검색을 클릭하고 채널 이름을 입력하기 시작합니다. 목록에서 채널을 선택한 다음 허용을 클릭합니다.

3. Slack에서 선택한 채널로 이동합니다. [Your Slack handle] added an integration to this channel: Weights & Biases와 같은 게시물이 표시되면 통합이 올바르게 구성된 것입니다.

이제 구성한 Slack 채널에 알림을 보내는 자동화 생성를 할 수 있습니다.

Slack 연결 보기 및 관리

팀 관리자는 팀의 Slack 인스턴스 및 채널을 보고 관리할 수 있습니다.

1. W&B에 로그인하고 팀 설정으로 이동합니다.
2. Slack 채널 통합 섹션에서 각 Slack 대상을 봅니다.
3. 휴지통 아이콘을 클릭하여 대상을 삭제합니다.

자동화 생성

W&B 팀을 Slack에 연결한 후 Registry 또는 Project를 선택한 다음 다음 단계에 따라 Slack 채널에 알림을 보내는 자동화를 만듭니다.

• Registry
• Project

자동화 보기 및 관리

• Registry
• Project

2 - Create a webhook automation

이 페이지에서는 webhook 자동화를 만드는 방법을 보여줍니다. Slack 자동화를 만들려면 Slack 자동화 만들기를 참조하세요.

개략적으로 webhook 자동화를 만들려면 다음 단계를 수행합니다.

1. 필요한 경우 액세스 토큰, 비밀번호 또는 SSH 키와 같이 자동화에 필요한 각 민감한 문자열에 대해 W&B secret 만들기를 수행합니다. secret은 팀 설정에 정의되어 있습니다.
2. webhook 만들기를 수행하여 엔드포인트 및 인증 세부 정보를 정의하고 통합에 필요한 secret에 대한 엑세스 권한을 부여합니다.
3. 자동화 만들기를 수행하여 감시할 이벤트와 W&B가 보낼 페이로드를 정의합니다. 페이로드에 필요한 secret에 대한 자동화 엑세스 권한을 부여합니다.

webhook 만들기

팀 관리자는 팀에 대한 webhook을 추가할 수 있습니다.

1. W&B에 로그인하고 팀 설정 페이지로 이동합니다.

2. Webhooks 섹션에서 New webhook을 클릭합니다.

3. webhook의 이름을 입력합니다.

4. webhook의 엔드포인트 URL을 입력합니다.

5. webhook에 Bearer 토큰이 필요한 경우 Access token을 해당 토큰을 포함하는 secret으로 설정합니다. webhook 자동화를 사용할 때 W&B는 Authorization: Bearer HTTP 헤더를 엑세스 토큰으로 설정하고 ${ACCESS_TOKEN} 페이로드 변수에서 토큰에 엑세스할 수 있습니다.

6. webhook의 페이로드에 비밀번호 또는 기타 민감한 문자열이 필요한 경우 Secret을 해당 문자열을 포함하는 secret으로 설정합니다. webhook을 사용하는 자동화를 구성할 때 이름 앞에 $를 붙여 페이로드 변수로 secret에 엑세스할 수 있습니다.

   webhook의 엑세스 토큰이 secret에 저장된 경우 secret을 엑세스 토큰으로 지정하려면 또한 다음 단계를 완료해야 합니다.

7. W&B가 엔드포인트에 연결하고 인증할 수 있는지 확인하려면:

   1. 선택적으로 테스트할 페이로드를 제공합니다. 페이로드에서 webhook이 엑세스할 수 있는 secret을 참조하려면 이름 앞에 $를 붙입니다. 이 페이로드는 테스트에만 사용되며 저장되지 않습니다. 자동화를 만들 때 자동화의 페이로드를 구성합니다. secret과 엑세스 토큰이 POST 요청에 지정된 위치를 보려면 webhook 문제 해결을 참조하세요.
   2. Test를 클릭합니다. W&B는 구성한 자격 증명을 사용하여 webhook의 엔드포인트에 연결을 시도합니다. 페이로드를 제공한 경우 W&B는 해당 페이로드를 보냅니다.

   테스트가 성공하지 못하면 webhook의 구성을 확인하고 다시 시도하세요. 필요한 경우 webhook 문제 해결을 참조하세요.

이제 webhook을 사용하는 자동화를 만들 수 있습니다.

자동화 만들기

webhook을 구성한 후 Registry 또는 Project를 선택한 다음 다음 단계에 따라 webhook을 트리거하는 자동화를 만듭니다.

• Registry
• Project

자동화 보기 및 관리

• Registry
• Project

페이로드 참조

이 섹션을 사용하여 webhook의 페이로드를 구성합니다. webhook 및 해당 페이로드 테스트에 대한 자세한 내용은 webhook 문제 해결을 참조하세요.

페이로드 변수

이 섹션에서는 webhook의 페이로드를 구성하는 데 사용할 수 있는 변수에 대해 설명합니다.

페이로드 예시

이 섹션에는 몇 가지 일반적인 유스 케이스에 대한 webhook 페이로드 예시가 포함되어 있습니다. 이 예시는 페이로드 변수를 사용하는 방법을 보여줍니다.

• GitHub repository dispatch
• Microsoft Teams 알림
• Slack 알림

on:
repository_dispatch:
  types: BUILD_AND_DEPLOY

{
  "event_type": "BUILD_AND_DEPLOY",
  "client_payload": 
  {
    "event_author": "${event_author}",
    "artifact_version": "${artifact_version}",
    "artifact_version_string": "${artifact_version_string}",
    "artifact_collection_name": "${artifact_collection_name}",
    "project_name": "${project_name}",
    "entity_name": "${entity_name}"
    }
}

${event_type} --> "LINK_ARTIFACT" 또는 "ADD_ARTIFACT_ALIAS"
${event_author} --> "<wandb-user>"
${artifact_version} --> "wandb-artifact://_id/QXJ0aWZhY3Q6NTE3ODg5ODg3""
${artifact_version_string} --> "<entity>/model-registry/<registered_model_name>:<alias>"
${artifact_collection_name} --> "<registered_model_name>"
${project_name} --> "model-registry"
${entity_name} --> "<entity>"

{
"@type": "MessageCard",
"@context": "http://schema.org/extensions",
"summary": "New Notification",
"sections": [
  {
    "activityTitle": "Notification from WANDB",
    "text": "This is an example message sent via Teams webhook.",
    "facts": [
      {
        "name": "Author",
        "value": "${event_author}"
      },
      {
        "name": "Event Type",
        "value": "${event_type}"
      }
    ],
    "markdown": true
  }
]
}

{
    "text": "New alert from WANDB!",
"blocks": [
    {
            "type": "section",
        "text": {
            "type": "mrkdwn",
            "text": "Registry event: ${event_type}"
        }
    },
        {
            "type":"section",
            "text": {
            "type": "mrkdwn",
            "text": "New version: ${artifact_version_string}"
        }
        },
        {
        "type": "divider"
    },
        {
            "type": "section",
        "text": {
            "type": "mrkdwn",
            "text": "Author: ${event_author}"
        }
        }
    ]
}

webhook 문제 해결

W&B App UI를 사용하여 대화식으로 또는 Bash 스크립트를 사용하여 프로그래밍 방식으로 webhook 문제를 해결합니다. 새 webhook을 만들거나 기존 webhook을 편집할 때 webhook 문제를 해결할 수 있습니다.

• W&B App UI
• Bash 스크립트