Skip to content

[google_workspace] Add new data stream: vault - #13662

Merged
kcreddy merged 3 commits into
elastic:mainfrom
navnit-elastic:google_workspace-2.39.0
Apr 30, 2025
Merged

kcreddy merged 3 commits into
elastic:mainfrom
navnit-elastic:google_workspace-2.39.0

Conversation

@navnit-elastic

Copy link
Copy Markdown

Proposed commit message

google_workspace: add support for google vault event type as a new data stream

This adds support for the Google Vault audit event type as a new data stream to
enhance the overall visibility of data in the Google Workspace integration.

This changes includes updating navigation links in to the relevant dashboards.

Sanitized test case inputs were obtained from live Google Workspace instance
using the Admin SDK for Reports API[1].

[1] https://developers.google.com/workspace/admin/reports/reference/rest

Checklist

  • I have reviewed tips for building integrations and this pull request is aligned with them.
  • I have verified that all data streams collect metrics or logs.
  • I have added an entry to my package's changelog.yml file.
  • I have verified that Kibana version constraints are current according to guidelines.
  • I have verified that any added dashboard complies with Kibana's Dashboard good practices

Author's Checklist

  • [ ]

How to test this PR locally

--- Test results for package: google_workspace - START ---
╭──────────────────┬─────────────┬───────────┬───────────────────────────────────────────┬────────┬──────────────╮
│ PACKAGE          │ DATA STREAM │ TEST TYPE │ TEST NAME                                 │ RESULT │ TIME ELAPSED │
├──────────────────┼─────────────┼───────────┼───────────────────────────────────────────┼────────┼──────────────┤
│ google_workspace │ vault       │ pipeline  │ (ingest pipeline warnings test-vault.log) │ PASS   │ 342.211066ms │
│ google_workspace │ vault       │ pipeline  │ test-vault.log                            │ PASS   │ 267.916954ms │
╰──────────────────┴─────────────┴───────────┴───────────────────────────────────────────┴────────┴──────────────╯
--- Test results for package: google_workspace - END   ---
Done

--- Test results for package: google_workspace - START ---
╭──────────────────┬─────────────┬───────────┬───────────┬────────┬───────────────╮
│ PACKAGE          │ DATA STREAM │ TEST TYPE │ TEST NAME │ RESULT │  TIME ELAPSED │
├──────────────────┼─────────────┼───────────┼───────────┼────────┼───────────────┤
│ google_workspace │ vault       │ system    │ default   │ PASS   │ 59.014144083s │
╰──────────────────┴─────────────┴───────────┴───────────┴────────┴───────────────╯
--- Test results for package: google_workspace - END   ---
Done

Related issues

Screenshots

google-workspace-vault-screenshot

@navnit-elastic navnit-elastic added enhancement New feature or request Integration:google_workspace Google Workspace dashboard Relates to a Kibana dashboard bug, enhancement, or modification. Team:Security-Service Integrations Security Service Integrations team [elastic/security-service-integrations] Team:SDE-Crest Crest developers on the Security Integrations team [elastic/sit-crest-contractors] labels Apr 24, 2025
@navnit-elastic navnit-elastic self-assigned this Apr 24, 2025
@navnit-elastic
navnit-elastic requested a review from a team as a code owner April 24, 2025 07:43
@elasticmachine

Copy link
Copy Markdown

Pinging @elastic/security-service-integrations (Team:Security-Service Integrations)

@elastic-vault-github-plugin-prod

Copy link
Copy Markdown
Contributor

🚀 Benchmarks report

To see the full report comment with /test benchmark fullreport

@kcreddy

kcreddy commented Apr 30, 2025

Copy link
Copy Markdown
Contributor

/test

@elasticmachine

Copy link
Copy Markdown

💚 Build Succeeded

History

cc @navnit-elastic

@elastic-sonarqube

Copy link
Copy Markdown

@kcreddy
kcreddy merged commit acc28a7 into elastic:main Apr 30, 2025
@elastic-vault-github-plugin-prod

Copy link
Copy Markdown
Contributor

Package google_workspace - 2.39.0 containing this change is available at https://epr.elastic.co/package/google_workspace/2.39.0/

@leandrojmp

Copy link
Copy Markdown
Contributor

@kcreddy any reason to lock this change behind Kibana 8.18.X? can this be backported to 8.17.X?

we were waiting for this dataset but cannot upgrade the integration as we are still on 8.17.X, we cannot upgrade at the moment as we do not upgrade to .0 releases.

seanrathier pushed a commit to seanrathier/integrations that referenced this pull request May 1, 2025
google_workspace: add support for google vault event type as a new data stream

This adds support for the Google Vault audit event type as a new data stream to
enhance the overall visibility of data in the Google Workspace integration.

This changes includes updating navigation links in to the relevant dashboards.

Sanitized test case inputs were obtained from live Google Workspace instance
using the Admin SDK for Reports API[1].

[1] https://developers.google.com/workspace/admin/reports/reference/rest
@kcreddy

kcreddy commented May 2, 2025

Copy link
Copy Markdown
Contributor

@kcreddy any reason to lock this change behind Kibana 8.18.X? can this be backported to 8.17.X?

we were waiting for this dataset but cannot upgrade the integration as we are still on 8.17.X, we cannot upgrade at the moment as we do not upgrade to .0 releases.

Ideally we only backport bug-fixes to previous minor versions. But this PR is an enhancement.
The minimum kibana.version: 8.18.0 requirement came in #12921 as part of using the agentless deployment modes (which got introduced in 8.18 stack).
There are many data streams which we added after making kibana.version: 8.18.0, such as Data Studio, Calendar, Chat, and Vault along with few other enhancements as well. Do you need all of them to be backported to 8.17.x?

I will leave it to @jamiehynds to take the call if we need to backport.

@leandrojmp

leandrojmp commented May 2, 2025 •

Copy link
Copy Markdown
Contributor

@kcreddy Personally I'm only interested in the Vault dataset at the moment.

We are going to upgrade once 8.18.1 gets released, if it is not that far from release, then we could wait.

@kcreddy

kcreddy commented May 4, 2025 •

Copy link
Copy Markdown
Contributor

We are going to upgrade once 8.18.1 gets released, if it is not that far from release, then we could wait.

@leandrojmp Yes, its actually going to be released very soon. Thanks for the patience to wait on this feature until 8.18.1 👍🏼

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dashboard Relates to a Kibana dashboard bug, enhancement, or modification. enhancement New feature or request Integration:google_workspace Google Workspace Team:SDE-Crest Crest developers on the Security Integrations team [elastic/sit-crest-contractors] Team:Security-Service Integrations Security Service Integrations team [elastic/security-service-integrations]

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Google Workspace]: Add support for Vault event type

4 participants