Skip to content

Commit ed6367a

Browse files
osquery manager
1 parent 70b0766 commit ed6367a

File tree

4 files changed

+18
-34
lines changed

4 files changed

+18
-34
lines changed

raw-migrated-files/docs-content/serverless/security-query-operating-systems.md

Lines changed: 0 additions & 10 deletions
This file was deleted.

raw-migrated-files/kibana/kibana/osquery.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# Osquery [osquery]
22

3-
% Am porting all of this introductory content over to the Security Osquery page.
4-
53
[Osquery](https://osquery.io) is an open source tool that lets you query operating systems like a database, providing you with visibility into your infrastructure and operating systems. Using basic SQL commands, you can ask questions about devices, such as servers, Docker containers, and computers running Linux, macOS, or Windows. The [extensive schema](https://osquery.io/schema) helps with a variety of use cases, including vulnerability detection, compliance monitoring, incident investigations, and more.
64

75
With Osquery in {{kib}}, you can:

solutions/security/investigate/manage-integration.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,21 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/kibana/current/manage-osquery-integration.html
4+
5+
navigation_title: "Osquery manager integration"
46
---
57

68
# Manage the integration [manage-osquery-integration]
79

810

911
## System requirements [_system_requirements]
1012

11-
* [Fleet](asciidocalypse://docs/docs-content/docs/reference/ingestion-tools/fleet/index.md) is enabled on your cluster, and one or more [Elastic Agents](asciidocalypse://docs/docs-content/docs/reference/ingestion-tools/fleet/install-elastic-agents.md) is enrolled.
12-
* The [**Osquery Manager**](https://docs.elastic.co/en/integrations/osquery_manager) integration has been added and configured for an agent policy through Fleet. This integration supports x64 architecture on Windows, MacOS, and Linux platforms, and ARM64 architecture on Linux.
13+
* [{{fleet}}](asciidocalypse://docs/docs-content/docs/reference/ingestion-tools/fleet/index.md) is enabled on your cluster, and one or more [{{agents}}](asciidocalypse://docs/docs-content/docs/reference/ingestion-tools/fleet/install-elastic-agents.md) is enrolled.
14+
* The [**Osquery Manager**](https://docs.elastic.co/en/integrations/osquery_manager) integration has been added and configured for an agent policy through {{fleet}}. This integration supports x64 architecture on Windows, MacOS, and Linux platforms, and ARM64 architecture on Linux.
1315

1416
::::{note}
1517
* The original [Filebeat Osquery module](asciidocalypse://docs/beats/docs/reference/ingestion-tools/beats-filebeat/filebeat-module-osquery.md) and the [Osquery](https://docs.elastic.co/en/integrations/osquery) integration collect logs from self-managed Osquery deployments. The **Osquery Manager** integration manages Osquery deployments and supports running and scheduling queries from {{kib}}.
16-
* **Osquery Manager** cannot be integrated with an Elastic Agent in standalone mode.
18+
* **Osquery Manager** cannot be integrated with an {{agent}} in standalone mode.
1719

1820
::::
1921

@@ -26,7 +28,7 @@ Depending on your [subscription level](https://www.elastic.co/subscriptions), yo
2628

2729
## Customize Osquery configuration [osquery-custom-config]
2830

29-
[preview] By default, all Osquery Manager integrations share the same osquery configuration. However, you can customize how Osquery is configured by editing the Osquery Manager integration for each agent policy you want to adjust. The custom configuration is then applied to all agents in the policy. This powerful feature allows you to configure [File Integrity Monitoring](https://osquery.readthedocs.io/en/stable/deployment/file-integrity-monitoring), [Process auditing](https://osquery.readthedocs.io/en/stable/deployment/process-auditing), and [others](https://osquery.readthedocs.io/en/stable/deployment/configuration/#configuration-specification).
31+
[preview] By default, all Osquery Manager integrations share the same Osquery configuration. However, you can customize how Osquery is configured by editing the Osquery Manager integration for each agent policy you want to adjust. The custom configuration is then applied to all agents in the policy. This powerful feature allows you to configure [File Integrity Monitoring](https://osquery.readthedocs.io/en/stable/deployment/file-integrity-monitoring), [Process auditing](https://osquery.readthedocs.io/en/stable/deployment/process-auditing), and [others](https://osquery.readthedocs.io/en/stable/deployment/configuration/#configuration-specification).
3032

3133
::::{important}
3234
* Take caution when editing this configuration. The changes you make are distributed to all agents in the policy.
@@ -87,12 +89,12 @@ For each agent policy where you want to allow `curl` table queries, edit the Osq
8789

8890
## Upgrade Osquery versions [_upgrade_osquery_versions]
8991

90-
The [Osquery version](https://github.com/osquery/osquery/releases) available on an Elastic Agent is associated to the version of Osquery Beat on the Agent. To get the latest version of Osquery Beat, [upgrade your Elastic Agent](asciidocalypse://docs/docs-content/docs/reference/ingestion-tools/fleet/upgrade-elastic-agent.md).
92+
The [Osquery version](https://github.com/osquery/osquery/releases) available on an {{agent}} is associated to the version of Osquery Beat on the Agent. To get the latest version of Osquery Beat, [upgrade your {{agent}}](asciidocalypse://docs/docs-content/docs/reference/ingestion-tools/fleet/upgrade-elastic-agent.md).
9193

9294

9395
## Debug issues [_debug_issues]
9496

95-
If you encounter issues with **Osquery Manager**, find the relevant logs for {{elastic-agent}} and Osquerybeat in the agent directory. Refer to the [Fleet Installation layout](asciidocalypse://docs/docs-content/docs/reference/ingestion-tools/fleet/installation-layout.md) to find the log file location for your OS.
97+
If you encounter issues with **Osquery Manager**, find the relevant logs for {{elastic-agent}} and Osquerybeat in the agent directory. Refer to the [{fleet} Installation layout](asciidocalypse://docs/docs-content/docs/reference/ingestion-tools/fleet/installation-layout.md) to find the log file location for your OS.
9698

9799
```ts
98100
../data/elastic-agent-*/logs/elastic-agent-json.log-*
@@ -101,7 +103,7 @@ If you encounter issues with **Osquery Manager**, find the relevant logs for {{e
101103

102104
To get more details in the logs, change the agent logging level to debug:
103105

104-
1. Go to **Fleet** using the navigation menu or the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
106+
1. Go to **{{fleet}}** using the navigation menu or the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
105107
2. Select the agent that you want to debug.
106108
3. On the **Logs*** tab, change the ***Agent logging level*** to ***debug***, and then click ***Apply changes**.
107109

solutions/security/investigate/osquery.md

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,10 @@ mapped_urls:
55
- https://www.elastic.co/guide/en/kibana/current/osquery.html
66
---
77

8-
# Osquery
9-
10-
% What needs to be done: Refine
11-
12-
% Scope notes: Align serverless/stateful + combine with Kibana Osquery intro page
8+
# Osquery [osquery]
139

1410
% Use migrated content from existing pages that map to this page:
1511

16-
% - [x] ./raw-migrated-files/security-docs/security/use-osquery.md
17-
% - [ ] ./raw-migrated-files/docs-content/serverless/security-query-operating-systems.md
1812
% - [ ] ./raw-migrated-files/kibana/kibana/osquery.md
1913

2014
[Osquery](https://osquery.io) is an open source tool that lets you query operating systems like a database, providing you with visibility into your infrastructure and operating systems. Using basic SQL commands, you can ask questions about devices, such as servers, Docker containers, and computers running Linux, macOS, or Windows. The [extensive schema](https://osquery.io/schema) helps with a variety of use cases, including vulnerability detection, compliance monitoring, incident investigations, and more.
@@ -26,7 +20,7 @@ With Osquery, you can:
2620
* View a history of past queries and their results
2721
* Save queries and build a library of queries for specific use cases
2822

29-
To use Osquery, you must add the [Osquery manager integration](/solutions/security/investigate/manage-integration.md) to an {{agent}} policy. After completing that step, you can use the Osquery features that are available in your solution.
23+
To use Osquery, you must add the [Osquery manager integration](manage-integration.md) to an {{agent}} policy. After completing that step, you can use the Osquery features that are available in your solution.
3024

3125
% The following Osquery features are available from {{elastic-sec}}:
3226

@@ -52,7 +46,7 @@ To inspect hosts, run a query against one or more agents or policies, then view
5246
4. Select one or more agents or groups to query. Start typing in the search field, and you’ll get suggestions for agents by name, ID, platform, and policy.
5347
5. Specify the query or pack to run:
5448

55-
* **Query**: Select a saved query or enter a new one in the text box. After you enter the query, you can expand the **Advanced** section to set a timeout period for the query, and view or set [mapped ECS fields](../../../solutions/security/investigate/osquery.md#osquery-map-fields) included in the results from the live query (optional).
49+
* **Query**: Select a saved query or enter a new one in the text box. After you enter the query, you can expand the **Advanced** section to set a timeout period for the query, and view or set [mapped ECS fields](#osquery-map-fields) included in the results from the live query (optional).
5650

5751
::::{note}
5852
Overwriting the query’s default timeout period allows you to support queries that require more time to complete. The default and minimum supported value for the **Timeout** field is `60`. The maximum supported value is `900`.
@@ -61,7 +55,7 @@ To inspect hosts, run a query against one or more agents or policies, then view
6155
* **Pack**: Select from available query packs. After you select a pack, all of the queries in the pack are displayed.
6256

6357
::::{tip}
64-
Refer to [prebuilt packs](../../../solutions/security/investigate/osquery.md#osquery-prebuilt-packs) to learn about using and managing Elastic prebuilt packs.
58+
Refer to [prebuilt packs](#osquery-prebuilt-packs) to learn about using and managing Elastic prebuilt packs.
6559
::::
6660

6761

@@ -91,7 +85,7 @@ To inspect hosts, run a query against one or more agents or policies, then view
9185
The **Live queries history** section on the **Live queries** tab shows a log of queries run over the last 30 days. From the Live queries table, you can:
9286

9387
* Click the run icon (![Right-pointing triangle](../../../images/kibana-play-icon.png "")) to rerun a single query or a query pack.
94-
* Click the table icon (![Table icon](../../../images/kibana-table-icon.png "")) to examine the [results](../../../solutions/security/investigate/osquery.md#osquery-results) for a single query or a query pack. From the results table, you can also find the query [status](../../../solutions/security/investigate/osquery.md#osquery-status).
88+
* Click the table icon (![Table icon](../../../images/kibana-table-icon.png "")) to examine the [results](#osquery-results) for a single query or a query pack. From the results table, you can also find the query [status](#osquery-status).
9589

9690
:::{image} ../../../images/kibana-live-query-check-results.png
9791
:alt: Results of OSquery
@@ -102,7 +96,7 @@ The **Live queries history** section on the **Live queries** tab shows a log of
10296

10397
## Schedule queries with packs [osquery-schedule-query]
10498

105-
A pack is a set of grouped queries that perform similar functions or address common use cases. [Prebuilt Elastic packs](../../../solutions/security/investigate/osquery.md#osquery-prebuilt-packs) are available to download and can help you get started using the Osquery integration.
99+
A pack is a set of grouped queries that perform similar functions or address common use cases. [Prebuilt Elastic packs](#osquery-prebuilt-packs) are available to download and can help you get started using the Osquery integration.
106100

107101
You can also create a custom pack with one or more queries. For example, when creating custom packs, you might create one pack that checks for IT compliance-type issues, and another pack that monitors for evidence of malware.
108102

@@ -114,7 +108,7 @@ You can run packs as live queries or schedule packs to run for one or more agent
114108
4. Schedule the pack to be deployed on specified agent policies (**Policy**) or on all agent policies (**Global**).
115109

116110
::::{tip}
117-
Pack deployment details are stored within the [Osquery configuration](../../../solutions/security/investigate/manage-integration.md#osquery-custom-config). The `shard` field value is the percentage of agents in the policy using the pack.
111+
Pack deployment details are stored within the [Osquery configuration](/solutions/security/investigate/manage-integration.md#osquery-custom-config). The `shard` field value is the percentage of agents in the policy using the pack.
118112
::::
119113

120114

@@ -130,7 +124,7 @@ You can run packs as live queries or schedule packs to run for one or more agent
130124

131125
5. If you’re creating a new pack, add queries to schedule:
132126

133-
* Click **Add query** and then add a saved query or enter a new query. Each query must include a unique query ID and the interval at which it should run. Optionally, set the minimum Osquery version and platform, specify a timeout period, or [map ECS fields](../../../solutions/security/investigate/osquery.md#osquery-map-fields). When you add a saved query to a pack, this adds a copy of the query. A connection is not maintained between saved queries and packs.
127+
* Click **Add query** and then add a saved query or enter a new query. Each query must include a unique query ID and the interval at which it should run. Optionally, set the minimum Osquery version and platform, specify a timeout period, or [map ECS fields](#osquery-map-fields). When you add a saved query to a pack, this adds a copy of the query. A connection is not maintained between saved queries and packs.
134128

135129
::::{note}
136130
Overwriting the query’s default timeout period allows you to support queries that require more time to complete. The default and minimum supported value for the **Timeout** field is `60`. The maximum supported value is `900`.
@@ -172,7 +166,7 @@ Once you save a query, you can only edit it from the **Saved queries** tab:
172166
* A brief description.
173167
* The SQL query (required). Osquery supports multi-line queries.
174168
* A timeout period (optional). Increase the query’s default timeout period to support queries that require more time to complete. The default and minimum supported value for the **Timeout** field is `60`. The maximum supported value is `900`.
175-
* The [ECS fields](../../../solutions/security/investigate/osquery.md#osquery-map-fields) to populate when the query is run (optional). These fields are also copied in when you add this query to a pack.
169+
* The [ECS fields](#osquery-map-fields) to populate when the query is run (optional). These fields are also copied in when you add this query to a pack.
176170
* The defaults to set when you add the query to a pack.
177171

178172
* The frequency to run the query.

0 commit comments

Comments
 (0)