From f89e90a61cfdb394c87c4974bfdd2a5b5c9f3cc3 Mon Sep 17 00:00:00 2001 From: Karen Metts Date: Mon, 2 Nov 2020 16:42:19 -0500 Subject: [PATCH 1/5] Doc: Update links to logstash-to-cloud docs --- docs/index.asciidoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/index.asciidoc b/docs/index.asciidoc index b93f922db..da73cdf7f 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -369,7 +369,7 @@ The .cer or .pem file to validate the server's certificate Cloud authentication string (":" format) is an alternative for the `user`/`password` pair. -For more details, check out the https://www.elastic.co/guide/en/logstash/current/connecting-to-cloud.html#_cloud_auth[Logstash-to-Cloud documentation] +For more details, check out the https://www.elastic.co/guide/en/logstash/current/connecting-to-cloud.html[Logstash-to-Cloud documentation] [id="plugins-{type}s-{plugin}-cloud_id"] ===== `cloud_id` @@ -379,7 +379,7 @@ For more details, check out the https://www.elastic.co/guide/en/logstash/current Cloud ID, from the Elastic Cloud web console. If set `hosts` should not be used. -For more details, check out the https://www.elastic.co/guide/en/logstash/current/connecting-to-cloud.html#_cloud_id[Logstash-to-Cloud documentation] +For more details, check out the https://www.elastic.co/guide/en/logstash/current/connecting-to-cloud.html[Logstash-to-Cloud documentation] [id="plugins-{type}s-{plugin}-doc_as_upsert"] ===== `doc_as_upsert` From 91485d66b374fc86aa4ca6fb669b85e29e85d41a Mon Sep 17 00:00:00 2001 From: Karen Metts Date: Mon, 2 Nov 2020 17:42:05 -0500 Subject: [PATCH 2/5] Bump to v.10.7.2 Fixes: #974 --- CHANGELOG.md | 3 +++ logstash-output-elasticsearch.gemspec | 2 +- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 15bc209e5..91e625ddc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,6 @@ +## 10.7.2 + - [DOC] Fixed links to restructured Logstash-to-cloud docs [#975](https://github.com/logstash-plugins/logstash-output-elasticsearch/pull/975) + ## 10.7.1 - [DOC] Document the permissions required in secured clusters [#969](https://github.com/logstash-plugins/logstash-output-elasticsearch/pull/969) diff --git a/logstash-output-elasticsearch.gemspec b/logstash-output-elasticsearch.gemspec index c103957fb..7b9a259c4 100644 --- a/logstash-output-elasticsearch.gemspec +++ b/logstash-output-elasticsearch.gemspec @@ -1,6 +1,6 @@ Gem::Specification.new do |s| s.name = 'logstash-output-elasticsearch' - s.version = '10.7.1' + s.version = '10.7.2' s.licenses = ['apache-2.0'] s.summary = "Stores logs in Elasticsearch" From 4109cfded2524157fc1604a449f2df7a3e40561b Mon Sep 17 00:00:00 2001 From: Karen Metts Date: Tue, 3 Nov 2020 08:54:20 -0500 Subject: [PATCH 3/5] Add and set branch attribute --- docs/index.asciidoc | 46 ++++++++++++++++++++++++++++----------------- 1 file changed, 29 insertions(+), 17 deletions(-) diff --git a/docs/index.asciidoc b/docs/index.asciidoc index da73cdf7f..434c1347e 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -1,6 +1,7 @@ :plugin: elasticsearch :type: output :no_codec: +:branch: current /////////////////////////////////////////// START - GENERATED VARIABLES, DO NOT EDIT! @@ -29,8 +30,8 @@ This output only speaks the HTTP protocol as it is the preferred protocol for interacting with Elasticsearch. In previous versions it was possible to communicate with Elasticsearch through the transport protocol, which is now reserved for internal cluster communication between nodes -https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-transport.html[communication between nodes]. -Using the https://www.elastic.co/guide/en/elasticsearch/reference/current/java-clients.html[transport protocol] +https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-transport.html[communication between nodes]. +Using the https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/java-clients.html[transport protocol] to communicate with the cluster has been deprecated in Elasticsearch 7.0.0 and will be removed in 8.0.0 @@ -91,7 +92,10 @@ Each Elasticsearch output is a new client connected to the cluster: * it has to initialize the client and connect to Elasticsearch (restart time is longer if you have more clients) * it has an associated connection pool -In order to minimize the number of open connections to Elasticsearch, maximize the bulk size and reduce the number of "small" bulk requests (which could easily fill up the queue), it is usually more efficient to have a single Elasticsearch output. +In order to minimize the number of open connections to Elasticsearch, maximize +the bulk size and reduce the number of "small" bulk requests (which could easily +fill up the queue), it is usually more efficient to have a single Elasticsearch +output. Example: [source,ruby] @@ -103,8 +107,11 @@ Example: **What to do in case there is no field in the event containing the destination index prefix?** -You can use the `mutate` filter and conditionals to add a `[@metadata]` field (see https://www.elastic.co/guide/en/logstash/current/event-dependent-configuration.html#metadata) to set -the destination index for each event. The `[@metadata]` fields will not be sent to Elasticsearch. +You can use the `mutate` filter and conditionals to add a `[@metadata]` field +(see +https://www.elastic.co/guide/en/logstash/{branch}/event-dependent-configuration.html#metadata) +to set the destination index for each event. The `[@metadata]` fields will not +be sent to Elasticsearch. Example: [source,ruby] @@ -224,7 +231,7 @@ enabled by default for HTTP and for Elasticsearch versions 5.0 and later. You don't have to set any configs in Elasticsearch for it to send back a compressed response. For versions before 5.0, or if HTTPS is enabled, `http.compression` must be set to `true` -https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-http.html#modules-http[in +https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-http.html#modules-http[in Elasticsearch] to take advantage of response compression when using this plugin. For requests compression, regardless of the Elasticsearch version, enable the @@ -332,7 +339,7 @@ The Elasticsearch action to perform. Valid actions are: - A sprintf style string to change the action based on the content of the event. The value `%{[foo]}` would use the foo field for the action -For more details on actions, check out the http://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html[Elasticsearch bulk API documentation] +For more details on actions, check out the http://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-bulk.html[Elasticsearch bulk API documentation] [id="plugins-{type}s-{plugin}-api_key"] ===== `api_key` @@ -342,7 +349,7 @@ For more details on actions, check out the http://www.elastic.co/guide/en/elasti Authenticate using Elasticsearch API key. Note that this option also requires enabling the `ssl` option. -Format is `id:api_key` where `id` and `api_key` are as returned by the Elasticsearch https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html[Create API key API]. +Format is `id:api_key` where `id` and `api_key` are as returned by the Elasticsearch https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-create-api-key.html[Create API key API]. [id="plugins-{type}s-{plugin}-bulk_path"] ===== `bulk_path` @@ -369,7 +376,7 @@ The .cer or .pem file to validate the server's certificate Cloud authentication string (":" format) is an alternative for the `user`/`password` pair. -For more details, check out the https://www.elastic.co/guide/en/logstash/current/connecting-to-cloud.html[Logstash-to-Cloud documentation] +For more details, check out the https://www.elastic.co/guide/en/logstash/{branch}/connecting-to-cloud.html[Logstash-to-Cloud documentation] [id="plugins-{type}s-{plugin}-cloud_id"] ===== `cloud_id` @@ -379,7 +386,7 @@ For more details, check out the https://www.elastic.co/guide/en/logstash/current Cloud ID, from the Elastic Cloud web console. If set `hosts` should not be used. -For more details, check out the https://www.elastic.co/guide/en/logstash/current/connecting-to-cloud.html[Logstash-to-Cloud documentation] +For more details, check out the https://www.elastic.co/guide/en/logstash/{branch}/connecting-to-cloud.html[Logstash-to-Cloud documentation] [id="plugins-{type}s-{plugin}-doc_as_upsert"] ===== `doc_as_upsert` @@ -430,7 +437,7 @@ If you don't set a value for this option: ** When Logstash provides a `pipeline.ecs_compatibility` setting, its value is used as the default ** Otherwise, the default value is `disabled`. -Controls this plugin's compatibility with the https://www.elastic.co/guide/en/ecs/current/index.html[Elastic Common Schema (ECS)], +Controls this plugin's compatibility with the https://www.elastic.co/guide/en/ecs/{branch}/index.html[Elastic Common Schema (ECS)], including the installation of ECS-compatible index templates. The value of this setting affects the _default_ values of: @@ -477,7 +484,7 @@ If you have custom firewall rules you may need to change this * Default value is `[//127.0.0.1]` Sets the host(s) of the remote instance. If given an array it will load balance requests across the hosts specified in the `hosts` parameter. -Remember the `http` protocol uses the http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-http.html#modules-http[http] address (eg. 9200, not 9300). +Remember the `http` protocol uses the http://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-http.html#modules-http[http] address (eg. 9200, not 9300). Examples: @@ -487,10 +494,14 @@ Examples: `["https://127.0.0.1:9200"]` `["https://127.0.0.1:9200/mypath"]` (If using a proxy on a subpath) -It is important to exclude http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-node.html[dedicated master nodes] from the `hosts` list -to prevent LS from sending bulk requests to the master nodes. So this parameter should only reference either data or client nodes in Elasticsearch. +Exclude +http://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-node.html[dedicated +master nodes] from the `hosts` list to prevent Logstash from sending bulk +requests to the master nodes. This parameter should reference only data or +client nodes in Elasticsearch. -Any special characters present in the URLs here MUST be URL escaped! This means `#` should be put in as `%23` for instance. +Any special characters present in the URLs here MUST be URL escaped! This means +`#` should be put in as `%23` for instance. [id="plugins-{type}s-{plugin}-http_compression"] ===== `http_compression` @@ -726,7 +737,7 @@ Set max interval in seconds between bulk retries. * Default value is `1` The number of times Elasticsearch should internally retry an update/upserted document -See the https://www.elastic.co/guide/en/elasticsearch/guide/current/partial-updates.html[partial updates] +See the https://www.elastic.co/guide/en/elasticsearch/guide/{branch}/partial-updates.html[partial updates] for more info [id="plugins-{type}s-{plugin}-routing"] @@ -958,11 +969,12 @@ See https://www.elastic.co/blog/elasticsearch-versioning-support. The version_type to use for indexing. See https://www.elastic.co/blog/elasticsearch-versioning-support. -See also https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html#_version_types +See also https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-index_.html#_version_types [id="plugins-{type}s-{plugin}-common-options"] include::{include_path}/{type}.asciidoc[] +:branch!: :no_codec!: From 7d7d24cd66d59410811f7bfd781199dce7958fa9 Mon Sep 17 00:00:00 2001 From: Karen Metts Date: Tue, 3 Nov 2020 15:53:53 -0500 Subject: [PATCH 4/5] Remove old link --- docs/index.asciidoc | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/index.asciidoc b/docs/index.asciidoc index 434c1347e..1888a3968 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -736,9 +736,7 @@ Set max interval in seconds between bulk retries. * Value type is <> * Default value is `1` -The number of times Elasticsearch should internally retry an update/upserted document -See the https://www.elastic.co/guide/en/elasticsearch/guide/{branch}/partial-updates.html[partial updates] -for more info +The number of times Elasticsearch should internally retry an update/upserted document. [id="plugins-{type}s-{plugin}-routing"] ===== `routing` From 0bede23632405052a72e9852402d82e36160252e Mon Sep 17 00:00:00 2001 From: Karen Metts Date: Wed, 4 Nov 2020 19:17:49 -0500 Subject: [PATCH 5/5] Remove branch attribute --- docs/index.asciidoc | 26 ++++++++++++-------------- 1 file changed, 12 insertions(+), 14 deletions(-) diff --git a/docs/index.asciidoc b/docs/index.asciidoc index 1888a3968..8af4a7a46 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -1,7 +1,6 @@ :plugin: elasticsearch :type: output :no_codec: -:branch: current /////////////////////////////////////////// START - GENERATED VARIABLES, DO NOT EDIT! @@ -30,8 +29,8 @@ This output only speaks the HTTP protocol as it is the preferred protocol for interacting with Elasticsearch. In previous versions it was possible to communicate with Elasticsearch through the transport protocol, which is now reserved for internal cluster communication between nodes -https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-transport.html[communication between nodes]. -Using the https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/java-clients.html[transport protocol] +https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-transport.html[communication between nodes]. +Using the https://www.elastic.co/guide/en/elasticsearch/reference/current/java-clients.html[transport protocol] to communicate with the cluster has been deprecated in Elasticsearch 7.0.0 and will be removed in 8.0.0 @@ -109,7 +108,7 @@ Example: You can use the `mutate` filter and conditionals to add a `[@metadata]` field (see -https://www.elastic.co/guide/en/logstash/{branch}/event-dependent-configuration.html#metadata) +https://www.elastic.co/guide/en/logstash/current/event-dependent-configuration.html#metadata) to set the destination index for each event. The `[@metadata]` fields will not be sent to Elasticsearch. @@ -231,7 +230,7 @@ enabled by default for HTTP and for Elasticsearch versions 5.0 and later. You don't have to set any configs in Elasticsearch for it to send back a compressed response. For versions before 5.0, or if HTTPS is enabled, `http.compression` must be set to `true` -https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-http.html#modules-http[in +https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-http.html#modules-http[in Elasticsearch] to take advantage of response compression when using this plugin. For requests compression, regardless of the Elasticsearch version, enable the @@ -339,7 +338,7 @@ The Elasticsearch action to perform. Valid actions are: - A sprintf style string to change the action based on the content of the event. The value `%{[foo]}` would use the foo field for the action -For more details on actions, check out the http://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-bulk.html[Elasticsearch bulk API documentation] +For more details on actions, check out the http://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html[Elasticsearch bulk API documentation] [id="plugins-{type}s-{plugin}-api_key"] ===== `api_key` @@ -349,7 +348,7 @@ For more details on actions, check out the http://www.elastic.co/guide/en/elasti Authenticate using Elasticsearch API key. Note that this option also requires enabling the `ssl` option. -Format is `id:api_key` where `id` and `api_key` are as returned by the Elasticsearch https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-create-api-key.html[Create API key API]. +Format is `id:api_key` where `id` and `api_key` are as returned by the Elasticsearch https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html[Create API key API]. [id="plugins-{type}s-{plugin}-bulk_path"] ===== `bulk_path` @@ -376,7 +375,7 @@ The .cer or .pem file to validate the server's certificate Cloud authentication string (":" format) is an alternative for the `user`/`password` pair. -For more details, check out the https://www.elastic.co/guide/en/logstash/{branch}/connecting-to-cloud.html[Logstash-to-Cloud documentation] +For more details, check out the https://www.elastic.co/guide/en/logstash/current/connecting-to-cloud.html[Logstash-to-Cloud documentation] [id="plugins-{type}s-{plugin}-cloud_id"] ===== `cloud_id` @@ -386,7 +385,7 @@ For more details, check out the https://www.elastic.co/guide/en/logstash/{branch Cloud ID, from the Elastic Cloud web console. If set `hosts` should not be used. -For more details, check out the https://www.elastic.co/guide/en/logstash/{branch}/connecting-to-cloud.html[Logstash-to-Cloud documentation] +For more details, check out the https://www.elastic.co/guide/en/logstash/current/connecting-to-cloud.html[Logstash-to-Cloud documentation] [id="plugins-{type}s-{plugin}-doc_as_upsert"] ===== `doc_as_upsert` @@ -437,7 +436,7 @@ If you don't set a value for this option: ** When Logstash provides a `pipeline.ecs_compatibility` setting, its value is used as the default ** Otherwise, the default value is `disabled`. -Controls this plugin's compatibility with the https://www.elastic.co/guide/en/ecs/{branch}/index.html[Elastic Common Schema (ECS)], +Controls this plugin's compatibility with the https://www.elastic.co/guide/en/ecs/current/index.html[Elastic Common Schema (ECS)], including the installation of ECS-compatible index templates. The value of this setting affects the _default_ values of: @@ -484,7 +483,7 @@ If you have custom firewall rules you may need to change this * Default value is `[//127.0.0.1]` Sets the host(s) of the remote instance. If given an array it will load balance requests across the hosts specified in the `hosts` parameter. -Remember the `http` protocol uses the http://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-http.html#modules-http[http] address (eg. 9200, not 9300). +Remember the `http` protocol uses the http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-http.html#modules-http[http] address (eg. 9200, not 9300). Examples: @@ -495,7 +494,7 @@ Examples: `["https://127.0.0.1:9200/mypath"]` (If using a proxy on a subpath) Exclude -http://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-node.html[dedicated +http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-node.html[dedicated master nodes] from the `hosts` list to prevent Logstash from sending bulk requests to the master nodes. This parameter should reference only data or client nodes in Elasticsearch. @@ -967,12 +966,11 @@ See https://www.elastic.co/blog/elasticsearch-versioning-support. The version_type to use for indexing. See https://www.elastic.co/blog/elasticsearch-versioning-support. -See also https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-index_.html#_version_types +See also https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html#_version_types [id="plugins-{type}s-{plugin}-common-options"] include::{include_path}/{type}.asciidoc[] -:branch!: :no_codec!: