Skip to content

Commit c1cfd70

Browse files
tsgruflin
authored andcommitted
Update experimental notices for 5.3 (#3525)
Configuration reloading -> beta[] Filebeat symlinks -> GA Filebeat harvester_limit -> GA Filebeat publish_async -> experimental & deprecated Using environment variables in the Configuration -> GA Metricbeat ceph -> beta[] Metricbeat couchbase -> beta[] Metricbeat docker -> beta[] Metricbeat haproxy -> GA Metricbeat kafka -> beta[] Metricbeat php_fpm -> beta[] Metricbeat prometheus -> beta[] This also cleans up the CHANGELOG.
1 parent f13e66e commit c1cfd70

Some content is hidden

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

56 files changed

+183
-134
lines changed

CHANGELOG.asciidoc

+103-54
Original file line numberDiff line numberDiff line change
@@ -16,123 +16,172 @@ https://github.com/elastic/beats/compare/v5.1.1...master[Check the HEAD diff]
1616

1717
- Change beat generator. Use `$GOPATH/src/github.com/elastic/beats/script/generate.py` to generate a beat. {pull}3452[3452]
1818

19+
*Filebeat*
20+
21+
*Heartbeat*
22+
1923
*Metricbeat*
2024
- Linux cgroup metrics are now enabled by default for the system process
2125
metricset. The configuration option for the feature was renamed from
2226
`cgroups` to `process.cgroups.enabled`. {pull}3519[3519]
2327

2428
*Packetbeat*
2529

26-
*Topbeat*
27-
28-
*Filebeat*
29-
3030
*Winlogbeat*
3131

3232

3333
==== Bugfixes
3434

3535
*Affecting all Beats*
3636

37-
- Add `_id`, `_type`, `_index` and `_score` fields in the generated index pattern. {pull}3282}[3282]
37+
- Add `_id`, `_type`, `_index` and `_score` fields in the generated index pattern. {pull}3282[3282]
38+
39+
*Filebeat*
40+
41+
*Heartbeat*
3842

3943
*Metricbeat*
4044

41-
- Fix service times-out at startup. {pull}3056[3056]
42-
- Kafka module case sensitive host name matching. {pull}3193[3193]
43-
- Fix interface conversion panic in couchbase module {pull}3272[3272]
44-
- Fix overwriting explicit empty config sections {issue}2918[2918]
4545
- Fix go routine leak in docker module. {pull}3492[3492]
4646

4747
*Packetbeat*
4848

49-
- Fix issue where some Cassandra visualizations were showing data from all protocols. {issue}3314[3314]
50-
51-
*Topbeat*
52-
53-
*Filebeat*
54-
- Fix registry cleanup issue when files falling under ignore_older after restart. {issue}2818[2818]
55-
- Fix registry migration issue from old states were files were only harvested after second restart. {pull}3322[3322]
56-
- Fix alignment issue were Filebeat compiled with Go 1.7.4 was crashing on 32 bits system. {issue}3273[3273]
5749

5850
*Winlogbeat*
59-
- Fix for "The array bounds are invalid" error when reading large events. {issue}3076[3076]
51+
6052

6153
==== Added
6254

6355
*Affecting all Beats*
64-
- Add support for passing list and dictionary settings via -E flag.
65-
- Support for parsing list and dictionary setting from environment variables.
66-
- Added new flags to import_dashboards (-cacert, -cert, -key, -insecure). {pull}3139[3139] {pull}3163[3163]
67-
- The limit for the number of fields is increased via the mapping template. {pull}3275[3275]
68-
- Updated to Go 1.7.4. {pull}3277[3277]
69-
- Added a NOTICE file containing the notices and licenses of the dependencies. {pull}3334[3334].
56+
7057
- Files created by Beats (logs, registry, file output) will have 0600 permissions. {pull}3387[3387].
7158
- RPM/deb packages will now install the config file with 0600 permissions. {pull}3382[3382]
7259
- Add the option to pass custom HTTP headers to the Elasticsearch output. {pull}3400[3400]
7360
- Unify `regexp` and `contains` conditionals, for both to support array of strings and convert numbers to strings if required. {pull}3469[3469]
7461
- Add the option to load the sample dashboards during the Beat startup phase. {pull}3506[3506]
7562
- Disabled date detection in Elasticsearch index templates. Date fields must be explicitly defined in index templates. {pull}3528[3528]
63+
- Using environment variables in the configuration file is now GA, instead of experimental. {pull}3525[3525]
64+
65+
*Filebeat*
66+
67+
- Add the `pipeline` config option at the prospector level, for configuring the Ingest Node pipeline ID. {pull}3433[3433]
68+
- Update regular expressions used for matching file names or lines (multiline, include/exclude functionality) to new matchers improving performance of simple string matches. {pull}3469[3469]
69+
- The `symlinks` and `harverster_limit` settings are now GA, instead of experimental. {pull}3525[3525]
70+
71+
*Heartbeat*
7672

