히스토리

• 사용자 지정 HTTP 헤더 API가 GitLab 15.1에서 streaming_audit_event_headers라는 플래그와 함께 도입되었습니다. 기본적으로 비활성화됩니다.
• 사용자 지정 HTTP 헤더 API가 GitLab 15.2에서 GitLab.com 및 GitLab Self-Managed에서 활성화되었습니다.
• 사용자 지정 HTTP 헤더 API가 GitLab 15.3에서 일반 제공되었습니다. 기능 플래그 streaming_audit_event_headers가 제거되었습니다.
• 사용자 지정 검증 토큰 API 지원이 GitLab 15.4에서 도입되었습니다.
• 기능 플래그 ff_external_audit_events가 GitLab 16.2에서 기본적으로 활성화되었습니다.
• 사용자 지정 대상 이름 API 지원이 GitLab 16.2에서 도입되었습니다.
• API 기능 플래그 ff_external_audit_events가 GitLab 16.4에서 제거되었습니다.

GraphQL API를 사용하여 최상위 그룹의 감사 이벤트 스트리밍 대상을 관리합니다.

HTTP 대상#

최상위 그룹의 HTTP 스트리밍 대상을 관리합니다.

새 스트리밍 대상 추가#

최상위 그룹에 새 스트리밍 대상을 추가합니다.

전제 조건:

• 최상위 그룹에 대한 Owner 역할.

스트리밍을 활성화하고 최상위 그룹에 대상을 추가하려면 externalAuditEventDestinationCreate 뮤테이션을 사용합니다.

mutation {
  externalAuditEventDestinationCreate(input: { destinationUrl: "https://mydomain.io/endpoint/ingest", groupPath: "my-group" } ) {
    errors
    externalAuditEventDestination {
      id
      name
      destinationUrl
      verificationToken
      group {
        name
      }
    }
  }
}

externalAuditEventDestinationCreate GraphQL 뮤테이션을 사용하여 선택적으로 사용자 지정 검증 토큰을 지정할 수 있습니다(기본 GitLab 생성 토큰 대신). 검증 토큰 길이는 16~24자 이내여야 하며 후행 공백은 제거되지 않습니다. 암호학적으로 임의적이고 고유한 값을 설정해야 합니다. 예:

mutation {
  externalAuditEventDestinationCreate(input: { destinationUrl: "https://mydomain.io/endpoint/ingest", groupPath: "my-group", verificationToken: "unique-random-verification-token-here" } ) {
    errors
    externalAuditEventDestination {
      id
      name
      destinationUrl
      verificationToken
      group {
        name
      }
    }
  }
}

externalAuditEventDestinationCreate GraphQL 뮤테이션을 사용하여 선택적으로 사용자 지정 대상 이름을 지정할 수 있습니다(기본 GitLab 생성 이름 대신). 이름 길이는 72자를 초과할 수 없으며 후행 공백은 제거되지 않습니다. 이 값은 그룹 범위 내에서 고유해야 합니다. 예:

mutation {
  externalAuditEventDestinationCreate(input: { destinationUrl: "https://mydomain.io/endpoint/ingest", name: "destination-name-here", groupPath: "my-group" }) {
    errors
    externalAuditEventDestination {
      id
      name
      destinationUrl
      verificationToken
      group {
        name
      }
    }
  }
}

다음과 같은 경우 이벤트 스트리밍이 활성화됩니다:

• 반환된 errors 객체가 비어 있습니다.
• API가 200 OK로 응답합니다.

GraphQL auditEventsStreamingHeadersCreate 뮤테이션을 사용하여 HTTP 헤더를 추가할 수 있습니다. 모든 스트리밍 대상 나열에서 또는 위의 뮤테이션에서 대상 ID를 조회할 수 있습니다.

mutation {
  auditEventsStreamingHeadersCreate(input: {
    destinationId: "gid://gitlab/AuditEvents::ExternalAuditEventDestination/1",
     key: "foo",
     value: "bar",
     active: false
  }) {
    errors
    header {
      id
      key
      value
      active
    }
  }
}

반환된 errors 객체가 비어 있으면 헤더가 생성됩니다.

스트리밍 대상 나열#

최상위 그룹의 스트리밍 대상을 나열합니다.

전제 조건:

• 최상위 그룹에 대한 Owner 역할.

externalAuditEventDestinations 쿼리 유형을 사용하여 최상위 그룹의 스트리밍 대상 목록을 볼 수 있습니다.

