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
|The newsfeed plugin adds a NewsfeedNavButton to the top navigation bar and renders the content in the flyout.
225
-
Content is fetched from the remote (https://feeds.elastic.co and https://feeds-staging.elastic.co in dev mode) once a day, with periodic checks if the content needs to be refreshed. All newsfeed content is hosted remotely.
225
+
Content is fetched from the remote (https://feeds.elastic.co) once a day, with periodic checks if the content needs to be refreshed. All newsfeed content is hosted remotely.
| Enables Transaction histogram metrics. Defaults to `auto` so the UI will use metric indices over transaction indices for transactions if aggregated transactions are found. When set to `always`, additional configuration in APM Server is required. When set to `never` and aggregated transactions are not used.
78
-
See {apm-guide-ref}/transaction-metrics.html[Configure transaction metrics] for more information.
Enables Transaction histogram metrics. Defaults to `auto` so the UI will use metric indices over transaction indices for transactions if aggregated transactions are found. When set to `always`, additional configuration in APM Server is required. When set to `never` and aggregated transactions are not used.
76
+
+
77
+
See {apm-guide-ref}/transaction-metrics.html[Configure transaction metrics] for more information.
79
78
80
-
| `xpack.apm.metricsInterval` {ess-icon}
81
-
| Sets a `fixed_interval` for date histograms in metrics aggregations. Defaults to `30`.
79
+
`xpack.apm.metricsInterval` {ess-icon}::
80
+
Sets a `fixed_interval` for date histograms in metrics aggregations. Defaults to `30`.
82
81
83
-
| `xpack.apm.agent.migrations.enabled` {ess-icon}
84
-
| Set to `false` to disable cloud APM migrations. Defaults to `true`.
82
+
`xpack.apm.agent.migrations.enabled` {ess-icon}::
83
+
Set to `false` to disable cloud APM migrations. Defaults to `true`.
85
84
86
-
| `xpack.apm.indices.error` {ess-icon}
87
-
| Matcher for all error indices. Defaults to `logs-apm*,apm-*`.
85
+
`xpack.apm.indices.error` {ess-icon}::
86
+
Matcher for all error indices. Defaults to `logs-apm*,apm-*`.
88
87
89
-
| `xpack.apm.indices.onboarding` {ess-icon}
90
-
| Matcher for all onboarding indices. Defaults to `apm-*`.
88
+
`xpack.apm.indices.onboarding` {ess-icon}::
89
+
Matcher for all onboarding indices. Defaults to `apm-*`.
91
90
92
-
| `xpack.apm.indices.span` {ess-icon}
93
-
| Matcher for all span indices. Defaults to `traces-apm*,apm-*`.
91
+
`xpack.apm.indices.span` {ess-icon}::
92
+
Matcher for all span indices. Defaults to `traces-apm*,apm-*`.
94
93
95
-
| `xpack.apm.indices.transaction` {ess-icon}
96
-
| Matcher for all transaction indices. Defaults to `traces-apm*,apm-*`.
94
+
`xpack.apm.indices.transaction` {ess-icon}::
95
+
Matcher for all transaction indices. Defaults to `traces-apm*,apm-*`.
97
96
98
-
| `xpack.apm.indices.metric` {ess-icon}
99
-
| Matcher for all metrics indices. Defaults to `metrics-apm*,apm-*`.
97
+
`xpack.apm.indices.metric` {ess-icon}::
98
+
Matcher for all metrics indices. Defaults to `metrics-apm*,apm-*`.
100
99
101
-
| `xpack.apm.indices.sourcemap` {ess-icon}
102
-
| Matcher for all source map indices. Defaults to `apm-*`.
100
+
`xpack.apm.indices.sourcemap` {ess-icon}::
101
+
Matcher for all source map indices. Defaults to `apm-*`.
103
102
104
-
| `xpack.apm.autoCreateApmDataView` {ess-icon}
105
-
| Set to `false` to disable the automatic creation of the APM data view when the APM app is opened. Defaults to `true`.
106
-
|===
103
+
`xpack.apm.autoCreateApmDataView` {ess-icon}::
104
+
Set to `false` to disable the automatic creation of the APM data view when the APM app is opened. Defaults to `true`.
@@ -18,104 +18,140 @@ See the {fleet-guide}/index.html[{fleet}] docs for more information.
18
18
[[general-fleet-settings-kb]]
19
19
==== General {fleet} settings
20
20
21
-
[cols="2*<"]
22
-
|===
23
-
| `xpack.fleet.agents.enabled` {ess-icon}
24
-
| Set to `true` (default) to enable {fleet}.
25
-
|===
21
+
`xpack.fleet.agents.enabled` {ess-icon}::
22
+
Set to `true` (default) to enable {fleet}.
23
+
26
24
27
25
[[fleet-data-visualizer-settings]]
28
26
29
27
==== {package-manager} settings
30
28
31
-
[cols="2*<"]
32
-
|===
33
-
| `xpack.fleet.registryUrl`
34
-
| The address to use to reach the {package-manager} registry.
35
-
| `xpack.fleet.registryProxyUrl`
36
-
| The proxy address to use to reach the {package-manager} registry if an internet connection is not directly available.
37
-
Refer to {fleet-guide}/air-gapped.html[Air-gapped environments] for details.
29
+
`xpack.fleet.registryUrl`::
30
+
The address to use to reach the {package-manager} registry.
31
+
32
+
`xpack.fleet.registryProxyUrl`::
33
+
The proxy address to use to reach the {package-manager} registry if an internet connection is not directly available.
34
+
Refer to {fleet-guide}/air-gapped.html[Air-gapped environments] for details.
38
35
39
-
|===
40
36
41
37
==== {fleet} settings
42
38
43
-
[cols="2*<"]
44
-
|===
45
-
| `xpack.fleet.agents.fleet_server.hosts`
46
-
| Hostnames used by {agent} for accessing {fleet-server}.
47
-
| `xpack.fleet.agents.elasticsearch.hosts`
48
-
| Hostnames used by {agent} for accessing {es}.
49
-
| `xpack.fleet.agents.elasticsearch.ca_sha256`
50
-
| Hash pin used for certificate verification. The pin is a base64-encoded
51
-
string of the SHA-256 fingerprint.
52
-
|===
39
+
`xpack.fleet.agents.fleet_server.hosts`::
40
+
Hostnames used by {agent} for accessing {fleet-server}.
41
+
42
+
`xpack.fleet.agents.elasticsearch.hosts`::
43
+
Hostnames used by {agent} for accessing {es}.
53
44
45
+
`xpack.fleet.agents.elasticsearch.ca_sha256`::
46
+
Hash pin used for certificate verification. The pin is a base64-encoded string of the SHA-256 fingerprint.
54
47
48
+
49
+
[role="child_attributes"]
55
50
==== Preconfiguration settings (for advanced use cases)
56
51
57
52
Use these settings to pre-define integrations and agent policies that you
58
53
want {fleet} to load up by default.
59
54
60
-
[cols="2*<a"]
61
-
|===
62
-
63
-
| `xpack.fleet.packages`
64
-
| List of integrations that are installed when the {fleet} app starts
65
-
up for the first time. Required properties are:
66
-
67
-
`name`:: Name of the integration from the package registry.
68
-
`version`:: Either an exact semantic version, or the keyword `latest` to fetch
69
-
the latest integration version.
70
-
71
-
| `xpack.fleet.agentPolicies`
72
-
| List of agent policies that are configured when the {fleet} app starts.
73
-
Required properties are:
74
-
75
-
`id`:: Unique ID for this policy. The ID may be a number or string.
76
-
`name`:: Policy name.
77
-
78
-
Optional properties are:
79
-
80
-
`description`:: Text description of this policy.
81
-
`namespace`:: String identifying this policy's namespace.
82
-
`monitoring_enabled`:: List of keywords that specify the monitoring data to collect.
83
-
Valid values include `['logs']`, `['metrics']`, and `['logs', 'metrics']`.
84
-
`is_managed`:: If `true`, this policy is not editable by the user and can only
85
-
be changed by updating the {kib} config.
86
-
`is_default`:: If `true`, this policy is the default agent policy.
87
-
`is_default_fleet_server`:: If `true`, this policy is the default {fleet-server} agent policy.
88
-
`data_output_id`:: ID of the output to send data (Need to be identical to `monitoring_output_id`)
89
-
`monitoring_output_id`:: ID of the output to send monitoring data. (Need to be identical to `data_output_id`)
90
-
`package_policies`:: List of integration policies to add to this policy.
91
-
`id`::: Unique ID of the integration policy. The ID may be a number or string.
92
-
`name`::: (required) Name of the integration policy.
93
-
`package`::: (required) Integration that this policy configures
94
-
`name`:::: Name of the integration associated with this policy.
95
-
`description`::: Text string describing this integration policy.
96
-
`namespace`::: String identifying this policy's namespace.
97
-
`inputs`::: Array that overrides any default input settings for this
98
-
integration. Follows the same schema as integration inputs, with the
99
-
exception that any object in `vars` can be passed `frozen: true` in order to
100
-
prevent that specific `var` from being edited by the user.
101
-
102
-
| `xpack.fleet.outputs`
103
-
| List of outputs that are configured when the {fleet} app starts.
104
-
Required properties are:
105
-
106
-
`id`:: Unique ID for this output. The ID should be a string.
107
-
`name`:: Output name.
108
-
`type`:: Type of Output. Currently we only support "elasticsearch".
109
-
`hosts`:: Array that contains the list of host for that output.
110
-
`config`:: Extra config for that output.
111
-
112
-
Optional properties are:
113
-
114
-
`is_default`:: If `true`, this output is the default output.
115
-
|===
116
-
55
+
`xpack.fleet.packages`::
56
+
List of integrations that are installed when the {fleet} app starts up for the first time.
57
+
+
58
+
.Required properties of `xpack.fleet.packages`
59
+
[%collapsible%open]
60
+
=====
61
+
`name`:::
62
+
Name of the integration from the package registry.
63
+
64
+
`version`:::
65
+
Either an exact semantic version, or the keyword `latest` to fetch the latest integration version.
66
+
=====
67
+
68
+
`xpack.fleet.agentPolicies`::
69
+
List of agent policies that are configured when the {fleet} app starts.
70
+
+
71
+
.Required properties of `xpack.fleet.agentPolicies`
72
+
[%collapsible%open]
73
+
=====
74
+
`id`:::
75
+
Unique ID for this policy. The ID may be a number or string.
76
+
`name`:::
77
+
Policy name.
78
+
=====
79
+
+
80
+
.Optional properties of `xpack.fleet.agentPolicies`
81
+
[%collapsible%open]
82
+
=====
83
+
`description`:::
84
+
Text description of this policy.
85
+
`namespace`:::
86
+
String identifying this policy's namespace.
87
+
`monitoring_enabled`:::
88
+
List of keywords that specify the monitoring data to collect. Valid values include `['logs']`, `['metrics']`, and `['logs', 'metrics']`.
89
+
`is_managed`:::
90
+
If `true`, this policy is not editable by the user and can only be changed by updating the {kib} config.
91
+
`is_default`:::
92
+
If `true`, this policy is the default agent policy.
93
+
`is_default_fleet_server`:::
94
+
If `true`, this policy is the default {fleet-server} agent policy.
95
+
`data_output_id`:::
96
+
ID of the output to send data. (Need to be identical to `monitoring_output_id`)
97
+
`monitoring_output_id`:::
98
+
ID of the output to send monitoring data. (Need to be identical to `data_output_id`)
99
+
`package_policies`:::
100
+
List of integration policies to add to this policy.
101
+
+
102
+
.Properties of `package_policies`
103
+
[%collapsible%open]
104
+
=======
105
+
`id`::::
106
+
Unique ID of the integration policy. The ID may be a number or string.
107
+
`name`::::
108
+
(required) Name of the integration policy.
109
+
`package`::::
110
+
(required) Integration that this policy configures.
111
+
+
112
+
.Properties of `package`
113
+
[%collapsible%open]
114
+
========
115
+
`name`::::
116
+
Name of the integration associated with this policy.
117
+
========
118
+
119
+
`description`::::
120
+
Text string describing this integration policy.
121
+
`namespace`::::
122
+
String identifying this policy's namespace.
123
+
`inputs`::::
124
+
Array that overrides any default input settings for this integration. Follows the same schema as integration inputs, with the exception that any object in `vars` can be passed `frozen: true` in order to prevent that specific `var` from being edited by the user.
125
+
=======
126
+
=====
127
+
128
+
`xpack.fleet.outputs`::
129
+
List of outputs that are configured when the {fleet} app starts.
130
+
+
131
+
.Required properties of `xpack.fleet.outputs`
132
+
[%collapsible%open]
133
+
=====
134
+
`id`:::
135
+
Unique ID for this output. The ID should be a string.
136
+
`name`:::
137
+
Output name.
138
+
`type`:::
139
+
Type of Output. Currently we only support "elasticsearch".
140
+
`hosts`:::
141
+
Array that contains the list of host for that output.
0 commit comments