Skip to content

Commit

Permalink
chore(observability, blackhole sink)!: Don't report by default (#18963)
Browse files Browse the repository at this point in the history
* chore(observability, blackhole sink)!: Don't report by default

Users have been suprised by the `blackhole` sink emitting events processed logs at the `info` level
by default. This change changes the default to not report.

Signed-off-by: Jesse Szwedko <jesse.szwedko@datadoghq.com>

* spelling

Signed-off-by: Jesse Szwedko <jesse.szwedko@datadoghq.com>

---------

Signed-off-by: Jesse Szwedko <jesse.szwedko@datadoghq.com>
  • Loading branch information
jszwedko authored Oct 27, 2023
1 parent cf7298f commit 3b85b48
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 4 deletions.
4 changes: 2 additions & 2 deletions src/sinks/blackhole/config.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ use crate::{
};

const fn default_print_interval_secs() -> Duration {
Duration::from_secs(1)
Duration::from_secs(0)
}

/// Configuration for the `blackhole` sink.
Expand All @@ -25,7 +25,7 @@ const fn default_print_interval_secs() -> Duration {
pub struct BlackholeConfig {
/// The interval between reporting a summary of activity.
///
/// Set to `0` to disable reporting.
/// Set to `0` (default) to disable reporting.
#[derivative(Default(value = "default_print_interval_secs()"))]
#[serde(default = "default_print_interval_secs")]
#[serde_as(as = "serde_with::DurationSeconds<u64>")]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Vector's 0.34.0 release includes **breaking changes**:

1. [Removal of Deprecated Datadog Component Config Options](#datadog-deprecated-config-options)
1. [Removal of Deprecated `component_name` Metric Tag](#deprecated-component-name)
1. [Blackhole sink no longer reports by default](#blackhole-sink-reporting)

We cover them below to help you upgrade quickly:

Expand All @@ -31,3 +32,9 @@ been removed from the Enterprise configuration. Instead of `region`, `site` shou
#### Removal of Deprecated `component_name` Metric Tag {#deprecated-component-name}

The deprecated `component_name` tag has been removed from all internal metrics. Instead the `component_id` tag should be used.

#### Blackhole sink no longer reports by default {#blackhole-sink-reporting}

The `blackhole` sink no longer reports events processed every second by default. Instead this
behavior can be opted into by setting `print_interval_secs` to `1` (or any other integer). This
change was made due to users being surprised that this sink generates output by default.
4 changes: 2 additions & 2 deletions website/cue/reference/components/sinks/base/blackhole.cue
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@ base: components: sinks: blackhole: configuration: {
description: """
The interval between reporting a summary of activity.
Set to `0` to disable reporting.
Set to `0` (default) to disable reporting.
"""
required: false
type: uint: {
default: 1
default: 0
examples: [
10,
]
Expand Down

0 comments on commit 3b85b48

Please sign in to comment.