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

[DOCS] Documents Osquery Timeout setting #174595

Merged
merged 5 commits into from
Jan 17, 2024
Merged

[DOCS] Documents Osquery Timeout setting #174595

merged 5 commits into from
Jan 17, 2024

Conversation

natasha-moore-elastic
Copy link
Contributor

@natasha-moore-elastic natasha-moore-elastic commented Jan 10, 2024 •
edited by kibanamachine
Loading

Contributes to elastic/security-docs#4536 by documenting the new Timeout setting and timeout API parameter in Osquery docs.

@natasha-moore-elastic natasha-moore-elastic added Feature:Osquery Security Solution Osquery feature v8.12.0 labels Jan 10, 2024
@natasha-moore-elastic natasha-moore-elastic self-assigned this Jan 10, 2024
@github-actions GitHub Actions
Copy link
Contributor

Documentation preview:

@nastasha-solomon nastasha-solomon mentioned this pull request Jan 12, 2024
Closed
17 tasks
@tomsonpl tomsonpl requested a review from szwarckonrad January 15, 2024 13:12
@natasha-moore-elastic
Copy link
Contributor Author

Hey @szwarckonrad, I added the new timeout parameter to the request examples of Crate live query, Create pack, and Create saved query APIs, per Tomasz's comment:

I would say that every place where you have query, ecs_mapping or saved_query_id - its safe to add timeout

Please let me know if any other request or response examples should be updated. Thanks!

@szwarckonrad
Copy link
Contributor

Hey @szwarckonrad, I added the new timeout parameter to the request examples of Crate live query, Create pack, and Create saved query APIs, per Tomasz's comment:

I would say that every place where you have query, ecs_mapping or saved_query_id - its safe to add timeout

Please let me know if any other request or response examples should be updated. Thanks!

Timeout can also be added to a query in response actions, API path /api/detection_engine/rules

@natasha-moore-elastic
Copy link
Contributor Author

Hey @szwarckonrad, I added the new timeout parameter to the request examples of Crate live query, Create pack, and Create saved query APIs, per Tomasz's comment:

I would say that every place where you have query, ecs_mapping or saved_query_id - its safe to add timeout

Please let me know if any other request or response examples should be updated. Thanks!

Timeout can also be added to a query in response actions, API path /api/detection_engine/rules

Thanks – since that path is documented in the security-docs repo, I'll push an update to this PR.

@natasha-moore-elastic natasha-moore-elastic marked this pull request as ready for review January 16, 2024 11:09
@natasha-moore-elastic natasha-moore-elastic added the release_note:skip Skip the PR/issue when compiling release notes label Jan 16, 2024
@natasha-moore-elastic natasha-moore-elastic requested a review from a team January 16, 2024 11:30
szwarckonrad
szwarckonrad approved these changes Jan 16, 2024
View reviewed changes
Copy link
Contributor

@szwarckonrad szwarckonrad left a comment

Choose a reason for hiding this comment

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

LGTM 💯

@nastasha-solomon nastasha-solomon requested a review from a team January 16, 2024 19:40
benironside
benironside approved these changes Jan 16, 2024
View reviewed changes
Copy link
Contributor

@benironside benironside left a comment

Choose a reason for hiding this comment

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

LGTM, left one minor suggestion

docs/api/osquery-manager/saved-queries/create.asciidoc Outdated Show resolved Hide resolved
@nastasha-solomon nastasha-solomon requested a review from a team January 17, 2024 14:20
amyjtechwriter
amyjtechwriter approved these changes Jan 17, 2024
View reviewed changes
Copy link
Contributor

@amyjtechwriter amyjtechwriter left a comment

Choose a reason for hiding this comment

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

LGTM, thank you!

