Skip to content
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

Jump to bottom

x-pack/filebeat/input/entityanalytics/provider/okta: allow fine-grain control of API requests #36492

Merged
merged 2 commits into from
Sep 5, 2023
Merged

x-pack/filebeat/input/entityanalytics/provider/okta: allow fine-grain control of API requests #36492

merged 2 commits into from
Sep 5, 2023

Conversation

efd6
Copy link
Contributor

@efd6 efd6 commented Sep 3, 2023

Proposed commit message

This adds support for specifying which of users/devices to collect from the Okta API endpoints in order to reduce network costs for users who do not need a full set of entities.

The current change does not change the behaviour of device collection of registered owners and registered users; when the "devices" dataset is selected there user entities will still be collected as they are considered here as an attribute of the device, rather than a component of the users dataset.

Checklist

  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding change to the default configuration files
  • I have added tests that prove my fix is effective or that my feature works
  • I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

Author's Checklist

  • [ ]

How to test this PR locally

Related issues

Use cases

Screenshots

Logs

@efd6 efd6 added enhancement Filebeat Filebeat Team:Security-External Integrations backport-skip Skip notification from the automated backport with mergify 8.11-candidate labels Sep 3, 2023
@efd6 efd6 self-assigned this Sep 3, 2023
@botelastic botelastic bot added needs_team Indicates that the issue/PR needs a Team:* label and removed needs_team Indicates that the issue/PR needs a Team:* label labels Sep 3, 2023
@elasticmachine
Copy link
Collaborator

elasticmachine commented Sep 3, 2023 •
edited by jenkins-beats-ci bot
Loading

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2023-09-05T03:49:12.066+0000

  • Duration: 25 min 34 sec

❕ Flaky test report

No test was executed to be analysed.

🤖 GitHub comments

Expand to view the GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

  • /package : Generate the packages and run the E2E tests.

  • /beats-tester : Run the installation tests with beats-tester.

  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

@efd6 efd6 marked this pull request as ready for review September 3, 2023 22:54
@efd6 efd6 requested a review from a team as a code owner September 3, 2023 22:54
@elasticmachine
Copy link
Collaborator

Pinging @elastic/security-external-integrations (Team:Security-External Integrations)

bhapas
bhapas reviewed Sep 4, 2023
View reviewed changes
Copy link
Contributor

@bhapas bhapas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

Possible to add some unit tests?

@mergify
Copy link
Contributor

mergify bot commented Sep 4, 2023

This pull request is now in conflicts. Could you fix it? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b 36440-okta upstream/36440-okta
git merge upstream/main
git push upstream 36440-okta

@efd6
x-pack/filebeat/input/entityanalytics/provider/okta: allow fine-grain…
8fcccc0 
… control of API requests

This adds support for specifying which of users/devices to collect from
the Okta API endpoints in order to reduce network costs for users who do
not need a full set of entities.

The current change does not change the behaviour of device collection of
registered owners and registered users; when the "devices" dataset is
selected there user entities will still be collected as they are
considered here as an attribute of the device, rather than a component
of the users dataset.
@efd6
address pr comment
42489fb 
Move decision point into the doFetch methods to allow testing.

This change also removes the undocumented WantDevices config field as this
option is non-orthogonal with the dataset configuration.
@efd6 efd6 requested a review from bhapas September 4, 2023 22:05
@efd6
Copy link
Contributor Author

efd6 commented Sep 5, 2023

/package

@efd6
Copy link
Contributor Author

efd6 commented Sep 5, 2023

/test

@efd6 efd6 mentioned this pull request Sep 5, 2023
Closed
2 tasks
bhapas
bhapas approved these changes Sep 5, 2023
View reviewed changes
Copy link
Contributor

@bhapas bhapas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

x-pack/filebeat/input/entityanalytics/provider/okta/okta_test.go Show resolved Hide resolved
@efd6 efd6 merged commit 98b9f2c into elastic:main Sep 5, 2023
Scholar-Li pushed a commit to Scholar-Li/beats that referenced this pull request Feb 5, 2024
@efd6 @Scholar-Li
x-pack/filebeat/input/entityanalytics/provider/okta: allow fine-grain…
f0b743f 
… control of API requests (elastic#36492)

This adds support for specifying which of users/devices to collect from
the Okta API endpoints in order to reduce network costs for users who do
not need a full set of entities.

The current change does not change the behaviour of device collection of
registered owners and registered users; when the "devices" dataset is
selected there user entities will still be collected as they are
considered here as an attribute of the device, rather than a component
of the users dataset.

This change also removes the undocumented WantDevices config field as this
option is non-orthogonal with the dataset configuration.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bhapas bhapas bhapas approved these changes

Assignees

@efd6 efd6

Labels
8.11-candidate backport-skip Skip notification from the automated backport with mergify enhancement Filebeat Filebeat
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@efd6 @elasticmachine @bhapas