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

chore(observability, blackhole sink)!: Don't report by default #18963

Merged
merged 2 commits into from
Oct 27, 2023
+11 −4
Merged

chore(observability, blackhole sink)!: Don't report by default #18963

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8b6468f
chore(observability, blackhole sink)!: Don't report by default
jszwedko Oct 27, 2023
c0ea983
spelling
jszwedko Oct 27, 2023
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
4 changes: 2 additions & 2 deletions src/sinks/blackhole/config.rs
View file
Open in desktop
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
7 changes: 7 additions & 0 deletions website/content/en/highlights/2023-11-07-0-34-0-upgrade-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@

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 @@
#### 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 suprised that this sink generates output by default.
Fixed Show fixed Hide fixed
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
change was made due to users being suprised that this sink generates output by default.
change was made due to users being surprised that this sink generates output by default.

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks! Fixed in c0ea983

4 changes: 2 additions & 2 deletions website/cue/reference/components/sinks/base/blackhole.cue
View file
Open in desktop
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
Loading