이벤트 스트리밍 GraphQL API

Tier: Ultimate Offering: GitLab.com, Self-managed, GitLab Dedicated

GitLab 14.5에서 ff_external_audit_events_namespace라는 플래그로 소개된 API는 기본적으로 비활성화되어 있습니다.
GitLab 14.7에서 GitLab.com 및 기본적으로 Self-managed에서 활성화되었습니다.
GitLab 14.8에서 API 플래그 ff_external_audit_events_namespace가 제거되었습니다.
GitLab 15.1에서 streaming_audit_event_headers라는 플래그로 소개된 사용자 정의 HTTP 헤더 API는 기본적으로 비활성화되어 있습니다.
GitLab 15.2에서 사용자 정의 HTTP 헤더 API가 GitLab.com 및 Self-managed에서 활성화되었습니다.
GitLab 15.3에서 사용자 정의 HTTP 헤더 API가 일반적으로 사용 가능해졌으며, 플래그 streaming_audit_event_headers가 제거되었습니다.
GitLab 15.4에서 사용자 지정 검증 토큰 API 지원이 소개되었습니다.
GitLab 16.1에서 ff_external_audit_events라는 플래그로 소개된 인스턴스 레벨 스트리밍 대상을위한 사용자 지정 HTTP 헤더의 API가 기본적으로 비활성화되어 있습니다.
GitLab 16.2에서 플래그 ff_external_audit_events가 기본적으로 활성화되었습니다.
GitLab 16.2에서 사용자 지정 대상 이름 API 지원이 소개되었습니다.
GitLab 16.4에서 API 플래그 ff_external_audit_events가 제거되었습니다.

감사 이벤트 스트리밍 대상은 GraphQL API를 사용하여 유지 관리할 수 있습니다.

최상위 그룹 스트리밍 대상

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

HTTP 대상

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

새 스트리밍 대상 추가

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

경고: 스트리밍 대상은 민감한 정보를 포함할 수있는 모든 감사 이벤트 데이터를 수신합니다. 스트리밍 대상을 신뢰할 수 있는지 확인하십시오.

전제 조건:

최상위 그룹의 소유자 역할.

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

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

기본적으로 제공된 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
      }
    }
  }
}

기본적으로 제공된 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 객체가 비어 있는 경우 헤더가 작성됩니다.

스트리밍 대상 목록

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

전제 조건:

최상위 그룹의 소유자 역할.

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
          }
        }
      }
    }
  }
}

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

스트리밍 대상 업데이트

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

전제 조건:

최상위 그룹의 소유자 역할.

그룹의 스트리밍 대상을 업데이트하려면 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로 응답해야 합니다.

그룹의 소유자 역할을 하는 사용자는 auditEventsStreamingHeadersUpdate 뮤테이션 유형을 사용하여 스트리밍 대상의 사용자 지정 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
    }
  }
}

그룹 소유자는 GraphQL auditEventsStreamingHeadersDestroy 뮤테이션을 사용하여 HTTP 헤더를 제거할 수 있습니다. 헤더 ID를 검색할 수 있습니다. 스트리밍 대상 나열을 통해.

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

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

스트리밍 대상 삭제

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

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

전제 조건:

최상위 그룹의 소유자 역할.

그룹의 소유자 역할을 하는 사용자는 externalAuditEventDestinationDestroy 뮤테이션 유형을 사용하여 스트리밍 대상을 삭제할 수 있습니다. 대상 ID를 검색할 수 있습니다. 스트리밍 대상 나열을 통해.

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

스트리밍 대상이 삭제되었을 때:

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

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

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

이벤트 유형 필터

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

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

이벤트 유형 필터가 설정된 스트리밍 대상은 filtered () 라벨이 표시됩니다.

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

전제 조건:

그룹에 대한 소유자 역할이 있어야 합니다.

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

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

이벤트 유형 필터가 추가되면:

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

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

사전 요구 사항:

그룹의 소유자 역할이 있어야 합니다.

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

mutation {
    auditEventsStreamingDestinationEventsRemove(input: {
    destinationId: "gid://gitlab/AuditEvents::ExternalAuditEventDestination/1",
    eventTypeFilters: ["이벤트 유형 필터 목록"]
  }){
    errors
  }
}

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

반환된 errors 객체가 비어 있는 경우.
API가 200 OK를 응답하는 경우.

네임스페이스 필터

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

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

