rel: prepare v2.8.4 release (#1382)

## Which problem is this PR solving? - prep 2.8.4 release ## Short description of the changes - run `make all` (we forgot to do this on the 2.8.3-release branch). - update changelog - update release notes
honeycombio · Oct 11, 2024 · 6b10d11 · 6b10d11
1 parent 1d6e2e5
commit 6b10d11
Show file tree

Hide file tree

Showing 9 changed files with 76 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Refinery Changelog
 
+## 2.8.4 2024-10-11
+
+### Fixes
+
+- fix: Switch `collector_collect_loop_duration_ms` metric to be a histogram  (#1381) | [Tyler Helmuth](https://github.com/TylerHelmuth)
+
 ## 2.8.3 2024-10-08
 
 ### Changes 

diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -2,6 +2,11 @@
 
 While [CHANGELOG.md](./CHANGELOG.md) contains detailed documentation and links to all the source code changes in a given release, this document is intended to be aimed at a more comprehensible version of the contents of the release from the point of view of users of Refinery.
 
+## Version 2.8.4
+
+This is a bug fix release and includes the follow change:
+* Changes the new `collector_collect_loop_duration_ms` metric introduced in `v2.8.3` to be a histogram instead of a gauge. This ensures the minimum and maximum values from each interval is recorded. 
+
 ## Version 2.8.3
 
 This is a bug fix release and includes the follow changes+~+:

diff --git a/config.md b/config.md
@@ -1,7 +1,7 @@
 # Honeycomb Refinery Configuration Documentation
 
 This is the documentation for the configuration file for Honeycomb's Refinery.
-It was automatically generated on 2024-09-13 at 18:50:43 UTC.
+It was automatically generated on 2024-10-11 at 15:40:59 UTC.
 
 ## The Config file
 
@@ -982,6 +982,18 @@ This value should be set to a bit less than the normal timeout period for shutti
 - Type: `duration`
 - Default: `15s`
 
+### `HealthCheckTimeout`
+
+HealthCheckTimeout Controls the maximum duration allowed for collection health checks to complete.
+
+The `HealthCheckTimeout` setting specifies the maximum duration allowed for the health checks of the collection subsystems to complete.
+If a subsystem does not respond within this timeout period, it will be marked as unhealthy.
+This timeout value should be set carefully to ensure that transient delays do not lead to unnecessary failure detection while still allowing for timely identification of actual health issues.
+
+- Not eligible for live reload.
+- Type: `duration`
+- Default: `3s`
+
 ## Buffer Sizes
 
 `BufferSizes` contains the settings that are relevant to the sizes of communications buffers.

diff --git a/config_complete.yaml b/config_complete.yaml
@@ -2,7 +2,7 @@
 ## Honeycomb Refinery Configuration ##
 ######################################
 #
-# created on 2024-09-13 at 18:50:42 UTC from ../../config.yaml using a template generated on 2024-09-13 at 18:50:40 UTC
+# created on 2024-10-11 at 15:40:58 UTC from ../../config.yaml using a template generated on 2024-10-11 at 15:40:56 UTC
 
 # This file contains a configuration for the Honeycomb Refinery. It is in YAML
 # format, organized into named groups, each of which contains a set of
@@ -1036,6 +1036,22 @@ Collection:
     ## Eligible for live reload.
     # ShutdownDelay: 15s
 
+    ## HealthCheckTimeout Controls the maximum duration allowed for
+    ## collection health checks to complete.
+    ##
+    ## The `HealthCheckTimeout` setting specifies the maximum duration
+    ## allowed for the health checks of the collection subsystems to
+    ## complete. If a subsystem does not respond within this timeout period,
+    ## it will be marked as unhealthy. This timeout value should be set
+    ## carefully to ensure that transient delays do not lead to unnecessary
+    ## failure detection while still allowing for timely identification of
+    ## actual health issues.
+    ##
+    ## Accepts a duration string with units, like "3s".
+    ## default: 3s
+    ## Not eligible for live reload.
+    # HealthCheckTimeout: 3s
+
 ##################
 ## Buffer Sizes ##
 ##################

diff --git a/refinery_config.md b/refinery_config.md
@@ -967,6 +967,18 @@ This value should be set to a bit less than the normal timeout period for shutti
 - Type: `duration`
 - Default: `15s`
 
+### `HealthCheckTimeout`
+
+`HealthCheckTimeout` Controls the maximum duration allowed for collection health checks to complete.
+
+The `HealthCheckTimeout` setting specifies the maximum duration allowed for the health checks of the collection subsystems to complete.
+If a subsystem does not respond within this timeout period, it will be marked as unhealthy.
+This timeout value should be set carefully to ensure that transient delays do not lead to unnecessary failure detection while still allowing for timely identification of actual health issues.
+
+- Not eligible for live reload.
+- Type: `duration`
+- Default: `3s`
+
 ## Buffer Sizes
 
 `BufferSizes` contains the settings that are relevant to the sizes of communications buffers.

diff --git a/rules.md b/rules.md
@@ -1,7 +1,7 @@
 # Honeycomb Refinery Rules Documentation
 
 This is the documentation for the rules configuration for Honeycomb's Refinery.
-It was automatically generated on 2024-09-03 at 19:48:56 UTC.
+It was automatically generated on 2024-10-11 at 15:41:00 UTC.
 
 ## The Rules file
 

diff --git a/tools/convert/configDataNames.txt b/tools/convert/configDataNames.txt
@@ -1,5 +1,5 @@
 # Names of groups and fields in the new config file format.
-# Automatically generated on 2024-09-03 at 19:48:53 UTC.
+# Automatically generated on 2024-10-11 at 15:40:57 UTC.
 
 General:
   - ConfigurationVersion
@@ -188,6 +188,8 @@ Collection:
 
   - ShutdownDelay
 
+  - HealthCheckTimeout
+
 
 BufferSizes:
   - UpstreamBufferSize

diff --git a/tools/convert/minimal_config.yaml b/tools/convert/minimal_config.yaml
@@ -1,5 +1,5 @@
 # sample uncommented config file containing all possible fields
-# automatically generated on 2024-09-03 at 19:48:53 UTC
+# automatically generated on 2024-10-11 at 15:40:58 UTC
 General:
   ConfigurationVersion: 2
   MinRefineryVersion: "v2.0"
@@ -103,6 +103,7 @@ Collection:
   MaxAlloc: 0
   DisableRedistribution: false
   ShutdownDelay: 15s
+  HealthCheckTimeout: 3s
 BufferSizes:
   UpstreamBufferSize: 10_000
   PeerBufferSize: 100_000

diff --git a/tools/convert/templates/configV2.tmpl b/tools/convert/templates/configV2.tmpl
@@ -2,7 +2,7 @@
 ## Honeycomb Refinery Configuration ##
 ######################################
 #
-# created {{ now }} from {{ .Input }} using a template generated on 2024-09-13 at 18:50:40 UTC
+# created {{ now }} from {{ .Input }} using a template generated on 2024-10-11 at 15:40:56 UTC
 
 # This file contains a configuration for the Honeycomb Refinery. It is in YAML
 # format, organized into named groups, each of which contains a set of
@@ -1031,6 +1031,22 @@ Collection:
     ## Eligible for live reload.
     {{ nonDefaultOnly .Data "ShutdownDelay" "ShutdownDelay" "15s" }}
 
+    ## HealthCheckTimeout Controls the maximum duration allowed for
+    ## collection health checks to complete.
+    ##
+    ## The `HealthCheckTimeout` setting specifies the maximum duration
+    ## allowed for the health checks of the collection subsystems to
+    ## complete. If a subsystem does not respond within this timeout period,
+    ## it will be marked as unhealthy. This timeout value should be set
+    ## carefully to ensure that transient delays do not lead to unnecessary
+    ## failure detection while still allowing for timely identification of
+    ## actual health issues.
+    ##
+    ## Accepts a duration string with units, like "3s".
+    ## default: 3s
+    ## Not eligible for live reload.
+    {{ nonDefaultOnly .Data "HealthCheckTimeout" "HealthCheckTimeout" "3s" }}
+
 ##################
 ## Buffer Sizes ##
 ##################