query {
  group(fullPath: "my-group") {
    id
    externalAuditEventDestinations {
      nodes {
        destinationUrl
        verificationToken
        id
        name
        headers {
          nodes {
            key
            value
            id
            active
          }
        }
        eventTypeFilters
        namespaceFilter {
          id
          namespace {
            id
            name
            fullName
          }
        }
      }
    }
  }
}

결과 목록이 비어 있으면 해당 그룹에 대한 감사 스트리밍이 활성화되지 않은 것입니다.

스트리밍 대상 업데이트#

최상위 그룹의 스트리밍 대상을 업데이트합니다.

전제 조건:

• 최상위 그룹에 대한 Owner 역할.

그룹의 스트리밍 대상을 업데이트하려면 externalAuditEventDestinationUpdate 뮤테이션 유형을 사용합니다. 모든 스트리밍 대상 나열에서 대상 ID를 조회할 수 있습니다.

mutation {
  externalAuditEventDestinationUpdate(input: {
    id:"gid://gitlab/AuditEvents::ExternalAuditEventDestination/1",
    destinationUrl: "https://www.new-domain.com/webhook",
    name: "destination-name"} ) {
    errors
    externalAuditEventDestination {
      id
      name
      destinationUrl
      verificationToken
      group {
        name
      }
    }
  }
}

다음과 같은 경우 스트리밍 대상이 업데이트됩니다:

• 반환된 errors 객체가 비어 있습니다.
• API가 200 OK로 응답합니다.

Owner 역할을 가진 사용자는 auditEventsStreamingHeadersUpdate 뮤테이션 유형을 사용하여 스트리밍 대상의 사용자 지정 HTTP 헤더를 업데이트할 수 있습니다. 모든 사용자 지정 HTTP 헤더 나열에서 사용자 지정 HTTP 헤더 ID를 조회할 수 있습니다.

mutation {
  auditEventsStreamingHeadersUpdate(input: { headerId: "gid://gitlab/AuditEvents::Streaming::Header/2", key: "new-key", value: "new-value", active: false }) {
    errors
    header {
      id
      key
      value
      active
    }
  }
}

그룹 Owner는 GraphQL auditEventsStreamingHeadersDestroy 뮤테이션을 사용하여 HTTP 헤더를 제거할 수 있습니다. 모든 사용자 지정 HTTP 헤더 나열에서 헤더 ID를 조회할 수 있습니다.

mutation {
  auditEventsStreamingHeadersDestroy(input: { headerId: "gid://gitlab/AuditEvents::Streaming::Header/1" }) {
    errors
  }
}

반환된 errors 객체가 비어 있으면 헤더가 삭제됩니다.

스트리밍 대상 삭제#

최상위 그룹의 스트리밍 대상을 삭제합니다.

마지막 대상이 성공적으로 삭제되면 그룹의 스트리밍이 비활성화됩니다.

전제 조건:

• 최상위 그룹에 대한 Owner 역할.

Owner 역할을 가진 사용자는 externalAuditEventDestinationDestroy 뮤테이션 유형을 사용하여 스트리밍 대상을 삭제할 수 있습니다. 모든 스트리밍 대상 나열에서 대상 ID를 조회할 수 있습니다.

mutation {
  externalAuditEventDestinationDestroy(input: { id: destination }) {
    errors
  }
}

다음과 같은 경우 스트리밍 대상이 삭제됩니다:

• 반환된 errors 객체가 비어 있습니다.
• API가 200 OK로 응답합니다.

그룹 Owner는 GraphQL auditEventsStreamingHeadersDestroy 뮤테이션을 사용하여 HTTP 헤더를 제거할 수 있습니다. 모든 사용자 지정 HTTP 헤더 나열에서 헤더 ID를 조회할 수 있습니다.

mutation {
  auditEventsStreamingHeadersDestroy(input: { headerId: "gid://gitlab/AuditEvents::Streaming::Header/1" }) {
    errors
  }
}

반환된 errors 객체가 비어 있으면 헤더가 삭제됩니다.

이벤트 유형 필터#

히스토리

• 이벤트 유형 필터 API가 GitLab 15.7에서 도입되었습니다.

이 기능이 그룹에 활성화된 경우, API를 사용하여 사용자가 대상별로 스트리밍되는 감사 이벤트를 필터링할 수 있습니다. 필터 없이 기능이 활성화된 경우, 대상은 모든 감사 이벤트를 수신합니다.

