Skip to content

Commit 01b2c99

Browse files
Merge branch 'master' into bug/index-template-mappings-scaled-float-default-value
2 parents a2f91e6 + 9ed69ce commit 01b2c99

504 files changed

Lines changed: 7715 additions & 4004 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/paths-labeller.yml

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,4 @@
11
---
2-
- "Team:AppArch":
3-
- "src/plugins/bfetch/**/*.*"
4-
- "src/plugins/dashboard_embeddable_container/**/*.*"
5-
- "src/plugins/data/**/*.*"
6-
- "src/plugins/embeddable/**/*.*"
7-
- "src/plugins/expressions/**/*.*"
8-
- "src/plugins/inspector/**/*.*"
9-
- "src/plugins/ui_actions/**/*.*"
10-
- "src/plugins/visualizations/**/*.*"
112
- "Feature:Embedding":
123
- "src/plugins/embeddable/**/*.*"
134
- "src/plugins/dashboard_embeddable_container/**/*.*"

docs/apm/agent-configuration.asciidoc

Lines changed: 15 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -31,37 +31,18 @@ Kibana communicates any changed settings to APM Server so that your agents only
3131
[float]
3232
==== Supported configurations
3333

34-
[float]
35-
===== `CAPTURE_BODY`
36-
37-
added[7.5.0] Can be `"off"`, `"errors"`, `"transactions"`, or `"all"`. Defaults to `"off"`.
38-
39-
For transactions that are HTTP requests, the Agent can optionally capture the request body, e.g., POST variables.
40-
Remember, request bodies often contain sensitive values like passwords, credit card numbers, etc.
41-
If your service handles sensitive data, enable this feature with care.
42-
Turning on body capturing can also significantly increase the overhead the overhead of the Agent,
43-
and the Elasticsearch index size.
44-
45-
[float]
46-
===== `TRANSACTION_MAX_SPANS`
47-
48-
added[7.5.0] A number between `0` and `32000`. Defaults to `500`.
49-
50-
Limit the number of spans that are recorded per transaction.
51-
This is helpful in cases where a transaction creates a very high amount of spans, e.g., thousands of SQL queries.
52-
Setting an upper limit will help prevent the Agent and the APM Server from being overloaded.
53-
54-
[float]
55-
===== `TRANSACTION_SAMPLE_RATE`
56-
57-
added[7.3.0] A sample rate between `0.000` and `1.0`. Default configuration is `1.0` (100% of traces).
58-
59-
Adjusting the sampling rate controls what percent of requests are traced.
60-
`1.0` means _all_ requests are traced. If you set the `TRANSACTION_SAMPLE_RATE` to a value below `1.0`,
61-
the agent will randomly sample only a subset of transactions.
62-
Unsampled transactions only record the name of the transaction, the overall transaction time, and the result.
63-
64-
IMPORTANT: In a distributed trace, the sampling decision is propagated by the initializing Agent.
65-
This means if you're using multiple agents, only the originating service's sampling rate will be used.
66-
Be sure to set sensible defaults in _all_ of your agents, especially the
67-
{apm-rum-ref}/configuration.html#transaction-sample-rate[JavaScript RUM Agent].
34+
Each Agent has its own list of supported configurations.
35+
After selecting a Service name and environment in the APM app,
36+
a list of all available configuration options,
37+
including descriptions and default values, will be displayed.
38+
39+
Supported configurations are also marked in each Agent's configuration documentation:
40+
41+
[horizontal]
42+
Go Agent:: {apm-go-ref}/configuration.html[Configuration reference]
43+
Java Agent:: {apm-java-ref}/configuration.html[Configuration reference]
44+
.NET Agent:: {apm-dotnet-ref}/configuration.html[Configuration reference]
45+
Node.js Agent:: {apm-node-ref}/configuration.html[Configuration reference]
46+
Python Agent:: {apm-py-ref}/configuration.html[Configuration reference]
47+
Ruby Agent:: {apm-ruby-ref}/configuration.html[Configuration reference]
48+
Real User Monitoring (RUM) Agent:: {apm-rum-ref}/configuration.html[Configuration reference]
318 KB
Loading
81.6 KB
Loading
221 KB
Loading