네임스페이스 필터가 설정된 스트리밍 대상에는 filtered () 라벨이 지정됩니다.

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

사전 요구 사항:

그룹의 소유자 역할이 있어야 합니다.

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

네임스페이스 필터가 추가된 경우:

API가 비어 있는 errors 객체를 반환하는 경우.
API가 200 OK를 응답하는 경우.

하위 그룹용 뮤테이션

mutation auditEventsStreamingHttpNamespaceFiltersAdd {
  auditEventsStreamingHttpNamespaceFiltersAdd(input: {
    destinationId: "gid://gitlab/AuditEvents::ExternalAuditEventDestination/1",
    groupPath: "하위 그룹 경로"
  }) {
    errors
    namespaceFilter {
      id
      namespace {
        id
        name
        fullName
      }
    }
  }
}

프로젝트용 뮤테이션

mutation auditEventsStreamingHttpNamespaceFiltersAdd {
  auditEventsStreamingHttpNamespaceFiltersAdd(input: {
    destinationId: "gid://gitlab/AuditEvents::ExternalAuditEventDestination/1",
    projectPath: "프로젝트 경로"
  }) {
    errors
    namespaceFilter {
      id
      namespace {
        id
        name
        fullName
      }
    }
  }
}

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

사전 요구 사항:

그룹의 소유자 역할이 있어야 합니다.

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

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

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

반환된 errors 객체가 비어 있는 경우.
API가 200 OK를 응답하는 경우.

구글 클라우드 로깅 대상

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

최상위 그룹을 위한 구글 클라우드 로깅 대상을 관리합니다.

구글 클라우드 로깅 스트리밍 감사 이벤트를 설정하기 전에 사전 요구 사항을 충족해야 합니다.

새 구글 클라우드 로깅 대상 추가

최상위 그룹에 새 구글 클라우드 로깅 구성 대상을 추가합니다.

사전 요구 사항:

최상위 그룹의 소유자 역할.
구글 클라우드 프로젝트에서 서비스 계정을 생성하고 구글 클라우드 로깅을 활성화하는 데 필요한 권한이 있는 구글 클라우드 프로젝트.

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

mutation {
  googleCloudLoggingConfigurationCreate(input: { groupPath: "내 그룹", googleProjectIdName: "내 구글 프로젝트", clientEmail: "내 이메일@내 구글 프로젝트.iam.gservice.account.com", privateKey: "비공개 키", logIdName: "감사-이벤트", name: "대상 이름" } ) {
    errors
    googleCloudLoggingConfiguration {
      id
      googleProjectIdName
      logIdName
      clientEmail
      name
    }
    errors
  }
}

이벤트 스트리밍이 활성화되는 경우:

반환된 errors 객체가 비어 있는 경우.
API가 200 OK를 응답하는 경우.

구글 클라우드 로깅 구성 목록

최상위 그룹에 대한 모든 구글 클라우드 로깅 구성 대상을 나열합니다.

사전 요구 사항:

최상위 그룹의 소유자 역할.

최상위 그룹에 대한 스트리밍 구성 목록을 보려면 googleCloudLoggingConfigurations 쿼리 유형을 사용할 수 있습니다.

query {
  group(fullPath: "내 그룹") {
    id
    googleCloudLoggingConfigurations {
      nodes {
        id
        logIdName
        googleProjectIdName
        clientEmail
        name
      }
    }
  }
}

결과 목록이 비어 있는 경우 그룹에 대한 감사 스트리밍이 활성화되지 않았습니다.

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

구글 클라우드 로깅 구성 업데이트

최상위 그룹을 위한 구글 클라우드 로깅 구성 대상을 업데이트합니다.

사전 요구 사항:

최상위 그룹의 소유자 역할.

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

mutation {
  googleCloudLoggingConfigurationUpdate(
    input: {id: "gid://gitlab/AuditEvents::GoogleCloudLoggingConfiguration/1", googleProjectIdName: "내 구글 프로젝트", clientEmail: "내 이메일@내 구글 프로젝트.iam.gservice.account.com", privateKey: "비공개 키", logIdName: "감사-이벤트", name: "업데이트된 대상 이름" }
  ) {
    errors
    googleCloudLoggingConfiguration {
      id
      logIdName
      googleProjectIdName
      clientEmail
      name
    }
  }
}

스트리밍 구성이 업데이트된 경우:

