Skip to content

[Atlassian Confluence] Adding new pagination conditions #8406

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
P1llus merged 5 commits into from
Nov 6, 2023
Merged

[Atlassian Confluence] Adding new pagination conditions #8406

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6210ebe
Add pagination condition for atlassian confluence
P1llus Nov 6, 2023
0e29397
changelog
P1llus Nov 6, 2023
3b069d4
add new system test to return 0 results, and ensure its being hit
P1llus Nov 6, 2023
ba67d69
update test results
P1llus Nov 6, 2023
ebe86d6
elastic-package format to update docs again
P1llus Nov 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions packages/atlassian_confluence/_dev/deploy/docker/files/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,19 @@ rules:
body: |-
{"entities":[{"timestamp":"2021-11-23T00:44:58.940Z","author":{"name":"test user","type":"user","id":"2c9680837d4a3682017d4a375a280000","uri":"http://confluence.internal:8090/admin/users/viewuser.action?username=admin","avatarUri":""},"type":{"categoryI18nKey":"atlassian.audit.event.category.audit","category":"Auditing","actionI18nKey":"atlassian.audit.event.action.audit.search","action":"Audit Log search performed"},"affectedObjects":[],"changedValues":[],"source":"81.2.69.143","system":"http://confluence.internal:8090","method":"Browser","extraAttributes":[{"nameI18nKey":"atlassian.audit.event.attribute.id","name":"ID Range","value":"1 - 179"},{"nameI18nKey":"atlassian.audit.event.attribute.query","name":"Query","value":""},{"nameI18nKey":"atlassian.audit.event.attribute.results","name":"Results returned","value":"179"},{"nameI18nKey":"atlassian.audit.event.attribute.timestamp","name":"Timestamp Range","value":"2021-11-23T00:34:44.466Z - 2021-11-23T00:44:36.398Z"}]},{"timestamp":"2021-11-23T00:44:36.398Z","author":{"name":"test user","type":"user","id":"2c9680837d4a3682017d4a375a280000","uri":"http://confluence.internal:8090/admin/users/viewuser.action?username=admin","avatarUri":""},"type":{"categoryI18nKey":"atlassian.audit.event.category.audit","category":"Auditing","actionI18nKey":"atlassian.audit.event.action.audit.search","action":"Audit Log search performed"},"affectedObjects":[],"changedValues":[],"source":"81.2.69.143","system":"http://confluence.internal:8090","method":"Browser","extraAttributes":[{"nameI18nKey":"atlassian.audit.event.attribute.id","name":"ID Range","value":"79 - 178"},{"nameI18nKey":"atlassian.audit.event.attribute.query","name":"Query","value":""},{"nameI18nKey":"atlassian.audit.event.attribute.results","name":"Results returned","value":"100"},{"nameI18nKey":"atlassian.audit.event.attribute.timestamp","name":"Timestamp Range","value":"2021-11-23T00:39:37.166Z - 2021-11-23T00:43:12.188Z"}]}],"pagingInfo":{"lastPage":false,"nextPageOffset":0,"nextPageCursor":"1637628276398,179","nextPageLink":"http://{{ hostname }}:{{ env "PORT" }}/rest/auditing/1.0/events?offset=0&limit=2&pageCursor=1637628276398,179","size":2}}
# Confluence Cloud
- path: /wiki/rest/api/audit
methods: ["GET"]
request_headers:
authorization: Basic dGVzdC51c2VyOmFiYzEyMw==
query_params:
startDate: "{startDate:[0-9]+}"
endDate: "{endDate:[0-9]+}"
start: "4"
limit: "2"
responses:
- status_code: 200
body: |-
{"results":[],"start":2,"limit":2,"size":37,"_links":{"base":"https://test.atlassian.net/wiki","context":"/wiki","self":"https://test.atlassian.net/wiki/rest/api/audit"}}
- path: /wiki/rest/api/audit
methods: ["GET"]
request_headers:
Expand Down
5 changes: 5 additions & 0 deletions packages/atlassian_confluence/changelog.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# newer versions go on top
- version: "1.21.1"
changes:
- description: Resolve possible infinite pagination for Confluence Cloud.
type: bugfix
link: https://github.com/elastic/integrations/pull/8406
- version: "1.21.0"
changes:
- description: Improve 'event.original' check to avoid errors if set.
Expand Down
3 changes: 2 additions & 1 deletion packages/atlassian_confluence/data_stream/audit/agent/stream/httpjson.yml.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,8 @@ response.pagination:
value: '[[.last_response.url.params.Get "startDate"]]'
- set:
target: url.params.start
value: '[[add (toInt .last_response.body.start) (toInt .last_response.body.limit)]]'
value: '[[if (ne (len .last_response.body.results) 0)]][[add (toInt .last_response.body.start) (toInt .last_response.body.limit)]][[end]]'
fail_on_template_error: true
- set:
target: url.params.limit
value: '{{limit}}'
Expand Down
92 changes: 17 additions & 75 deletions packages/atlassian_confluence/data_stream/audit/sample_event.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,43 +1,18 @@
{
"@timestamp": "2021-11-22T23:44:13.873Z",
"@timestamp": "2021-11-16T09:25:56.666Z",
"agent": {
"ephemeral_id": "3bcd4f83-81b7-45d2-b083-b19a7da7ad6f",
"id": "cdda426a-7e47-48c4-b2f5-b9f1ad5bf08a",
"ephemeral_id": "5e7e2606-c5b7-4cca-bcf6-5a9959484395",
"id": "1f67a92c-38d3-40a8-9093-c4495a7411a3",
"name": "docker-fleet-agent",
"type": "filebeat",
"version": "8.8.0"
"version": "8.10.2"
},
"confluence": {
"audit": {
"extra_attributes": [
{
"name": "Query",
"nameI18nKey": "atlassian.audit.event.attribute.query"
},
{
"name": "Results returned",
"nameI18nKey": "atlassian.audit.event.attribute.results",
"value": "57"
},
{
"name": "ID Range",
"nameI18nKey": "atlassian.audit.event.attribute.id",
"value": "1 - 57"
},
{
"name": "Timestamp Range",
"nameI18nKey": "atlassian.audit.event.attribute.timestamp",
"value": "2021-11-22T23:42:45.791Z - 2021-11-22T23:43:22.615Z"
}
],
"method": "Browser",
"external_collaborator": false,
"type": {
"action": "Audit Log search performed",
"actionI18nKey": "atlassian.audit.event.action.audit.search",
"area": "AUDIT_LOG",
"category": "Auditing",
"categoryI18nKey": "atlassian.audit.event.category.audit",
"level": "BASE"
"action": "User deactivated",
"category": "Users and groups"
}
}
},
Expand All @@ -50,63 +25,30 @@
"version": "8.10.0"
},
"elastic_agent": {
"id": "cdda426a-7e47-48c4-b2f5-b9f1ad5bf08a",
"snapshot": true,
"version": "8.8.0"
"id": "1f67a92c-38d3-40a8-9093-c4495a7411a3",
"snapshot": false,
"version": "8.10.2"
},
"event": {
"action": "atlassian.audit.event.action.audit.search",
"action": "User deactivated",
"agent_id_status": "verified",
"created": "2023-11-06T13:17:04.339Z",
"dataset": "atlassian_confluence.audit",
"ingested": "2023-05-09T21:17:32Z",
"ingested": "2023-11-06T13:17:05Z",
"kind": "event",
"original": "{\"affectedObjects\":[],\"auditType\":{\"action\":\"Audit Log search performed\",\"actionI18nKey\":\"atlassian.audit.event.action.audit.search\",\"area\":\"AUDIT_LOG\",\"category\":\"Auditing\",\"categoryI18nKey\":\"atlassian.audit.event.category.audit\",\"level\":\"BASE\"},\"author\":{\"id\":\"2c9580827d4a06e8017d4a07c3e10000\",\"name\":\"test.user\",\"type\":\"user\"},\"changedValues\":[],\"extraAttributes\":[{\"name\":\"Query\",\"nameI18nKey\":\"atlassian.audit.event.attribute.query\",\"value\":\"\"},{\"name\":\"Results returned\",\"nameI18nKey\":\"atlassian.audit.event.attribute.results\",\"value\":\"57\"},{\"name\":\"ID Range\",\"nameI18nKey\":\"atlassian.audit.event.attribute.id\",\"value\":\"1 - 57\"},{\"name\":\"Timestamp Range\",\"nameI18nKey\":\"atlassian.audit.event.attribute.timestamp\",\"value\":\"2021-11-22T23:42:45.791Z - 2021-11-22T23:43:22.615Z\"}],\"method\":\"Browser\",\"source\":\"81.2.69.143\",\"system\":\"http://confluence.internal:8090\",\"timestamp\":{\"epochSecond\":1637624653,\"nano\":873000000},\"version\":\"1.0\"}",
"original": "{\"affectedObject\":{\"name\":\"\",\"objectType\":\"\"},\"associatedObjects\":[],\"author\":{\"accountType\":\"\",\"displayName\":\"System\",\"externalCollaborator\":false,\"isExternalCollaborator\":false,\"operations\":null,\"publicName\":\"Unknown user\",\"type\":\"user\"},\"category\":\"Users and groups\",\"changedValues\":[],\"creationDate\":1637054756666,\"description\":\"\",\"remoteAddress\":\"81.2.69.143\",\"summary\":\"User deactivated\",\"superAdmin\":false,\"sysAdmin\":false}",
"type": [
"info"
]
},
"host": {
"architecture": "x86_64",
"containerized": true,
"hostname": "docker-fleet-agent",
"id": "cff3d165179d4aef9596ddbb263e3adb",
"ip": [
"172.23.0.7"
],
"mac": [
"02-42-AC-17-00-07"
],
"name": "docker-fleet-agent",
"os": {
"codename": "focal",
"family": "debian",
"kernel": "5.10.47-linuxkit",
"name": "Ubuntu",
"platform": "ubuntu",
"type": "linux",
"version": "20.04.5 LTS (Focal Fossa)"
}
},
"input": {
"type": "log"
},
"log": {
"file": {
"path": "/tmp/service_logs/test-audit.log"
},
"offset": 0
"type": "httpjson"
},
"related": {
"hosts": [
"confluence.internal"
],
"ip": [
"81.2.69.143"
]
},
"service": {
"address": "http://confluence.internal:8090"
},
"source": {
"address": "81.2.69.143",
"geo": {
Expand All @@ -125,10 +67,10 @@
},
"tags": [
"preserve_original_event",
"forwarded",
"confluence-audit"
],
"user": {
"full_name": "test.user",
"id": "2c9580827d4a06e8017d4a07c3e10000"
"full_name": "System"
}
}
92 changes: 17 additions & 75 deletions packages/atlassian_confluence/docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,45 +122,20 @@ An example event for `audit` looks as following:

