Send GitHub logs to LogPulse

GitHub Actions workflow runs and jobs, the organization audit log, and code scanning, Dependabot and secret scanning alerts.

In short
To send GitHub logs to LogPulse, add GitHub under Configure → Sources → Cloud. LogPulse reads the GitHub REST API and webhooks itself, without an agent. Events land in the cicd, audit, vulnerabilities indexes with source github_actions, github and fill the CI/CD Pipeline, Security Event data models.

Overview

How GitHub data reaches LogPulse
Vendor
GitHub REST API and webhooks
Collect
Integration pollerreads new events, maps the fields
Store
index=cicd
index=audit
index=vulnerabilities
  1. GitHub REST API and webhooks to Integration poller
  2. Integration poller to index=cicd
  3. Integration poller to index=audit
  4. Integration poller to index=vulnerabilities

LogPulse signs in to GitHub with the credential you give it and fetches new events every five minutes by default. You can set the interval per integration, from one minute to 24 hours.

What you need

  • GitHub Personal Access Token (classic or fine-grained)
  • Required scopes: repo, actions:read
  • Organization or user-level access
  • In LogPulse: a role that may manage API keys. Cloud integrations fall under that right.

1. Create a credential in GitHub

Field in LogPulseWhere you find it
GitHub Owner (org or user)The organization or user that owns the repositories, such as my-organization.
GitHub TokenA personal access token, classic (ghp_…) or fine-grained (github_pat_…). Scopes repo and actions:read; for the audit log and security alerts also read:audit_log and security_events, or the matching read permissions on a fine-grained token. Stored encrypted and never shown again.
Specific repository (optional)Leave empty to monitor all repositories.

2. Add the integration in LogPulse

Go to Configure → Sources → Cloud and choose GitHub. Fill in the fields, tick the data sources you want and save. LogPulse first tests the connection with your credential and tells you what is wrong when it fails.

Repository Events is not polled but sent to LogPulse by GitHub. After you save, LogPulse shows the address and the key to set on the GitHub side.

Tip: Secrets are stored encrypted and never shown again. To change one, paste a new value; the rest stays.

What arrives

Data sourceIndexSourceSourcetypeWhat it holds
Workflow Runscicdgithub_actionscicd_pipelineCI/CD workflow and job execution events: status, duration, trigger, and actor.
Workflow Jobscicdgithub_actionscicd_pipelineIndividual job and step results within workflow runs, including runner info.
Repository Events (off by default)auditgithubgithub:eventPush, PR, release, and deployment events via GitHub webhooks.
Audit logauditgithubgithub:cloud:auditWho changed what in the organization: members, teams, repository access, branch protection, tokens, apps and webhooks. Needs GitHub Enterprise Cloud and a token with read:audit_log (or Administration: read).
Code scanning alertsvulnerabilitiesgithubgithub:cloud:code:scanning:alertsCodeQL and other code scanning findings per repository, with rule, severity, file and state. Needs a token with security_events (or Code scanning alerts: read).
Dependabot alertsvulnerabilitiesgithubgithub:cloud:dependabot:scanning:alertsVulnerable dependencies with package, CVE, GHSA, CVSS and the fixed version. Needs a token with security_events (or Dependabot alerts: read).
Secret scanning alertsvulnerabilitiesgithubgithub:cloud:secret:scanning:alertsLeaked secrets with type, validity and push protection bypasses. The secret itself is never fetched. Needs a token with security_events (or Secret scanning alerts: read).

The index is the kind of data and the source is the product, so detection rules for that kind of data find GitHub without changes.

Note: The audit log needs GitHub Enterprise Cloud.
Note: Secret scanning alerts never include the secret itself.
Note: Repository events come in through a webhook: after you save, LogPulse shows the webhook secret once, to set in your repository or organization settings.

Fields and data models

Data modelWhat you get
CI/CD PipelineWorkflow runs and jobs with status, trigger, repository, branch, actor, duration and runner info.
Security EventSecurity advisories, code scanning alerts, Dependabot alerts and secret scanning events from repository webhooks.

Events are mapped to the data models above, with the same field names as other sources of the same kind. See field names.

3. Check the data

The first events arrive within a few minutes. Check what came in:

earliest=-1h index IN (cicd, audit, vulnerabilities) source IN (github_actions, github)
| stats count by index, source, sourcetype

The integration page in LogPulse shows when it last read events and the last error, if any.

Troubleshooting

The connection test names what is wrong. These are the answers you are most likely to see.

What you seeWhat to do
Token is invalid or expired.Generate a new token at GitHub, Settings, Developer settings, Personal access tokens.
Token is missing required scopes. Required: "repo" and "actions:read".For a classic token add repo; for a fine-grained token give the Actions: Read repository permission.
Access denied to organization.For a fine-grained token: create it with the organization as Resource Owner. For a classic token: enable read:org and authorize the token for the organization.
The test passes but no events arrive.Run the search above over a longer time. No results: check on the integration page that the data source is switched on and when it last read events. GitHub may also simply have had nothing new.

Frequently asked questions

How do I send GitHub logs to LogPulse?
Add the GitHub cloud integration under Configure, Sources, Cloud in LogPulse and fill in GitHub Owner (org or user), GitHub Token. LogPulse reads the GitHub REST API and webhooks itself, every five minutes by default; there is nothing to install.
Which permissions does LogPulse need in GitHub?
GitHub Personal Access Token (classic or fine-grained). Required scopes: repo, actions:read. Organization or user-level access. Read access is enough for collecting logs.
Which index does GitHub data go to?
The index is the kind of data: cicd, audit, vulnerabilities. The source is the product: github_actions, github. Each data source has its own sourcetype, listed on this page.
Which data models does GitHub fill?
CI/CD Pipeline, Security Event. Detection rules and dashboards written for a data model work on GitHub without changes.
Why is Repository Events off by default?
To keep your daily ingest down until you need it: Repository Events is high volume or of use to fewer teams. Tick the data source in the integration to switch it on.