Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

declare deprecation of enterprise search plugin #22

Merged
merged 10 commits into from
Jan 3, 2025
Merged

declare deprecation of enterprise search plugin #22

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
ba1d281
Add deprecation log for App Search and Workplace Search. Both are rem…
kaisecheng Dec 19, 2024
0022d4e
update deprecation log
kaisecheng Dec 19, 2024
6df5ab1
bump version
kaisecheng Dec 19, 2024
e6866ad
change log
kaisecheng Dec 19, 2024
dd1e1ea
add deprecation mixin
kaisecheng Dec 19, 2024
75d57bb
update deprecation log
kaisecheng Dec 19, 2024
90d93ef
Update lib/logstash/outputs/elastic_app_search.rb
kaisecheng Jan 3, 2025
70da350
Update lib/logstash/outputs/elastic_app_search.rb
kaisecheng Jan 3, 2025
ec87d3e
Update lib/logstash/outputs/elastic_app_search.rb
kaisecheng Jan 3, 2025
b296e16
update deprecation log
kaisecheng Jan 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
## 3.0.1
- Add deprecation log for App Search and Workplace Search. Both products are removed from Elastic Stack in version 9 [#22](https://github.com/logstash-plugins/logstash-integration-elastic_enterprise_search/pull/22)

## 3.0.0
- Bumped Enterprise Search clients to version `>= 7.16`, `< 9` [#18](https://github.com/logstash-plugins/logstash-integration-elastic_enterprise_search/pull/18)
- Added support to SSL configurations (`ssl_certificate_authorities`, `ssl_truststore_path`, `ssl_truststore_password`, `ssl_truststore_type`, `ssl_verification_mode`, `ssl_supported_protocols` and `ssl_cipher_suites`)
Expand Down
7 changes: 7 additions & 0 deletions lib/logstash/outputs/elastic_app_search.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# encoding: utf-8
require 'logstash/outputs/base'
require 'logstash/plugin_mixins/deprecation_logger_support'
require 'logstash/plugin_mixins/enterprise_search/ssl_configs'
require 'logstash/plugin_mixins/enterprise_search/client'

Expand Down Expand Up @@ -44,6 +45,12 @@ class LogStash::Outputs::ElasticAppSearch < LogStash::Outputs::Base
ENGINE_WITH_SPRINTF_REGEX = /^.*%\{.+\}.*$/.freeze

def register
log_message = "The App Search product is deprecated and excluded from the version 9 of the Elastic Stack. " +
kaisecheng marked this conversation as resolved.
Show resolved Hide resolved
"This plugin is deprecated and will only receive security updates and critical bug fixes. " +
"We recommend transitioning to our native Elasticsearch tools. " +
kaisecheng marked this conversation as resolved.
Show resolved Hide resolved
"For more details, please visit https://www.elastic.co/guide/en/enterprise-search/current/app-search-workplace-search.html"
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@flexitrev same question here about the link https://www.elastic.co/guide/en/enterprise-search/current/app-search-workplace-search.html
The instruction is a bit vague to me

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I changed the link to the Elasticsearch connector. I think it's better to direct customers to the software they should use rather than another deprecation message.

kaisecheng marked this conversation as resolved.
Show resolved Hide resolved
@deprecation_logger.deprecated log_message
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
@deprecation_logger.deprecated log_message
deprecation_logger.deprecated log_message

Is using an instance variable here an old pattern? https://github.com/logstash-plugins/logstash-mixin-deprecation_logger_support/blob/main/lib/logstash/plugin_mixins/deprecation_logger_support/legacy_init_adapter.rb


@retry_disabled = false
@client = LogStash::PluginMixins::EnterpriseSearch::AppSearch::Client.new(client_options, params: params)
check_connection!
Expand Down
7 changes: 7 additions & 0 deletions lib/logstash/outputs/elastic_workplace_search.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# encoding: utf-8
require 'logstash/outputs/base'
require 'logstash/plugin_mixins/deprecation_logger_support'
require 'logstash/plugin_mixins/enterprise_search/client'
require 'logstash/plugin_mixins/enterprise_search/ssl_configs'

Expand Down Expand Up @@ -43,6 +44,12 @@ class LogStash::Outputs::ElasticWorkplaceSearch < LogStash::Outputs::Base
SOURCE_WITH_SPRINTF_REGEX = /^.*%\{.+\}.*$/.freeze

def register
log_message = "The Workplace Search product is deprecated and excluded from the version 9 of the Elastic Stack. " +
"This plugin is deprecated and will only receive security updates and critical bug fixes. " +
"We recommend transitioning to our native Elasticsearch tools. " +
"For more details, please visit https://www.elastic.co/guide/en/enterprise-search/current/app-search-workplace-search.html"
@deprecation_logger.deprecated log_message
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
@deprecation_logger.deprecated log_message
deprecation_logger.deprecated log_message


@retry_disabled = false
@client = LogStash::PluginMixins::EnterpriseSearch::WorkplaceSearch::Client.new(client_options, params: params)
begin
Expand Down
2 changes: 1 addition & 1 deletion logstash-integration-elastic_enterprise_search.gemspec
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Gem::Specification.new do |s|
s.name = 'logstash-integration-elastic_enterprise_search'
s.version = '3.0.0'
s.version = '3.0.1'
s.licenses = ['Apache-2.0']
s.summary = "Integration with Elastic Enterprise Search - output plugins"
s.description = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline "+
Expand Down