Obsolete PQ setting queue.checkpoint.interval (elastic#17759)

`queue.checkpoint.interval` has never been implemented.
This commit adds warning message when it is used and cleans up references.

Author: kaisecheng

config/logstash.yml

@@ -223,10 +223,6 @@
 #
 # queue.checkpoint.writes: 1024
 #
-# If using queue.type: persisted, the interval in milliseconds when a checkpoint is forced on the head page
-# Default is 1000, 0 for no periodic checkpoint.
-#
-# queue.checkpoint.interval: 1000
 #
 # ------------ Dead-Letter Queue Settings --------------
 # Flag to turn on dead-letter queue.

config/pipelines.yml

@@ -68,10 +68,6 @@
 #   # Default is 1024, 0 for unlimited
 #   queue.checkpoint.writes: 1024
 #
-#   # If using queue.type: persisted, the interval in milliseconds when a checkpoint is forced on the head page
-#   # Default is 1000, 0 for no periodic checkpoint.
-#   queue.checkpoint.interval: 1000
-#
 #   # Enable Dead Letter Queueing for this pipeline.
 #   dead_letter_queue.enable: false
 #

docker/data/logstash/env2yaml/env2yaml.go

@@ -57,7 +57,7 @@ var validSettings = []string{
 	"queue.max_bytes",
 	"queue.checkpoint.acks",
 	"queue.checkpoint.writes",
-	"queue.checkpoint.interval",
+	"queue.checkpoint.interval", // remove it for #17155
 	"queue.drain",
 	"dead_letter_queue.enable",
 	"dead_letter_queue.max_bytes",

docs/reference/persistent-queues.md

@@ -82,9 +82,6 @@ If you want to define values for a specific pipeline, use [`pipelines.yml`](/ref
     To avoid losing data in the persistent queue, you can set `queue.checkpoint.writes: 1` to force a checkpoint after each event is written. Keep in mind that disk writes have a resource cost. Setting this value to `1` ensures maximum durability, but can severely impact performance. See [Controlling durability](#durability-persistent-queues) to better understand the trade-offs.
 
 
-`queue.checkpoint.interval`
-:   Sets the interval in milliseconds when a checkpoint is forced on the head page. Default is `1000`. Set to `0` to eliminate periodic checkpoints.
-
 
 ## Configuration notes [pq-config-notes]
 

logstash-core/lib/logstash/environment.rb

@@ -89,7 +89,7 @@ module Environment
            Setting::SettingNumeric.new("queue.max_events", 0), # 0 is unlimited
            Setting::SettingNumeric.new("queue.checkpoint.acks", 1024), # 0 is unlimited
            Setting::SettingNumeric.new("queue.checkpoint.writes", 1024), # 0 is unlimited
-           Setting::SettingNumeric.new("queue.checkpoint.interval", 1000), # 0 is no time-based checkpointing
+           Setting::SettingNumeric.new("queue.checkpoint.interval", 1000), # remove it for #17155
            Setting::Boolean.new("queue.checkpoint.retry", true),
            Setting::Boolean.new("dead_letter_queue.enable", false),
              Setting::Bytes.new("dead_letter_queue.max_bytes", "1024mb"),

logstash-core/lib/logstash/runner.rb

@@ -270,6 +270,9 @@ def execute
       configure_pipeline_buffer_type
     end
 
+    deprecation_logger.deprecated "The setting `queue.checkpoint.interval` has no effect and will be removed from both " +
+          "logstash.yml and pipeline.yml in a future release." if @settings.set?("queue.checkpoint.interval")
+
     while (msg = LogStash::DeprecationMessage.instance.shift)
       deprecation_logger.deprecated msg
     end

logstash-core/lib/logstash/settings.rb

@@ -66,7 +66,7 @@ def self.included(base)
       "pipeline.ordered",
       "pipeline.ecs_compatibility",
       "queue.checkpoint.acks",
-      "queue.checkpoint.interval",
+      "queue.checkpoint.interval", # remove it for #17155
       "queue.checkpoint.writes",
       "queue.checkpoint.retry",
       "queue.drain",

logstash-core/spec/logstash/acked_queue_concurrent_stress_spec.rb

@@ -29,7 +29,7 @@
     let(:reject_memo_keys) { [:reject_memo_keys, :path, :queue, :writer_threads, :collector, :metric, :reader_threads, :output_strings] }
 
     let(:queue) do
-      described_class.new(path, page_capacity, 0, queue_checkpoint_acks, queue_checkpoint_writes, queue_checkpoint_interval, false, queue_capacity)
+      described_class.new(path, page_capacity, 0, queue_checkpoint_acks, queue_checkpoint_writes, false, queue_capacity)
     end
 
     let(:writer_threads) do
@@ -138,7 +138,6 @@ def publisher(items, writer)
     let(:queue_capacity_multiplier) { 128 }
     let(:queue_checkpoint_acks) { 1024 }
     let(:queue_checkpoint_writes) { 1024 }
-    let(:queue_checkpoint_interval) { 1000 }
     let(:batch_size) { 500 }
     let(:batch_wait) { 1000 }
     let(:expected_count) { 60000 }
@@ -180,12 +179,12 @@ def publisher(items, writer)
       end
 
       context "> larger checkpoint interval <" do
-        let(:queue_checkpoint_interval) { 3000 }
+        
         it_behaves_like "a well behaved queue"
       end
 
       context "> smaller checkpoint interval <" do
-        let(:queue_checkpoint_interval) { 500 }
+        
         it_behaves_like "a well behaved queue"
       end
 
@@ -256,12 +255,12 @@ def publisher(items, writer)
       end
 
       context "> larger checkpoint interval <" do
-        let(:queue_checkpoint_interval) { 3000 }
+        
         it_behaves_like "a well behaved queue"
       end
 
       context "> smaller checkpoint interval <" do
-        let(:queue_checkpoint_interval) { 500 }
+        
         it_behaves_like "a well behaved queue"
       end
 

logstash-core/spec/logstash/instrument/wrapped_write_client_spec.rb

@@ -125,7 +125,7 @@ def threaded_read_client
 
   context "WrappedAckedQueue" do
     let(:path) { Stud::Temporary.directory }
-    let(:queue) { LogStash::WrappedAckedQueue.new(path, 1024, 10, 1024, 1024, 1024, false, 4096) }
+    let(:queue) { LogStash::WrappedAckedQueue.new(path, 1024, 10, 1024, 1024, false, 4096) }
 
     before do
       read_client.set_events_metric(metric.namespace([:stats, :events]))

logstash-core/spec/logstash/queue_factory_spec.rb

@@ -29,7 +29,6 @@
       LogStash::Setting::SettingNumeric.new("queue.max_events", 0),
       LogStash::Setting::SettingNumeric.new("queue.checkpoint.acks", 1024),
       LogStash::Setting::SettingNumeric.new("queue.checkpoint.writes", 1024),
-      LogStash::Setting::SettingNumeric.new("queue.checkpoint.interval", 1000),
       LogStash::Setting::Boolean.new("queue.checkpoint.retry", false),
       LogStash::Setting::SettingString.new("pipeline.id", pipeline_id),
       LogStash::Setting::PositiveInteger.new("pipeline.batch.size", 125),