이벤트 유형 필터가 설정된 스트리밍 대상에는 filtered ([filter]) 레이블이 있습니다.

API를 사용하여 이벤트 유형 필터 추가#

전제 조건:

• 그룹에 대한 Owner 역할이 있어야 합니다.

auditEventsStreamingDestinationEventsAdd 쿼리 유형을 사용하여 이벤트 유형 필터 목록을 추가할 수 있습니다:

mutation {
    auditEventsStreamingDestinationEventsAdd(input: {
        destinationId: "gid://gitlab/AuditEvents::ExternalAuditEventDestination/1",
        eventTypeFilters: ["list of event type filters"]}){
        errors
        eventTypeFilters
    }
}

다음과 같은 경우 이벤트 유형 필터가 추가됩니다:

• 반환된 errors 객체가 비어 있습니다.
• API가 200 OK로 응답합니다.

API를 사용하여 이벤트 유형 필터 제거#

전제 조건:

• 그룹에 대한 Owner 역할이 있어야 합니다.

auditEventsStreamingDestinationEventsRemove 뮤테이션 유형을 사용하여 이벤트 유형 필터 목록을 제거할 수 있습니다:

mutation {
    auditEventsStreamingDestinationEventsRemove(input: {
    destinationId: "gid://gitlab/AuditEvents::ExternalAuditEventDestination/1",
    eventTypeFilters: ["list of event type filters"]
  }){
    errors
  }
}

다음과 같은 경우 이벤트 유형 필터가 제거됩니다:

• 반환된 errors 객체가 비어 있습니다.
• API가 200 OK로 응답합니다.

네임스페이스 필터#

히스토리

• 네임스페이스 필터 API가 GitLab 16.7에서 도입되었습니다.

그룹에 네임스페이스 필터를 적용하면, 사용자가 그룹의 특정 하위 그룹 또는 프로젝트에 대한 대상별로 스트리밍된 감사 이벤트를 필터링할 수 있습니다. 그렇지 않으면 대상은 모든 감사 이벤트를 수신합니다.

네임스페이스 필터가 설정된 스트리밍 대상에는 filtered ([filter]) 레이블이 있습니다.

API를 사용하여 네임스페이스 필터 추가#

전제 조건:

• 그룹에 대한 Owner 역할이 있어야 합니다.

하위 그룹과 프로젝트 모두에 대해 auditEventsStreamingHttpNamespaceFiltersAdd 뮤테이션 유형을 사용하여 네임스페이스 필터를 추가할 수 있습니다.

다음과 같은 경우 네임스페이스 필터가 추가됩니다:

• API가 빈 errors 객체를 반환합니다.
• API가 200 OK로 응답합니다.

하위 그룹에 대한 뮤테이션#

mutation auditEventsStreamingHttpNamespaceFiltersAdd {
  auditEventsStreamingHttpNamespaceFiltersAdd(input: {
    destinationId: "gid://gitlab/AuditEvents::ExternalAuditEventDestination/1",
    groupPath: "path/to/subgroup"
  }) {
    errors
    namespaceFilter {
      id
      namespace {
        id
        name
        fullName
      }
    }
  }
}

프로젝트에 대한 뮤테이션#

mutation auditEventsStreamingHttpNamespaceFiltersAdd {
  auditEventsStreamingHttpNamespaceFiltersAdd(input: {
    destinationId: "gid://gitlab/AuditEvents::ExternalAuditEventDestination/1",
    projectPath: "path/to/project"
  }) {
    errors
    namespaceFilter {
      id
      namespace {
        id
        name
        fullName
      }
    }
  }
}

API를 사용하여 네임스페이스 필터 제거#

전제 조건:

• 그룹에 대한 Owner 역할이 있어야 합니다.

auditEventsStreamingHttpNamespaceFiltersDelete 뮤테이션 유형을 사용하여 네임스페이스 필터를 제거할 수 있습니다:

mutation auditEventsStreamingHttpNamespaceFiltersDelete {
  auditEventsStreamingHttpNamespaceFiltersDelete(input: {
    namespaceFilterId: "gid://gitlab/AuditEvents::Streaming::HTTP::NamespaceFilter/5"
  }) {
    errors
  }
}

다음과 같은 경우 네임스페이스 필터가 제거됩니다:

• 반환된 errors 객체가 비어 있습니다.
• API가 200 OK로 응답합니다.