@natasha-moore-elastic natasha-moore-elastic merged commit 86a31db into elastic:main Jan 17, 2024
5 checks passed
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Jan 17, 2024
@natasha-moore-elastic
[DOCS] Documents Osquery Timeout setting (elastic#174595)
33243a8 
Contributes to elastic/security-docs#4536 by
documenting the new **Timeout** setting and `timeout` API parameter in
Osquery docs.

---------

Co-authored-by: nastasha.solomon <[email protected]>
Co-authored-by: Benjamin Ironside Goldstein <[email protected]>
(cherry picked from commit 86a31db)
@kibanamachine kibanamachine mentioned this pull request Jan 17, 2024
Merged
@kibanamachine
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
✅ 8.12

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

kibanamachine added a commit that referenced this pull request Jan 17, 2024
@kibanamachine @natasha-moore-elastic
[8.12] [DOCS] Documents Osquery Timeout setting (#174595) (#175039)
93ade3d 
# Backport

This will backport the following commits from `main` to `8.12`:
- [[DOCS] Documents Osquery Timeout setting
(#174595)](#174595)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT
[{"author":{"name":"natasha-moore-elastic","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-01-17T15:29:23Z","message":"[DOCS]
Documents Osquery Timeout setting (#174595)\n\nContributes to
elastic/security-docs#4536 by\r\ndocumenting
the new **Timeout** setting and `timeout` API parameter in\r\nOsquery
docs.\r\n\r\n---------\r\n\r\nCo-authored-by: nastasha.solomon
<[email protected]>\r\nCo-authored-by: Benjamin Ironside
Goldstein
<[email protected]>","sha":"86a31db057c5b66291dcd5e27adafa2899e82224","branchLabelMapping":{"^v8.13.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Feature:Osquery","v8.12.0","v8.13.0"],"title":"[DOCS]
Documents Osquery Timeout
setting","number":174595,"url":"https://github.com/elastic/kibana/pull/174595","mergeCommit":{"message":"[DOCS]
Documents Osquery Timeout setting (#174595)\n\nContributes to
elastic/security-docs#4536 by\r\ndocumenting
the new **Timeout** setting and `timeout` API parameter in\r\nOsquery
docs.\r\n\r\n---------\r\n\r\nCo-authored-by: nastasha.solomon
<[email protected]>\r\nCo-authored-by: Benjamin Ironside
Goldstein
<[email protected]>","sha":"86a31db057c5b66291dcd5e27adafa2899e82224"}},"sourceBranch":"main","suggestedTargetBranches":["8.12"],"targetPullRequestStates":[{"branch":"8.12","label":"v8.12.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.13.0","branchLabelMappingKey":"^v8.13.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/174595","number":174595,"mergeCommit":{"message":"[DOCS]
Documents Osquery Timeout setting (#174595)\n\nContributes to
elastic/security-docs#4536 by\r\ndocumenting
the new **Timeout** setting and `timeout` API parameter in\r\nOsquery
docs.\r\n\r\n---------\r\n\r\nCo-authored-by: nastasha.solomon
<[email protected]>\r\nCo-authored-by: Benjamin Ironside
Goldstein
<[email protected]>","sha":"86a31db057c5b66291dcd5e27adafa2899e82224"}}]}]
BACKPORT-->

Co-authored-by: natasha-moore-elastic <[email protected]>
CoenWarmer pushed a commit to CoenWarmer/kibana that referenced this pull request Feb 15, 2024
@natasha-moore-elastic @nastasha-solomon
@benironside @CoenWarmer
[DOCS] Documents Osquery Timeout setting (elastic#174595)
365fedc 
Contributes to elastic/security-docs#4536 by
documenting the new **Timeout** setting and `timeout` API parameter in
Osquery docs.

---------

Co-authored-by: nastasha.solomon <[email protected]>
Co-authored-by: Benjamin Ironside Goldstein <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tomsonpl tomsonpl tomsonpl left review comments

@benironside benironside benironside approved these changes

@nastasha-solomon nastasha-solomon nastasha-solomon approved these changes

@amyjtechwriter amyjtechwriter amyjtechwriter approved these changes

@szwarckonrad szwarckonrad szwarckonrad approved these changes

Assignees

@natasha-moore-elastic natasha-moore-elastic

Labels
Feature:Osquery Security Solution Osquery feature release_note:skip Skip the PR/issue when compiling release notes v8.12.0 v8.13.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@natasha-moore-elastic @szwarckonrad @kibanamachine @tomsonpl @amyjtechwriter @nastasha-solomon @benironside