You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: raw-migrated-files/kibana/kibana/osquery.md
-2Lines changed: 0 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,5 @@
1
1
# Osquery [osquery]
2
2
3
-
% Am porting all of this introductory content over to the Security Osquery page.
4
-
5
3
[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.
# Manage the integration [manage-osquery-integration]
7
9
8
10
9
11
## System requirements [_system_requirements]
10
12
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.
13
15
14
16
::::{note}
15
17
* 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.
17
19
18
20
::::
19
21
@@ -26,7 +28,7 @@ Depending on your [subscription level](https://www.elastic.co/subscriptions), yo
[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).
30
32
31
33
::::{important}
32
34
* 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
The [Osqueryversion](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 [Osqueryversion](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).
91
93
92
94
93
95
## Debugissues [_debug_issues]
94
96
95
-
Ifyouencounterissueswith**OsqueryManager**, findtherelevantlogsfor {{elastic-agent}} andOsquerybeatintheagentdirectory. Refertothe [FleetInstallationlayout](asciidocalypse://docs/docs-content/docs/reference/ingestion-tools/fleet/installation-layout.md) to find the log file location for your OS.
97
+
Ifyouencounterissueswith**OsqueryManager**, findtherelevantlogsfor {{elastic-agent}} andOsquerybeatintheagentdirectory. Refertothe [{fleet}Installationlayout](asciidocalypse://docs/docs-content/docs/reference/ingestion-tools/fleet/installation-layout.md) to find the log file location for your OS.
[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:
26
20
* View a history of past queries and their results
27
21
* Save queries and build a library of queries for specific use cases
28
22
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.
30
24
31
25
% The following Osquery features are available from {{elastic-sec}}:
32
26
@@ -52,7 +46,7 @@ To inspect hosts, run a query against one or more agents or policies, then view
52
46
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.
53
47
5. Specify the query or pack to run:
54
48
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).
56
50
57
51
::::{note}
58
52
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
61
55
***Pack**: Select from available query packs. After you select a pack, all of the queries in the pack are displayed.
62
56
63
57
::::{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.
65
59
::::
66
60
67
61
@@ -91,7 +85,7 @@ To inspect hosts, run a query against one or more agents or policies, then view
91
85
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:
92
86
93
87
* Click the run icon () to rerun a single query or a query pack.
94
-
* Click the table icon () 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 () 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).
@@ -102,7 +96,7 @@ The **Live queries history** section on the **Live queries** tab shows a log of
102
96
103
97
## Schedule queries with packs [osquery-schedule-query]
104
98
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.
106
100
107
101
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.
108
102
@@ -114,7 +108,7 @@ You can run packs as live queries or schedule packs to run for one or more agent
114
108
4. Schedule the pack to be deployed on specified agent policies (**Policy**) or on all agent policies (**Global**).
115
109
116
110
::::{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.
118
112
::::
119
113
120
114
@@ -130,7 +124,7 @@ You can run packs as live queries or schedule packs to run for one or more agent
130
124
131
125
5. If you’re creating a new pack, add queries to schedule:
132
126
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.
134
128
135
129
::::{note}
136
130
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:
172
166
* A brief description.
173
167
* The SQL query (required). Osquery supports multi-line queries.
174
168
* 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.
176
170
* The defaults to set when you add the query to a pack.
0 commit comments