Skip to content

Commit

Permalink
Merge branch 'main' into 129474/default-legend-size-to-fixed-migratio…
Browse files Browse the repository at this point in the history
…ns-strategy
  • Loading branch information
kibanamachine authored May 10, 2022
2 parents bc69ec8 + 3c33854 commit d612e4d
Show file tree
Hide file tree
Showing 356 changed files with 6,133 additions and 2,081 deletions.
8 changes: 5 additions & 3 deletions .buildkite/ftr_configs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -162,10 +162,12 @@ enabled:
- x-pack/test/functional/apps/maps/group2/config.ts
- x-pack/test/functional/apps/maps/group3/config.ts
- x-pack/test/functional/apps/maps/group4/config.ts
- x-pack/test/functional/apps/ml/anomaly_detection/config.ts
- x-pack/test/functional/apps/ml/data_frame_analytics/config.ts
- x-pack/test/functional/apps/ml/data_visualizer/config.ts
- x-pack/test/functional/apps/ml/group1/config.ts
- x-pack/test/functional/apps/ml/group2/config.ts
- x-pack/test/functional/apps/ml/group3/config.ts
- x-pack/test/functional/apps/ml/permissions/config.ts
- x-pack/test/functional/apps/ml/short_tests/config.ts
- x-pack/test/functional/apps/ml/stack_management_jobs/config.ts
- x-pack/test/functional/apps/monitoring/config.ts
- x-pack/test/functional/apps/remote_clusters/config.ts
- x-pack/test/functional/apps/reporting_management/config.ts
Expand Down
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@
/x-pack/plugins/ui_actions_enhanced/ @elastic/kibana-app-services
/x-pack/plugins/runtime_fields @elastic/kibana-app-services
/x-pack/test/search_sessions_integration/ @elastic/kibana-app-services
/src/plugins/dashboard/public/application/embeddable/viewport/print_media @elastic/kibana-app-services

### Observability Plugins

Expand Down
2 changes: 1 addition & 1 deletion docs/developer/plugin-list.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ It also provides a stateful version of it on the start contract.
|{kib-repo}blob/{branch}/src/plugins/newsfeed/README.md[newsfeed]
|The newsfeed plugin adds a NewsfeedNavButton to the top navigation bar and renders the content in the flyout.
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.
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.
|{kib-repo}blob/{branch}/src/plugins/presentation_util/README.mdx[presentationUtil]
Expand Down
90 changes: 44 additions & 46 deletions docs/settings/apm-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -38,71 +38,69 @@ If you'd like to change any of the default values,
copy and paste the relevant settings into your `kibana.yml` configuration file.
Changing these settings may disable features of the APM App.

[cols="2*<"]
|===
| `xpack.apm.maxServiceEnvironments` {ess-icon}
| Maximum number of unique service environments recognized by the UI. Defaults to `100`.
`xpack.apm.maxServiceEnvironments` {ess-icon}::
Maximum number of unique service environments recognized by the UI. Defaults to `100`.

| `xpack.apm.serviceMapFingerprintBucketSize` {ess-icon}
| Maximum number of unique transaction combinations sampled for generating service map focused on a specific service. Defaults to `100`.
`xpack.apm.serviceMapFingerprintBucketSize` {ess-icon}::
Maximum number of unique transaction combinations sampled for generating service map focused on a specific service. Defaults to `100`.

| `xpack.apm.serviceMapFingerprintGlobalBucketSize` {ess-icon}
| Maximum number of unique transaction combinations sampled for generating the global service map. Defaults to `100`.
`xpack.apm.serviceMapFingerprintGlobalBucketSize` {ess-icon}::
Maximum number of unique transaction combinations sampled for generating the global service map. Defaults to `100`.

| `xpack.apm.serviceMapEnabled` {ess-icon}
| Set to `false` to disable service maps. Defaults to `true`.
`xpack.apm.serviceMapEnabled` {ess-icon}::
Set to `false` to disable service maps. Defaults to `true`.

| `xpack.apm.serviceMapTraceIdBucketSize` {ess-icon}
| Maximum number of trace IDs sampled for generating service map focused on a specific service. Defaults to `65`.
`xpack.apm.serviceMapTraceIdBucketSize` {ess-icon}::
Maximum number of trace IDs sampled for generating service map focused on a specific service. Defaults to `65`.

| `xpack.apm.serviceMapTraceIdGlobalBucketSize` {ess-icon}
| Maximum number of trace IDs sampled for generating the global service map. Defaults to `6`.
`xpack.apm.serviceMapTraceIdGlobalBucketSize` {ess-icon}::
Maximum number of trace IDs sampled for generating the global service map. Defaults to `6`.

| `xpack.apm.serviceMapMaxTracesPerRequest` {ess-icon}
| Maximum number of traces per request for generating the global service map. Defaults to `50`.
`xpack.apm.serviceMapMaxTracesPerRequest` {ess-icon}::
Maximum number of traces per request for generating the global service map. Defaults to `50`.

| `xpack.apm.ui.enabled` {ess-icon}
| Set to `false` to hide the APM app from the main menu. Defaults to `true`.
`xpack.apm.ui.enabled` {ess-icon}::
Set to `false` to hide the APM app from the main menu. Defaults to `true`.

| `xpack.apm.ui.transactionGroupBucketSize` {ess-icon}
| Number of top transaction groups displayed in the APM app. Defaults to `1000`.
`xpack.apm.ui.transactionGroupBucketSize` {ess-icon}::
Number of top transaction groups displayed in the APM app. Defaults to `1000`.

| `xpack.apm.ui.maxTraceItems` {ess-icon}
| Maximum number of child items displayed when viewing trace details. Defaults to `1000`.
`xpack.apm.ui.maxTraceItems` {ess-icon}::
Maximum number of child items displayed when viewing trace details. Defaults to `1000`.

| `xpack.observability.annotations.index` {ess-icon}
| Index name where Observability annotations are stored. Defaults to `observability-annotations`.
`xpack.observability.annotations.index` {ess-icon}::
Index name where Observability annotations are stored. Defaults to `observability-annotations`.

| `xpack.apm.searchAggregatedTransactions` {ess-icon}
| 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.
See {apm-guide-ref}/transaction-metrics.html[Configure transaction metrics] for more information.
`xpack.apm.searchAggregatedTransactions` {ess-icon}::
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.
+
See {apm-guide-ref}/transaction-metrics.html[Configure transaction metrics] for more information.

| `xpack.apm.metricsInterval` {ess-icon}
| Sets a `fixed_interval` for date histograms in metrics aggregations. Defaults to `30`.
`xpack.apm.metricsInterval` {ess-icon}::
Sets a `fixed_interval` for date histograms in metrics aggregations. Defaults to `30`.

| `xpack.apm.agent.migrations.enabled` {ess-icon}
| Set to `false` to disable cloud APM migrations. Defaults to `true`.
`xpack.apm.agent.migrations.enabled` {ess-icon}::
Set to `false` to disable cloud APM migrations. Defaults to `true`.

| `xpack.apm.indices.error` {ess-icon}
| Matcher for all error indices. Defaults to `logs-apm*,apm-*`.
`xpack.apm.indices.error` {ess-icon}::
Matcher for all error indices. Defaults to `logs-apm*,apm-*`.

| `xpack.apm.indices.onboarding` {ess-icon}
| Matcher for all onboarding indices. Defaults to `apm-*`.
`xpack.apm.indices.onboarding` {ess-icon}::
Matcher for all onboarding indices. Defaults to `apm-*`.

| `xpack.apm.indices.span` {ess-icon}
| Matcher for all span indices. Defaults to `traces-apm*,apm-*`.
`xpack.apm.indices.span` {ess-icon}::
Matcher for all span indices. Defaults to `traces-apm*,apm-*`.

| `xpack.apm.indices.transaction` {ess-icon}
| Matcher for all transaction indices. Defaults to `traces-apm*,apm-*`.
`xpack.apm.indices.transaction` {ess-icon}::
Matcher for all transaction indices. Defaults to `traces-apm*,apm-*`.