7773
*Metricbeat*
7874

79-
- Add experimental filebeat metricset in the beats module. {pull}2297[2297]
80-
- Add experimental libbeat metricset in the beats module. {pull}2339[2339]
81-
- Add experimental docker module. Provided by Ingensi and @douaejeouit based on dockbeat.
82-
- Add username and password config options to the MongoDB module. {pull}2889[2889]
83-
- Add username and password config options to the PostgreSQL module. {pull}2889[2890]
84-
- Add system core metricset for Windows. {pull}2883[2883]
85-
- Add a sample Redis Kibana dashboard. {pull}2916[2916]
86-
- Add support for MongoDB 3.4 and WiredTiger metrics. {pull}2999[2999]
87-
- Add experimental kafka module with partition metricset. {pull}2969[2969]
88-
- Add raw config option for mysql/status metricset. {pull}3001[3001]
8975
- Add experimental dbstats metricset to MongoDB module. {pull}3228[3228]
9076
- Use persistent, direct connections to the configured nodes for MongoDB module. {pull}3228[3228]
91-
- Kafka module broker matching enhancements. {pull}3129[3129]
92-
- Add a couchbase module with metricsets for node, cluster and bucket. {pull}3081[3081]
93-
- Export number of cores for cpu module. {pull}3192[3192]
94-
- Experimental Prometheus module. {pull}3202[3202]
95-
- Add system socket module that reports all TCP sockets. {pull}3246[3246]
96-
- Kafka consumer groups metricset. {pull}3240[3240]
9777
- Add dynamic configuration reloading for modules. {pull}3281[3281]
9878
- Add docker health metricset {pull}3357[3357]
9979
- Add docker image metricset {pull}3467[3467]
10080
- System module uses new matchers for white-listing processes. {pull}3469[3469]
101-
- Add CEPH module with health metricset. {pull}3311[3311]
102-
- Add php_fpm module with pool metricset. {pull}3415[3415]
103-
- Add cluster_disk and pool_disk metricsets to CEPH module. {pull}3499[3499]
81+
- Add Beta CEPH module with health metricset. {pull}3311[3311]
82+
- Add Beta php_fpm module with pool metricset. {pull}3415[3415]
83+
- The Docker, Kafka, and Prometheus modules are now Beta, instead of experimental. {pull}3525[3525]
84+
- The HAProxy module is now GA, instead of experimental. {pull}3525[3525]
10485

10586
*Packetbeat*
10687

107-
*Topbeat*
88+
*Winlogbeat*
89+
90+
==== Deprecated
91+
92+
*Affecting all Beats*
93+
94+
- Usage of field _type is deprecated. It should not be used in queries or dashboards. {pull}3409[3409]
10895

10996
*Filebeat*
110-
- Add enabled config option to prospectors. {pull}3157[3157]
111-
- Add target option for decoded_json_field. {pull}3169[3169]
112-
- Add the `pipeline` config option at the prospector level, for configuring the Ingest Node pipeline ID. {pull}3433[3433]
113-
- Update regular expressions used for matching file names or lines (multiline, include/exclude functionality) to new matchers improving performance of simple string matches. {pull}3469[3469]
97+
98+
- The experimental `publish_async` option is now deprecated and is planned to be removed in 6.0. {pull}3525[3525]
99+
100+
*Heartbeat*
101+
102+
*Metricbeat*
103+
104+
*Packetbeat*
114105

115106
*Winlogbeat*
116107

