Skip to main content

CollectorsCloud Collectors Administration Guide

Configure the GitHub Cloud Collector

Set up the GitHub Cloud Collector to continuously ingest GitHub enterprise audit logs that include events such as repository access, authentication attempts, permission changes, and more from the GitHub Enterprise Audit API endpoint to monitor your enterprise GitHub server or cloud-based GitHub service.

  1. Before you configure the GitHub Cloud Collector, ensure that you complete the prerequisites.

  2. Log in to the New-Scale Security Operations Platform with your registered credentials as an administrator.

  3. Navigate to Collectors > Cloud Collectors.

  4. Click New Collector.

  5. Click GitHub.

  6. Enter the following information for the cloud collector.

    GitHub_Configuration2.png

    • NAME – Specify a name for the Cloud Collector instance.

    • HOSTNAME – Enter the hostname of your GitHub Enterprise instance. For example, api.github.com.

      If you access GitHub at GHE.com, replace api.github.com with your enterprise's subdomain at api.SUBDOMAIN.ghe.com. For more information, see REST API endpoints for enterprise audit logs in the GitHub documentation.

    • ENTERPRISE NAME – Enter the name of the GitHub enterprise.

    • PERSONAL ACCESS TOKEN – Enter the personal access (classic) token that you obtained while completing the prerequisites.

    • Event Types – Click the event type for which you want the collector to fetch data: WEB, GIT, or ALL. If you select WEB, web events are collected, if you select GIT, Git events are collected, if you select ALL, both Web and Git events are collected.

    • Filters – Specify GitHub audit log filter conditions to include or exclude events. For example, operation:access, and repo:my-org/our-repo. You can add multiple filters by adding a space. The query filters to search based on time of action (time at which actions occurred) are not supported. For more information, see Searching the audit log in the GitHub documentation.

    • INGEST FROM – Select the time and date from which the collector must start ingesting events. If you leave this field blank and do not provide a threshold, all logs are ingested.

  7. (Optional) SITE – Select an existing site or to create a new site with a unique ID, click manage your sites. Adding a site name helps you to ensure efficient management of environments with overlapping IP addresses.

    By entering a site name, you associate the logs with a specific independent site. A sitename metadata field is automatically added to all the events that are going to be ingested via this collector. For more information about Site Management, see Define a Unique Site Name.

  8. (Optional) TIMEZONE – Select a time zone applicable to you for accurate detections and event monitoring.

    By entering a time zone, you override the default log time zone. A timezone metadata field is automatically added to all events ingested through this collector.

    Timezone_sitename_site_management_1.png

  9. Click Install.

    AWS_S3_2.png

    A confirmation message informs you that the new Cloud Collector is created.