| `xpack.apm.indices.metric` {ess-icon}
| Matcher for all metrics indices. Defaults to `metrics-apm*,apm-*`.
`xpack.apm.indices.metric` {ess-icon}::
Matcher for all metrics indices. Defaults to `metrics-apm*,apm-*`.

| `xpack.apm.indices.sourcemap` {ess-icon}
| Matcher for all source map indices. Defaults to `apm-*`.
`xpack.apm.indices.sourcemap` {ess-icon}::
Matcher for all source map indices. Defaults to `apm-*`.

| `xpack.apm.autoCreateApmDataView` {ess-icon}
| Set to `false` to disable the automatic creation of the APM data view when the APM app is opened. Defaults to `true`.
|===
`xpack.apm.autoCreateApmDataView` {ess-icon}::
Set to `false` to disable the automatic creation of the APM data view when the APM app is opened. Defaults to `true`.

// end::general-apm-settings[]
198 changes: 117 additions & 81 deletions docs/settings/fleet-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,104 +18,140 @@ See the {fleet-guide}/index.html[{fleet}] docs for more information.
[[general-fleet-settings-kb]]
==== General {fleet} settings

[cols="2*<"]
|===
| `xpack.fleet.agents.enabled` {ess-icon}
| Set to `true` (default) to enable {fleet}.
|===
`xpack.fleet.agents.enabled` {ess-icon}::
Set to `true` (default) to enable {fleet}.


[[fleet-data-visualizer-settings]]

==== {package-manager} settings

[cols="2*<"]
|===
| `xpack.fleet.registryUrl`
| The address to use to reach the {package-manager} registry.
| `xpack.fleet.registryProxyUrl`
| The proxy address to use to reach the {package-manager} registry if an internet connection is not directly available.
Refer to {fleet-guide}/air-gapped.html[Air-gapped environments] for details.
`xpack.fleet.registryUrl`::
The address to use to reach the {package-manager} registry.

`xpack.fleet.registryProxyUrl`::
The proxy address to use to reach the {package-manager} registry if an internet connection is not directly available.
Refer to {fleet-guide}/air-gapped.html[Air-gapped environments] for details.

|===

==== {fleet} settings

[cols="2*<"]
|===
| `xpack.fleet.agents.fleet_server.hosts`
| Hostnames used by {agent} for accessing {fleet-server}.
| `xpack.fleet.agents.elasticsearch.hosts`
| Hostnames used by {agent} for accessing {es}.
| `xpack.fleet.agents.elasticsearch.ca_sha256`
| Hash pin used for certificate verification. The pin is a base64-encoded
string of the SHA-256 fingerprint.
|===
`xpack.fleet.agents.fleet_server.hosts`::
Hostnames used by {agent} for accessing {fleet-server}.

`xpack.fleet.agents.elasticsearch.hosts`::
Hostnames used by {agent} for accessing {es}.

`xpack.fleet.agents.elasticsearch.ca_sha256`::
Hash pin used for certificate verification. The pin is a base64-encoded string of the SHA-256 fingerprint.


[role="child_attributes"]
==== Preconfiguration settings (for advanced use cases)

Use these settings to pre-define integrations and agent policies that you
want {fleet} to load up by default.

[cols="2*<a"]
|===

| `xpack.fleet.packages`
| List of integrations that are installed when the {fleet} app starts
up for the first time. Required properties are:

`name`:: Name of the integration from the package registry.
`version`:: Either an exact semantic version, or the keyword `latest` to fetch
the latest integration version.

| `xpack.fleet.agentPolicies`
| List of agent policies that are configured when the {fleet} app starts.
Required properties are:

`id`:: Unique ID for this policy. The ID may be a number or string.
`name`:: Policy name.

Optional properties are:

`description`:: Text description of this policy.
`namespace`:: String identifying this policy's namespace.
`monitoring_enabled`:: List of keywords that specify the monitoring data to collect.
Valid values include `['logs']`, `['metrics']`, and `['logs', 'metrics']`.
`is_managed`:: If `true`, this policy is not editable by the user and can only
be changed by updating the {kib} config.
`is_default`:: If `true`, this policy is the default agent policy.
`is_default_fleet_server`:: If `true`, this policy is the default {fleet-server} agent policy.
`data_output_id`:: ID of the output to send data (Need to be identical to `monitoring_output_id`)
`monitoring_output_id`:: ID of the output to send monitoring data. (Need to be identical to `data_output_id`)
`package_policies`:: List of integration policies to add to this policy.
`id`::: Unique ID of the integration policy. The ID may be a number or string.
`name`::: (required) Name of the integration policy.
`package`::: (required) Integration that this policy configures
`name`:::: Name of the integration associated with this policy.
`description`::: Text string describing this integration policy.
`namespace`::: String identifying this policy's namespace.
`inputs`::: 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.

| `xpack.fleet.outputs`
| List of outputs that are configured when the {fleet} app starts.
Required properties are:

`id`:: Unique ID for this output. The ID should be a string.
`name`:: Output name.
`type`:: Type of Output. Currently we only support "elasticsearch".
`hosts`:: Array that contains the list of host for that output.
`config`:: Extra config for that output.

Optional properties are:

`is_default`:: If `true`, this output is the default output.
|===

`xpack.fleet.packages`::
List of integrations that are installed when the {fleet} app starts up for the first time.
+
.Required properties of `xpack.fleet.packages`
[%collapsible%open]
=====
`name`:::
Name of the integration from the package registry.
`version`:::
Either an exact semantic version, or the keyword `latest` to fetch the latest integration version.
=====

`xpack.fleet.agentPolicies`::
List of agent policies that are configured when the {fleet} app starts.
+
.Required properties of `xpack.fleet.agentPolicies`
[%collapsible%open]
=====
`id`:::
Unique ID for this policy. The ID may be a number or string.
`name`:::
Policy name.
=====
+
.Optional properties of `xpack.fleet.agentPolicies`
[%collapsible%open]
=====
`description`:::
Text description of this policy.
`namespace`:::
String identifying this policy's namespace.
`monitoring_enabled`:::
List of keywords that specify the monitoring data to collect. Valid values include `['logs']`, `['metrics']`, and `['logs', 'metrics']`.
`is_managed`:::
If `true`, this policy is not editable by the user and can only be changed by updating the {kib} config.
`is_default`:::
If `true`, this policy is the default agent policy.
`is_default_fleet_server`:::
If `true`, this policy is the default {fleet-server} agent policy.
`data_output_id`:::
ID of the output to send data. (Need to be identical to `monitoring_output_id`)
`monitoring_output_id`:::
ID of the output to send monitoring data. (Need to be identical to `data_output_id`)
`package_policies`:::
List of integration policies to add to this policy.
+
.Properties of `package_policies`
[%collapsible%open]
=======
`id`::::
Unique ID of the integration policy. The ID may be a number or string.
`name`::::
(required) Name of the integration policy.
`package`::::
(required) Integration that this policy configures.
+
.Properties of `package`
[%collapsible%open]
========
`name`::::
Name of the integration associated with this policy.
========

`description`::::
Text string describing this integration policy.
`namespace`::::
String identifying this policy's namespace.
`inputs`::::
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.
=======
=====

`xpack.fleet.outputs`::
List of outputs that are configured when the {fleet} app starts.
+
.Required properties of `xpack.fleet.outputs`
[%collapsible%open]
=====
`id`:::
Unique ID for this output. The ID should be a string.
`name`:::
Output name.
`type`:::
Type of Output. Currently we only support "elasticsearch".
`hosts`:::
Array that contains the list of host for that output.
`config`:::
Extra config for that output.
=====
+
.Optional properties of `xpack.fleet.outputs`
[%collapsible%open]
=====
`is_default`:::
If `true`, this output is the default output.
=====
+
Example configuration:

+
[source,yaml]
----
xpack.fleet.packages:
Expand Down
Loading

0 comments on commit d612e4d

Please sign in to comment.