117-
- Reduced amount of memory allocated while reading event log records. {pull}3113[3113] {pull}3118[3113]
108+
////////////////////////////////////////////////////////////
118109
119-
==== Deprecated
110+
[[release-notes-5.2.0]]
111+
=== Beats version 5.2.0
112+
https://github.com/elastic/beats/compare/v5.1.2...v5.2.0[View commits]
113+
114+
==== Bugfixes
120115
121116
*Affecting all Beats*
122-
- Usage of field _type is deprecated. It should not be used in queries or dashboards. {pull}3409[3409]
117+
118+
- Fix overwriting explicit empty config sections. {issue}2918[2918]
119+
120+
*Filebeat*
121+
122+
- Fix alignment issue were Filebeat compiled with Go 1.7.4 was crashing on 32 bits system. {issue}3273[3273]
123123
124124
*Metricbeat*
125125
126+
- Fix service times-out at startup. {pull}3056[3056]
127+
- Kafka module case sensitive host name matching. {pull}3193[3193]
128+
- Fix interface conversion panic in couchbase module {pull}3272[3272]
129+
126130
*Packetbeat*
127131
128-
*Topbeat*
129-
- Fix error on importing dashboards due to colons in the Caassandra dashboard. {issue}3140[3140]
132+
- Fix issue where some Cassandra visualizations were showing data from all protocols. {issue}3314[3314]
133+
134+
==== Added
135+
136+
*Affecting all Beats*
137+
138+
- Add support for passing list and dictionary settings via -E flag.
139+
- Support for parsing list and dictionary setting from environment variables.
140+
- Added new flags to import_dashboards (-cacert, -cert, -key, -insecure). {pull}3139[3139] {pull}3163[3163]
141+
- The limit for the number of fields is increased via the mapping template. {pull}3275[3275]
142+
- Updated to Go 1.7.4. {pull}3277[3277]
143+
- Added a NOTICE file containing the notices and licenses of the dependencies. {pull}3334[3334].
144+
145+
*Heartbeat*
146+
147+
- First release, containing monitors for ICMP, TCP, and HTTP.
130148
131149
*Filebeat*
132150
151+
- Add enabled config option to prospectors. {pull}3157[3157]
152+
- Add target option for decoded_json_field. {pull}3169[3169]
153+
154+
*Metricbeat*
155+
156+
- Kafka module broker matching enhancements. {pull}3129[3129]
157+
- Add a couchbase module with metricsets for node, cluster and bucket. {pull}3081[3081]
158+
- Export number of cores for CPU module. {pull}3192[3192]
159+
- Experimental Prometheus module. {pull}3202[3202]
160+
- Add system socket module that reports all TCP sockets. {pull}3246[3246]
161+
- Kafka consumer groups metricset. {pull}3240[3240]
162+
133163
*Winlogbeat*
134164
135-
////////////////////////////////////////////////////////////
165+
- Reduced amount of memory allocated while reading event log records. {pull}3113[3113] {pull}3118[3118]
166+
167+
[[release-notes-5.1.2]]
168+
=== Beats version 5.1.2
169+
https://github.com/elastic/beats/compare/v5.1.1...v5.1.2[View commits]
170+
171+
==== Bugfixes
172+
173+
*Filebeat*
174+
175+
- Fix registry migration issue from old states where files were only harvested after second restart. {pull}3322[3322]
176+
177+
*Packetbeat*
178+
179+
- Fix error on importing dashboards due to colons in the Cassandra dashboard. {issue}3140[3140]
180+
- Fix error on importing dashboards due to the wrong type for the geo_point fields. {pull}3147[3147]
181+
182+
*Winlogbeat*
183+
184+
- Fix for "The array bounds are invalid" error when reading large events. {issue}3076[3076]
136185
137186
[[release-notes-5.1.1]]
138187
=== Beats version 5.1.1

filebeat/_meta/common.full.p2.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ filebeat.prospectors:
138138
# overwrites the pipeline option from the Elasticsearch output.
139139
#pipeline:
140140

141-
# Experimental: If symlinks is enabled, symlinks are opened and harvested. The harvester is openening the
141+
# If symlinks is enabled, symlinks are opened and harvested. The harvester is openening the
142142
# original for harvesting but will report the symlink name as source.
143143
#symlinks: false
144144

@@ -160,7 +160,7 @@ filebeat.prospectors:
160160
# The backoff value will be multiplied each time with the backoff_factor until max_backoff is reached
161161
#backoff_factor: 2
162162

163-
# Experimental: Max number of harvesters that are started in parallel.
163+
# Max number of harvesters that are started in parallel.
164164
# Default is 0 which means unlimited
165165
#harvester_limit: 0
166166