docs/infrastructure/index.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ You can optionally save these views and add them to {kibana-ref}/dashboard.html[
2121

2222
* Seamlessly switch to view the corresponding logs, application traces or uptime information for a component.
2323

24+
* Create alerts based on metric thresholds for one or more components.
25+
2426
To get started, you need to <<xpack-metrics-getting-started, start collecting metrics data from your infrastructure>>. Then you can <<infra-ui, use the Metrics application to inspect and analyze your data>>.
2527

2628
[role="screenshot"]

docs/infrastructure/metrics-explorer.asciidoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ By default that is set to `@timestamp`.
2020
* The interval for the X Axis is set to `auto`.
2121
The bucket size is determined by the time range.
2222
* To use *Open in Visualize* you need access to the Visualize app.
23+
* To use *Create alert* you need to {kibana-ref}/alerting-getting-started.html#alerting-setup-prerequisites[set up alerting].
2324

2425
[float]
2526
[[metrics-explorer-tutorial]]
@@ -67,4 +68,8 @@ Choose a graph, click the *Actions* dropdown and select *Open In Visualize*.
6768
This opens the graph in {kibana-ref}/TSVB.html[TSVB].
6869
From here you can save the graph and add it to a dashboard as usual.
6970

71+
9. You can also create an alert based on the metrics in a graph.
72+
Choose a graph, click the *Actions* dropdown and select *Create alert*.
73+
This opens the {kibana-ref}/defining-alerts.html[alert flyout] prefilled with mertrics from the chart.
74+
7075
Who's the Metrics Explorer now? You are!
Lines changed: 58 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
[role="xpack"]
22
[[epm]]
3-
== Elastic Package Manager
3+
== Ingest Manager
44

5-
These are the docs for the Elastic Package Manager (EPM).
5+
These are the docs for the Ingest Manager.
66

77

88
=== Configuration
@@ -39,16 +39,71 @@ curl -X DELETE localhost:5601/api/ingest_manager/epm/packages/iptables-1.0.4
3939

4040
This section is to define terms used across ingest management.
4141

42+
==== Data Source
43+
44+
A data source is a definition on how to collect data from a service, for example `nginx`. A data source contains
45+
definitions for one or multiple inputs and each input can contain one or multiple streams.
46+
47+
With the example of the nginx Data Source, it contains to inputs: `logs` and `nginx/metrics`. Logs and metrics are collected
48+
differently. The `logs` input contains two streams, `access` and `error`, the `nginx/metrics` input contains the stubstatus stream.
49+
50+
51+
==== Data Stream
52+
53+
Data Streams are a [new concept](https://github.com/elastic/elasticsearch/issues/53100) in Elasticsearch which simplify
54+
ingesting data and the setup of Elasticsearch.
55+
4256
==== Elastic Agent
57+
4358
A single, unified agent that users can deploy to hosts or containers. It controls which data is collected from the host or containers and where the data is sent. It will run Beats, Endpoint or other monitoring programs as needed. It can operate standalone or pull a configuration policy from Fleet.
4459

60+
61+
==== Elastic Package Registry
62+
63+
The Elastic Package Registry (EPR) is a service which runs under [https://epr.elastic.co]. It serves the packages through its API.
64+
More details about the registry can be found [here](https://github.com/elastic/package-registry).
65+
66+
==== Fleet
67+
68+
Fleet is the part of the Ingest Manager UI in Kibana that handles the part of enrolling Elastic Agents,
69+
managing agents and sending configurations to the Elastic Agent.
70+
71+
==== Indexing Strategy
72+
73+
Ingest Management + Elastic Agent follow a strict new indexing strategy: `{type}-{dataset}-{namespace}`. An example
74+
for this is `logs-nginx.access-default`. More details about it can be found in the Index Strategy below. All data of
75+
the index strategy is sent to Data Streams.
76+
77+
==== Input
78+
79+
An input is the configuration unit in an Agent Config that defines the options on how to collect data from
80+
an endpoint. This could be username / password which are need to authenticate with a service or a host url
81+
as an example.
82+
83+
An input is part of a Data Source and contains streams.
84+
85+
==== Integration
86+
87+
An integration is a package with the type integration. An integration package has at least 1 data source
88+
and usually collects data from / about a service.
89+
90+
4591
==== Namespace
92+
4693
A user-specified string that will be used to part of the index name in Elasticsearch. It helps users identify logs coming from a specific environment (like prod or test), an application, or other identifiers.
4794

95+
4896
==== Package
4997

50-
A package contains all the assets for the Elastic Stack. A more detailed definition of a package can be found under https://github.com/elastic/package-registry.
98+
A package contains all the assets for the Elastic Stack. A more detailed definition of a
99+
package can be found under https://github.com/elastic/package-registry.
100+
101+
Besides the assets, a package contains the data source definitions with its inputs and streams.
102+
103+
==== Stream
51104

105+
A stream is a configuration unit in the Elastic Agent config. A stream is part of an input and defines how the data
106+
fetched by this input should be processed and which Data Stream to send it to.
52107

53108
== Indexing Strategy
54109

docs/migration/migrate_8_0.asciidoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,4 +141,13 @@ access level.
141141
been deprecated with warnings that have been logged throughout 7.x. Please use Kibana UI to re-generate the
142142
POST URL snippets if you depend on these for automated PDF reports.
143143

144+
[float]
145+
=== Configurations starting with `xpack.telemetry` are no longer valid
146+
147+
*Details:*
148+
The `xpack.` prefix has been removed for all telemetry configurations.
149+
150+
*Impact:*
151+
For any configurations beginning with `xpack.telemetry`, remove the `xpack` prefix. Use {kibana-ref}/telemetry-settings-kbn.html#telemetry-general-settings[`telemetry.enabled`] instead.
152+
144153
// end::notable-breaking-changes[]
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
[[telemetry-settings-kbn]]
2+
=== Telemetry settings in Kibana
3+
++++
4+
<titleabbrev>Telemetry settings</titleabbrev>
5+
++++
6+
7+
By default, Usage Collection (also known as Telemetry) is enabled. This
8+
helps us learn about the {kib} features that our users are most interested in, so we
9+
can focus our efforts on making them even better.
10+
11+
You can control whether this data is sent from the {kib} servers, or if it should be sent
12+
from the user's browser, in case a firewall is blocking the connections from the server. Additionally, you can decide to completely disable this feature either in the config file or in {kib} via *Management > Kibana > Advanced Settings > Usage Data*.
13+
14+
See our https://www.elastic.co/legal/privacy-statement[Privacy Statement] to learn more.
15+
16+
[float]
17+
[[telemetry-general-settings]]
18+
==== General telemetry settings
19+
20+
`telemetry.enabled`:: *Default: true*.
21+
Set to `true` to send cluster statistics to Elastic. Reporting your
22+
cluster statistics helps us improve your user experience. Your data is never
23+
shared with anyone. Set to `false` to disable statistics reporting from any
24+
browser connected to the {kib} instance.
25+
26+
`telemetry.sendUsageFrom`:: *Default: 'browser'*.
27+
Set to `'server'` to report the cluster statistics from the {kib} server.
28+
If the server fails to connect to our endpoint at https://telemetry.elastic.co/, it assumes
29+
it is behind a firewall and falls back to `'browser'` to send it from users' browsers
30+
when they are navigating through {kib}.
31+
32+
`telemetry.optIn`:: *Default: true*.
33+
Set to `true` to automatically opt into reporting cluster statistics. You can also opt out through
34+
*Advanced Settings* in {kib}.
35+
36+
`telemetry.allowChangingOptInStatus`:: *Default: true*.
37+
Set to `true` to allow overwriting the `telemetry.optIn` setting via the {kib} UI.
38+
Note: When `false`, `telemetry.optIn` must be `true`. To disable telemetry and not allow users to change that parameter, use `telemetry.enabled`.

0 commit comments

Comments
 (0)