Send Jira and Confluence logs to LogPulse
The audit logs of Jira Cloud and Confluence Cloud: permission and group changes, project and space settings, user management and app installs.
Configure → Sources → Cloud. LogPulse reads the Atlassian Cloud audit APIs itself, without an agent. Events land in the audit index with source jira, confluence and fill the Change data model.Overview
- Atlassian Cloud audit APIs to Integration poller
- Integration poller to index=audit
LogPulse signs in to Jira and Confluence 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
- An Atlassian Cloud site
- An administrator account with an API token
- In LogPulse: a role that may manage API keys. Cloud integrations fall under that right.
1. Create a credential in Jira and Confluence
| Field in LogPulse | Where you find it |
|---|---|
| Site | The address of your Atlassian site, such as acme.atlassian.net. |
| Email address | The account that owns the API token. It needs administrator rights in Jira and Confluence to read the audit logs. |
| API token | Create it at id.atlassian.com, Security, API tokens. Stored encrypted and never shown again. |
2. Add the integration in LogPulse
Go to Configure → Sources → Cloud and choose Jira and Confluence. 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.
What arrives
| Data source | Index | Source | Sourcetype | What it holds |
|---|---|---|---|---|
| Jira audit log | audit | jira | Jira:audit log | Changes in Jira: who, what, on which project, user or scheme, and from which address. |
| Confluence audit log | audit | confluence | Confluence:audit log | Changes in Confluence: permissions, spaces, users and global settings. |
The index is the kind of data and the source is the product, so detection rules for that kind of data find Jira and Confluence without changes.
Fields and data models
| Data model | What you get |
|---|---|
| Change | Who changed what, on which object, from which address. |
Field names follow the CIM field names. These are the fields LogPulse sets on Jira and Confluence events; a field is left out when Jira and Confluence did not send a value.
actioncategorydescriptiondestidobjectobject_categoryobject_idprivilegedresultsignaturesrc_ipuseruser_name
The original record of Jira and Confluence is kept with each event under raw, so nothing the vendor sent is lost.
3. Check the data
The first events arrive within a few minutes. Check what came in:
earliest=-1h index IN (audit) source IN (jira, confluence)
| stats count by index, source, sourcetypeThe 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 see | What to do |
|---|---|
| Atlassian refused the email and API token. | Create a new API token at id.atlassian.com under Security, API tokens, for the account whose email address you fill in. |
| The account needs the Jira administrator permission to read the audit log. | Give the account administrator rights in Jira. The same goes for Confluence when that check fails. |
| This site has no Jira. Only Confluence is read. | Nothing to do: a site with only Jira or only Confluence works. |
| 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. Jira and Confluence may also simply have had nothing new. |
Frequently asked questions
- How do I send Jira and Confluence logs to LogPulse?
- Add the Jira and Confluence cloud integration under Configure, Sources, Cloud in LogPulse and fill in Site, Email address, API token. LogPulse reads the Atlassian Cloud audit APIs itself, every five minutes by default; there is nothing to install.
- Which permissions does LogPulse need in Jira and Confluence?
- An Atlassian Cloud site. An administrator account with an API token. Read access is enough for collecting logs.
- Which index does Jira and Confluence data go to?
- The index is the kind of data: audit. The source is the product: jira, confluence. Each data source has its own sourcetype, listed on this page.
- Which data models does Jira and Confluence fill?
- Change. Detection rules and dashboards written for a data model work on Jira and Confluence without changes.