반환된 errors 객체가 비어 있는 경우.
API가 200 OK를 응답하는 경우.

Google Cloud Logging 구성 삭제

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

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

전제 조건:

최상위 그룹에 대한 소유자 역할.

그룹의 소유자 역할을 하는 사용자는 googleCloudLoggingConfigurationDestroy 뮤테이션 유형을 사용하여 스트리밍 구성을 삭제할 수 있습니다. 그룹에 대한 모든 스트리밍 대상을 나열함으로써 구성 ID를 검색할 수 있습니다.

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

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

반환된 errors 객체가 비어 있는 경우.
API가 200 OK로 응답한 경우.

인스턴스 스트리밍 대상

Tier: Ultimate Offering: Self-managed

GitLab 16.0에 도입됨 (기본값 비활성화를 위한 ff_external_audit_events 플래그와 함께).
Feature flag ff_external_audit_events는 GitLab 16.2에서 기본값으로 활성화됨.
인스턴스 스트리밍 대상은 GitLab 16.4에서 일반적으로 사용 가능해짐. Feature flag ff_external_audit_events가 제거됨.

전체 인스턴스의 스트리밍 대상을 관리합니다.

HTTP 대상

전체 인스턴스의 HTTP 스트리밍 대상을 관리합니다.

새 HTTP 대상 추가

인스턴스에 새 HTTP 스트리밍 대상을 추가합니다.

전제 조건:

인스턴스에서의 관리자 액세스 권한.

스트리밍을 활성화하고 대상을 추가하려면 GraphQL API에서 instanceExternalAuditEventDestinationCreate 뮤테이션을 사용하세요.

mutation {
  instanceExternalAuditEventDestinationCreate(input: { destinationUrl: "https://mydomain.io/endpoint/ingest"}) {
    errors
    instanceExternalAuditEventDestination {
      destinationUrl
      id
      name
      verificationToken
    }
  }
}

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

반환된 errors 객체가 비어 있는 경우.
API가 200 OK로 응답한 경우.

기본 GitLab에서 생성된 대신 고유한 대상 이름을 지정할 수 있습니다. GraphQL instanceExternalAuditEventDestinationCreate 뮤테이션을 사용하여 자체 대상 이름을 지정할 수 있습니다. 이름 길이는 72자를 초과하면 안 되며, 끝에 공백이 있으면 안 됩니다. 이 값은 고유해야 합니다. 예:

mutation {
  instanceExternalAuditEventDestinationCreate(input: { destinationUrl: "https://mydomain.io/endpoint/ingest", name: "destination-name-here"}) {
    errors
    instanceExternalAuditEventDestination {
      destinationUrl
      id
      name
      verificationToken
    }
  }
}

인스턴스 관리자는 GraphQL auditEventsStreamingInstanceHeadersCreate 뮤테이션을 사용하여 HTTP 헤더를 추가할 수 있습니다. 인스턴스의 모든 스트리밍 대상을 나열함으로써 대상 ID를 검색할 수 있습니다. 또는 위의 뮤테이션을 통해 대상 ID를 검색할 수 있습니다.

mutation {
  auditEventsStreamingInstanceHeadersCreate(input:
    {
      destinationId: "gid://gitlab/AuditEvents::InstanceExternalAuditEventDestination/42",
      key: "foo",
      value: "bar",
      active: true
    }) {
    errors
    header {
      id
      key
      value
      active
    }
  }
}

반환된 errors 객체가 비어 있는 경우, 헤더가 생성됩니다.

스트리밍 대상 나열

인스턴스의 모든 HTTP 스트리밍 대상을 나열합니다.

전제 조건:

인스턴스에서의 관리자 액세스 권한.

인스턴스의 스트리밍 대상 목록을 보려면 instanceExternalAuditEventDestinations 쿼리 유형을 사용하세요.

query {
  instanceExternalAuditEventDestinations {
    nodes {
      id
      name
      destinationUrl
      verificationToken
      headers {
        nodes {
          id
          key
          value
          active
        }
      }
      eventTypeFilters
    }
  }
}

결과 목록이 비어 있는 경우, 인스턴스에서 감사 스트리밍이 활성화되지 않습니다.

이 쿼리에서 반환된 ID 값을 업데이트 및 삭제 뮤테이션에 사용해야 합니다.

스트리밍 대상 업데이트

인스턴스의 HTTP 스트리밍 대상을 업데이트합니다.

전제 조건:

인스턴스에서의 관리자 액세스 권한.

인스턴스의 스트리밍 대상을 업데이트하려면 instanceExternalAuditEventDestinationUpdate 뮤테이션 유형을 사용하세요. 인스턴스의 모든 외부 대상을 나열함으로써 대상 ID를 검색할 수 있습니다.

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

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

반환된 errors 객체가 비어 있는 경우.
API가 200 OK로 응답한 경우.

인스턴스 관리자는 auditEventsStreamingInstanceHeadersUpdate 뮤테이션 유형을 사용하여 사용자 정의 HTTP 헤더를 업데이트할 수 있습니다. 인스턴스의 모든 사용자 정의 HTTP 헤더를 나열함으로써 사용자 정의 HTTP 헤더 ID를 검색할 수 있습니다.

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

반환된 errors 객체가 비어 있는 경우, 헤더가 업데이트됩니다.

스트리밍 대상 삭제

전체 인스턴스에 대한 스트리밍 대상을 삭제합니다.

마지막 대상이 성공적으로 삭제되면 해당 인스턴스의 스트리밍은 비활성화됩니다.

전제 조건:

인스턴스에서 관리자 액세스 권한을 가짐.

스트리밍 대상을 삭제하려면 instanceExternalAuditEventDestinationDestroy 뮤테이션 유형을 사용합니다. 대상 ID는 인스턴스의 모든 스트리밍 대상을 나열하여 검색할 수 있습니다.

mutation {
  instanceExternalAuditEventDestinationDestroy(input: { id: "gid://gitlab/AuditEvents::InstanceExternalAuditEventDestination/1" }) {
    errors
  }
}

스트리밍 대상은 다음 조건을 충족할 때 삭제됩니다:

반환된 errors 객체가 비어 있는 경우.
API가 200 OK로 응답하는 경우.

HTTP 헤더를 제거하려면 GraphQL auditEventsStreamingInstanceHeadersDestroy 뮤테이션을 사용합니다. 헤더 ID는 인스턴스에 대한 모든 사용자 지정 HTTP 헤더를 나열하여 검색할 수 있습니다.

mutation {
  auditEventsStreamingInstanceHeadersDestroy(input: { headerId: "gid://gitlab/AuditEvents::Streaming::InstanceHeader/<id>" }) {
    errors
  }
}

반환된 errors 객체가 비어 있는 경우에 헤더가 삭제됩니다.

이벤트 유형 필터

이벤트 유형 필터 API는 GitLab 16.2에서 소개되었습니다.

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

이벤트 유형 필터가 설정된 스트리밍 대상에는 filtered () 라벨이 표시됩니다.

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

전제 조건:

인스턴스에 대한 관리자 액세스가 있어야 합니다.

auditEventsStreamingDestinationInstanceEventsAdd 뮤테이션을 사용하여 이벤트 유형 필터의 목록을 추가할 수 있습니다:

mutation {
    auditEventsStreamingDestinationInstanceEventsAdd(input: {
        destinationId: "gid://gitlab/AuditEvents::InstanceExternalAuditEventDestination/1",
        eventTypeFilters: ["이벤트 유형 필터 목록"]}){
        errors
        eventTypeFilters
    }
}

이벤트 유형 필터가 추가되는 경우:

반환된 errors 객체가 비어 있는 경우.
API가 200 OK로 응답하는 경우.

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

전제 조건:

인스턴스에 대한 관리자 액세스가 있어야 합니다.

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

mutation {
    auditEventsStreamingDestinationInstanceEventsRemove(input: {
    destinationId: "gid://gitlab/AuditEvents::InstanceExternalAuditEventDestination/1",
    eventTypeFilters: ["이벤트 유형 필터 목록"]
  }){
    errors
  }
}

이벤트 유형 필터가 제거되는 경우:

반환된 errors 객체가 비어 있는 경우.
API가 200 OK로 응답하는 경우.

Google Cloud Logging 대상

GitLab 16.5에서 소개되었습니다.

전체 인스턴스에 대한 Google Cloud Logging 대상을 관리합니다.

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

새 Google Cloud Logging 대상 추가

인스턴스에 새 Google Cloud Logging 구성 대상을 추가합니다.

전제 조건:

인스턴스에 대한 관리자 액세스 권한을 가짐.
Google Cloud 프로젝트에 서비스 계정을 생성하고 Google Cloud Logging을 활성화할 필요한 권한이 있어야 합니다.

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