filebeat/crawler/crawler.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ func (c *Crawler) Start(r *registrar.Registrar, reloaderConfig *common.Config) e
4444
}
4545

4646
if reloaderConfig.Enabled() {
47-
logp.Warn("EXPERIMENTAL feature dynamic configuration reloading is enabled.")
47+
logp.Warn("BETA feature dynamic configuration reloading is enabled.")
4848

4949
c.reloader = cfgfile.NewReloader(reloaderConfig)
5050
factory := prospector.NewFactory(c.out, r)

filebeat/docs/reference/configuration/filebeat-options.asciidoc

+1-4
Original file line numberDiff line numberDiff line change
@@ -415,8 +415,6 @@ NOTE: The pipeline ID can also be configured in the Elasticsearch output, but th
415415

416416
===== symlinks
417417

418-
experimental[]
419-
420418
The `symlinks` option allows Filebeat to harvest symlinks in addition to regular files. When harvesting symlinks, Filebeat opens and reads the original file even though it reports the path of the symlink.
421419

422420
When you configure a symlink for harvesting, make sure the original path is excluded. If a single prospector is configured to harvest both the symlink and the original file, the prospector will detect the problem and only process the first file it finds. However, if two different prospectors are configured (one to read the symlink and the other the original path), both paths will be harvested, causing Filebeat to send duplicate data and the prospectors to overwrite each other's state.
@@ -457,8 +455,6 @@ lines. The `backoff` value will be multiplied each time with the `backoff_factor
457455
[[harvester-limit]]
458456
===== harvester_limit
459457

460-
experimental[]
461-
462458
The `harvester_limit` option limits the number of harvesters that are started in parallel for one prospector. This directly relates
463459
to the maximum number of file handlers that are opened. The default for `harvester_limit` is 0, which means there is no limit. This
464460
configuration is useful if the number of files to be harvested exceeds the open file handler limit of the operating system.
@@ -498,6 +494,7 @@ See <<load-balancing>> for more information about how this setting affects load
498494
===== publish_async
499495

500496
experimental[]
497+
deprecated[5.3.0]
501498

502499
If enabled, the publisher pipeline in Filebeat operates in async mode preparing
503500
a new batch of lines while waiting for ACK. This option can improve load-balancing

filebeat/docs/reference/configuration/reload-configuration.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[[filebeat-configuration-reloading]]
22
=== Reload Configuration
33

4-
experimental[]
4+
beta[]
55

66
Reload configuration allows to dynamically reload prospector configuration files. A glob can be defined which should be watched
77
for prospector configuration changes. New prospectors will be started / stopped accordingly. This is especially useful in

filebeat/filebeat.full.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,7 @@ filebeat.prospectors:
254254
# overwrites the pipeline option from the Elasticsearch output.
255255
#pipeline:
256256

257-
# Experimental: If symlinks is enabled, symlinks are opened and harvested. The harvester is openening the
257+
# If symlinks is enabled, symlinks are opened and harvested. The harvester is openening the
258258
# original for harvesting but will report the symlink name as source.
259259
#symlinks: false
260260

@@ -276,7 +276,7 @@ filebeat.prospectors:
276276
# The backoff value will be multiplied each time with the backoff_factor until max_backoff is reached
277277
#backoff_factor: 2
278278

279-
# Experimental: Max number of harvesters that are started in parallel.
279+
# Max number of harvesters that are started in parallel.
280280
# Default is 0 which means unlimited
281281
#harvester_limit: 0
282282

filebeat/publisher/publisher.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ func New(
3434
pub publisher.Publisher,
3535
) LogPublisher {
3636
if async {
37-
logp.Warn("Using publish_async is experimental!")
37+
logp.Warn("publish_async is experimental and will be removed in a future version!")
3838
return newAsyncLogPublisher(in, out, pub)
3939
}
4040
return newSyncLogPublisher(in, out, pub)

libbeat/docs/shared-env-vars.asciidoc

-2
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@
1212
[[using-environ-vars]]
1313
== Using Environment Variables in the Configuration
1414

15-
experimental[]
16-
1715
You can use environment variable references in the +{beatname_lc}.yml+ file to
1816
set values that need to be configurable during deployment. To do this, use:
1917

0 commit comments

Comments
 (0)