Google Cloud Logging 대상#

히스토리

• GitLab 16.1에서 도입되었습니다.

최상위 그룹의 Google Cloud Logging 대상을 관리합니다.

Google Cloud Logging 스트리밍 감사 이벤트를 설정하기 전에 전제 조건을 충족해야 합니다.

새 Google Cloud Logging 대상 추가#

최상위 그룹에 새 Google Cloud Logging 구성 대상을 추가합니다.

전제 조건:

• 최상위 그룹에 대한 Owner 역할.
• 서비스 계정을 생성하고 Google Cloud Logging을 활성화할 수 있는 필요한 권한이 있는 Google Cloud 프로젝트.

스트리밍을 활성화하고 구성을 추가하려면 GraphQL API에서 googleCloudLoggingConfigurationCreate 뮤테이션을 사용합니다.

mutation {
  googleCloudLoggingConfigurationCreate(input: { groupPath: "my-group", googleProjectIdName: "my-google-project", clientEmail: "my-email@my-google-project.iam.gservice.account.com", privateKey: "YOUR_PRIVATE_KEY", logIdName: "audit-events", name: "destination-name" } ) {
    errors
    googleCloudLoggingConfiguration {
      id
      googleProjectIdName
      logIdName
      clientEmail
      name
    }
    errors
  }
}

다음과 같은 경우 이벤트 스트리밍이 활성화됩니다:

• 반환된 errors 객체가 비어 있습니다.
• API가 200 OK로 응답합니다.

Google Cloud Logging 구성 나열#

최상위 그룹의 모든 Google Cloud Logging 구성 대상을 나열합니다.

전제 조건:

• 최상위 그룹에 대한 Owner 역할.

googleCloudLoggingConfigurations 쿼리 유형을 사용하여 최상위 그룹의 스트리밍 구성 목록을 볼 수 있습니다.

query {
  group(fullPath: "my-group") {
    id
    googleCloudLoggingConfigurations {
      nodes {
        id
        logIdName
        googleProjectIdName
        clientEmail
        name
      }
    }
  }
}

결과 목록이 비어 있으면 해당 그룹에 대한 감사 스트리밍이 활성화되지 않은 것입니다.

업데이트 및 삭제 뮤테이션에는 이 쿼리에서 반환된 ID 값이 필요합니다.

Google Cloud Logging 구성 업데이트#

최상위 그룹의 Google Cloud Logging 구성 대상을 업데이트합니다.

전제 조건:

• 최상위 그룹에 대한 Owner 역할.

최상위 그룹의 스트리밍 구성을 업데이트하려면 googleCloudLoggingConfigurationUpdate 뮤테이션 유형을 사용합니다. 모든 외부 대상 나열에서 구성 ID를 조회할 수 있습니다.

mutation {
  googleCloudLoggingConfigurationUpdate(
    input: {id: "gid://gitlab/AuditEvents::GoogleCloudLoggingConfiguration/1", googleProjectIdName: "my-google-project", clientEmail: "my-email@my-google-project.iam.gservice.account.com", privateKey: "YOUR_PRIVATE_KEY", logIdName: "audit-events", name: "updated-destination-name" }
  ) {
    errors
    googleCloudLoggingConfiguration {
      id
      logIdName
      googleProjectIdName
      clientEmail
      name
    }
  }
}

다음과 같은 경우 스트리밍 구성이 업데이트됩니다:

• 반환된 errors 객체가 비어 있습니다.
• API가 200 OK로 응답합니다.

Google Cloud Logging 구성 삭제#

최상위 그룹의 스트리밍 대상을 삭제합니다.

마지막 대상이 성공적으로 삭제되면 그룹의 스트리밍이 비활성화됩니다.

전제 조건:

• 최상위 그룹에 대한 Owner 역할.

Owner 역할을 가진 사용자는 googleCloudLoggingConfigurationDestroy 뮤테이션 유형을 사용하여 스트리밍 구성을 삭제할 수 있습니다. 모든 스트리밍 대상 나열에서 구성 ID를 조회할 수 있습니다.

mutation {
  googleCloudLoggingConfigurationDestroy(input: { id: "gid://gitlab/AuditEvents::GoogleCloudLoggingConfiguration/1" }) {
    errors
  }
}

다음과 같은 경우 스트리밍 구성이 삭제됩니다:

• 반환된 errors 객체가 비어 있습니다.
• API가 200 OK로 응답합니다.