mutation {
  instanceGoogleCloudLoggingConfigurationCreate(input: { googleProjectIdName: "my-google-project", clientEmail: "my-email@my-google-project.iam.gservice.account.com", privateKey: "YOUR_PRIVATE_KEY", logIdName: "audit-events", name: "대상명" } ) {
    errors
    googleCloudLoggingConfiguration {
      id
      googleProjectIdName
      logIdName
      clientEmail
      name
    }
    errors
  }
}

이벤트 스트리밍이 활성화되는 경우:

반환된 errors 객체가 비어 있는 경우.
API가 200 OK로 응답하는 경우.

Google Cloud Logging 구성 목록

인스턴스에 대한 모든 Google Cloud Logging 구성 대상을 나열합니다.

전제 조건:

인스턴스에 대한 관리자 액세스 권한을 가짐.

instanceGoogleCloudLoggingConfigurations 쿼리 유형을 사용하여 인스턴스에 대한 스트리밍 구성 목록을 볼 수 있습니다.

query {
  instanceGoogleCloudLoggingConfigurations {
    nodes {
      id
      logIdName
      googleProjectIdName
      clientEmail
      name
    }
  }
}

결과 목록이 비어 있는 경우 인스턴스에 대한 감사 스트리밍이 활성화되지 않습니다.

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

Google Cloud Logging 구성 업데이트

인스턴스에 대한 Google Cloud Logging 구성 대상을 업데이트합니다.

전제 조건:

인스턴스에 대한 관리자 액세스 권한을 가짐.

인스턴스의 스트리밍 구성을 업데이트하려면 instanceGoogleCloudLoggingConfigurationUpdate 뮤테이션 유형을 사용합니다. 구성 ID는 모든 외부 대상을 나열하여 검색할 수 있습니다.

mutation {
  instanceGoogleCloudLoggingConfigurationUpdate(
    input: {id: "gid://gitlab/AuditEvents::Instance::GoogleCloudLoggingConfiguration/1", googleProjectIdName: "updated-google-id", clientEmail: "updated@my-google-project.iam.gservice.account.com", privateKey: "YOUR_PRIVATE_KEY", logIdName: "audit-events", name: "업데이트된 이름"}
  ) {
    errors
    instanceGoogleCloudLoggingConfiguration {
      id
      logIdName
      googleProjectIdName
      clientEmail
      name
    }
  }
}

스트리밍 구성이 업데이트되는 경우:

반환된 errors 객체가 비어 있는 경우.
API가 200 OK로 응답하는 경우.

Google Cloud 로깅 구성 삭제

인스턴스의 스트리밍 대상을 삭제합니다.

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

필수 사항:

해당 인스턴스에 대한 관리자 액세스 권한이 있어야 합니다.

스트리밍 구성을 삭제하려면 instanceGoogleCloudLoggingConfigurationDestroy 뮤테이션 유형을 사용하세요. 구성 ID는 해당 인스턴스의 모든 스트리밍 대상을 나열하여 검색할 수 있습니다.

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

다음 사항이 적용되면 스트리밍 구성이 삭제됩니다:

반환된 errors 객체가 비어 있는 경우
API가 200 OK로 응답하는 경우

이벤트 스트리밍 GraphQL API

최상위 그룹 스트리밍 대상

HTTP 대상

새 스트리밍 대상 추가

스트리밍 대상 목록

스트리밍 대상 업데이트

스트리밍 대상 삭제

이벤트 유형 필터

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

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

네임스페이스 필터

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

하위 그룹용 뮤테이션

프로젝트용 뮤테이션

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

구글 클라우드 로깅 대상

새 구글 클라우드 로깅 대상 추가

구글 클라우드 로깅 구성 목록

구글 클라우드 로깅 구성 업데이트

Google Cloud Logging 구성 삭제

인스턴스 스트리밍 대상

HTTP 대상

새 HTTP 대상 추가

스트리밍 대상 나열

스트리밍 대상 업데이트

스트리밍 대상 삭제

이벤트 유형 필터

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

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

Google Cloud Logging 대상

새 Google Cloud Logging 대상 추가

Google Cloud Logging 구성 목록

Google Cloud Logging 구성 업데이트

Google Cloud 로깅 구성 삭제

도움말

기능 사용 가능성과 제품 평가판

도움받기