```json
{
"@timestamp": "2021-11-22T23:44:13.873Z",
"@timestamp": "2021-11-16T09:25:56.666Z",
"agent": {
"ephemeral_id": "3bcd4f83-81b7-45d2-b083-b19a7da7ad6f",
"id": "cdda426a-7e47-48c4-b2f5-b9f1ad5bf08a",
"ephemeral_id": "5e7e2606-c5b7-4cca-bcf6-5a9959484395",
"id": "1f67a92c-38d3-40a8-9093-c4495a7411a3",
"name": "docker-fleet-agent",
"type": "filebeat",
"version": "8.8.0"
"version": "8.10.2"
},
"confluence": {
"audit": {
"extra_attributes": [
{
"name": "Query",
"nameI18nKey": "atlassian.audit.event.attribute.query"
},
{
"name": "Results returned",
"nameI18nKey": "atlassian.audit.event.attribute.results",
"value": "57"
},
{
"name": "ID Range",
"nameI18nKey": "atlassian.audit.event.attribute.id",
"value": "1 - 57"
},
{
"name": "Timestamp Range",
"nameI18nKey": "atlassian.audit.event.attribute.timestamp",
"value": "2021-11-22T23:42:45.791Z - 2021-11-22T23:43:22.615Z"
}
],
"method": "Browser",
"external_collaborator": false,
"type": {
"action": "Audit Log search performed",
"actionI18nKey": "atlassian.audit.event.action.audit.search",
"area": "AUDIT_LOG",
"category": "Auditing",
"categoryI18nKey": "atlassian.audit.event.category.audit",
"level": "BASE"
"action": "User deactivated",
"category": "Users and groups"
}
}
},
Expand All @@ -173,63 +148,30 @@ An example event for `audit` looks as following:
"version": "8.10.0"
},
"elastic_agent": {
"id": "cdda426a-7e47-48c4-b2f5-b9f1ad5bf08a",
"snapshot": true,
"version": "8.8.0"
"id": "1f67a92c-38d3-40a8-9093-c4495a7411a3",
"snapshot": false,
"version": "8.10.2"
},
"event": {
"action": "atlassian.audit.event.action.audit.search",
"action": "User deactivated",
"agent_id_status": "verified",
"created": "2023-11-06T13:17:04.339Z",
"dataset": "atlassian_confluence.audit",
"ingested": "2023-05-09T21:17:32Z",
"ingested": "2023-11-06T13:17:05Z",
"kind": "event",
"original": "{\"affectedObjects\":[],\"auditType\":{\"action\":\"Audit Log search performed\",\"actionI18nKey\":\"atlassian.audit.event.action.audit.search\",\"area\":\"AUDIT_LOG\",\"category\":\"Auditing\",\"categoryI18nKey\":\"atlassian.audit.event.category.audit\",\"level\":\"BASE\"},\"author\":{\"id\":\"2c9580827d4a06e8017d4a07c3e10000\",\"name\":\"test.user\",\"type\":\"user\"},\"changedValues\":[],\"extraAttributes\":[{\"name\":\"Query\",\"nameI18nKey\":\"atlassian.audit.event.attribute.query\",\"value\":\"\"},{\"name\":\"Results returned\",\"nameI18nKey\":\"atlassian.audit.event.attribute.results\",\"value\":\"57\"},{\"name\":\"ID Range\",\"nameI18nKey\":\"atlassian.audit.event.attribute.id\",\"value\":\"1 - 57\"},{\"name\":\"Timestamp Range\",\"nameI18nKey\":\"atlassian.audit.event.attribute.timestamp\",\"value\":\"2021-11-22T23:42:45.791Z - 2021-11-22T23:43:22.615Z\"}],\"method\":\"Browser\",\"source\":\"81.2.69.143\",\"system\":\"http://confluence.internal:8090\",\"timestamp\":{\"epochSecond\":1637624653,\"nano\":873000000},\"version\":\"1.0\"}",
"original": "{\"affectedObject\":{\"name\":\"\",\"objectType\":\"\"},\"associatedObjects\":[],\"author\":{\"accountType\":\"\",\"displayName\":\"System\",\"externalCollaborator\":false,\"isExternalCollaborator\":false,\"operations\":null,\"publicName\":\"Unknown user\",\"type\":\"user\"},\"category\":\"Users and groups\",\"changedValues\":[],\"creationDate\":1637054756666,\"description\":\"\",\"remoteAddress\":\"81.2.69.143\",\"summary\":\"User deactivated\",\"superAdmin\":false,\"sysAdmin\":false}",
"type": [
"info"
]
},
"host": {
"architecture": "x86_64",
"containerized": true,
"hostname": "docker-fleet-agent",
"id": "cff3d165179d4aef9596ddbb263e3adb",
"ip": [
"172.23.0.7"
],
"mac": [
"02-42-AC-17-00-07"
],
"name": "docker-fleet-agent",
"os": {
"codename": "focal",
"family": "debian",
"kernel": "5.10.47-linuxkit",
"name": "Ubuntu",
"platform": "ubuntu",
"type": "linux",
"version": "20.04.5 LTS (Focal Fossa)"
}
},
"input": {
"type": "log"
},
"log": {
"file": {
"path": "/tmp/service_logs/test-audit.log"
},
"offset": 0
"type": "httpjson"
},
"related": {
"hosts": [
"confluence.internal"
],
"ip": [
"81.2.69.143"
]
},
"service": {
"address": "http://confluence.internal:8090"
},
"source": {
"address": "81.2.69.143",
"geo": {
Expand All @@ -248,11 +190,11 @@ An example event for `audit` looks as following:
},
"tags": [
"preserve_original_event",
"forwarded",
"confluence-audit"
],
"user": {
"full_name": "test.user",
"id": "2c9580827d4a06e8017d4a07c3e10000"
"full_name": "System"
}
}
```
2 changes: 1 addition & 1 deletion packages/atlassian_confluence/manifest.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
format_version: "3.0.0"
name: atlassian_confluence
title: Atlassian Confluence
version: "1.21.0"
version: "1.21.1"
description: Collect logs from Atlassian Confluence with Elastic Agent.
type: integration
categories:
Expand Down