feat(aws_cloudwatch_logs sink): add configurable log retention #18865

AndrewChubatiuk · 2023-10-17T15:34:34Z

Fixes #12038

netlify · 2023-10-17T15:34:38Z

👷 Deploy request for vector-project pending review.

Name	Link
🔨 Latest commit	`97d882b`

bits-bot · 2023-10-17T15:34:39Z

All committers have signed the CLA.

netlify · 2023-10-17T15:34:40Z

✅ Deploy Preview for vrl-playground canceled.

Name	Link
🔨 Latest commit	`97d882b`
🔍 Latest deploy log	https://app.netlify.com/sites/vrl-playground/deploys/6540f9863a80780008c35ff8

StephenWakely

Nice. I have a couple of queries around CloudwatchFuture. I'm not a massive expert in Cloudwatch, so it's possible they may just arise from my misunderstanding.

As an aside, that future really needs to be rewritten using async/await, but that's probably for another day.

src/sinks/aws_cloudwatch_logs/request.rs

StephenWakely · 2023-10-20T11:06:37Z

src/sinks/aws_cloudwatch_logs/request.rs

+                            self.state =
+                                State::DeleteRetentionPolicy(self.client.delete_retention_policy());


I think it would be better to not delete the retention policy if one has already been specified. This is the current behaviour and people may be surprised if retention policies start being removed.

src/sinks/aws_cloudwatch_logs/request.rs

srstrickland · 2023-10-20T14:53:44Z

src/sinks/aws_cloudwatch_logs/request.rs

+                .limit(1)
+                .log_group_name_prefix(group_name)


Is this sufficient?

cloudwatch has log group x1, vector looking for x, api call returns x1

cloudwatch has log groups x AND x1, vector looking for x, we HOPE it returns x, but feels like we're depending on some implementation detail for this.

added filtering for describe_streams and removed describe_groups since it's not needed anymore

AndrewChubatiuk · 2023-10-31T09:15:45Z

@StephenWakely @srstrickland
already made changes according to your comments. is it good to be merged?

StephenWakely

Thanks. I think there's just one more change that needs to be made and then it's good to go.

Thanks for your patience in dealing with this.

src/sinks/aws_cloudwatch_logs/request.rs

Co-authored-by: Stephen Wakely <stephen@lisp.space>

StephenWakely · 2023-10-31T12:52:24Z

src/sinks/aws_cloudwatch_logs/request.rs

+
+                    info!(message = "Retention policy updated for stream.", name = %self.client.stream_name);
+
+                 self.state = State::CreateStream(self.client.create_log_stream());


This needs formatting.. Nearly there..

@StephenWakely any other changes needed?

StephenWakely · 2023-11-08T14:37:08Z

Ah, we face some clippy errors now.

error: consider choosing a more descriptive name
Error:    --> src/sinks/aws_cloudwatch_logs/request.rs:239:28
    |
239 |                         Ok(__) => {}
    |                            ^^
    |
    = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#just_underscores_and_digits
note: the lint level is defined here
   --> src/lib.rs:7:9
    |
7   | #![deny(warnings)]
    |         ^^^^^^^^
    = note: `#[deny(clippy::just_underscores_and_digits)]` implied by `#[deny(warnings)]`

error: called `filter(..).next()` on an `Iterator`. This is more succinctly expressed by calling `.find(..)` instead
Error:    --> src/sinks/aws_cloudwatch_logs/request.rs:135:43
    |
135 |                       if let Some(stream) = response
    |  ___________________________________________^
136 | |                         .log_streams
137 | |                         .ok_or(CloudwatchError::NoStreamsFound)?
138 | |                         .into_iter()
...   |
141 | |                         })
142 | |                         .next()
    | |_______________________________^
    |
    = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#filter_next
    = note: `#[deny(clippy::filter_next)]` implied by `#[deny(warnings)]`

error: using `clone` on type `i32` which implements the `Copy` trait
Error:    --> src/sinks/aws_cloudwatch_logs/request.rs:343:30
    |
343 |         let retention_days = self.retention_days.clone();
    |                              ^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: try removing the `clone` call: `self.retention_days`
    |
    = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#clone_on_copy
    = note: `#[deny(clippy::clone_on_copy)]` implied by `#[deny(warnings)]`

Can you take a look? You can run cargo vdev check rust to run clippy against the project to check the errors are fixed.

AndrewChubatiuk · 2023-11-08T15:53:48Z

Ah, we face some clippy errors now.

error: consider choosing a more descriptive name
Error:    --> src/sinks/aws_cloudwatch_logs/request.rs:239:28
    |
239 |                         Ok(__) => {}
    |                            ^^
    |
    = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#just_underscores_and_digits
note: the lint level is defined here
   --> src/lib.rs:7:9
    |
7   | #![deny(warnings)]
    |         ^^^^^^^^
    = note: `#[deny(clippy::just_underscores_and_digits)]` implied by `#[deny(warnings)]`

error: called `filter(..).next()` on an `Iterator`. This is more succinctly expressed by calling `.find(..)` instead
Error:    --> src/sinks/aws_cloudwatch_logs/request.rs:135:43
    |
135 |                       if let Some(stream) = response
    |  ___________________________________________^
136 | |                         .log_streams
137 | |                         .ok_or(CloudwatchError::NoStreamsFound)?
138 | |                         .into_iter()
...   |
141 | |                         })
142 | |                         .next()
    | |_______________________________^
    |
    = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#filter_next
    = note: `#[deny(clippy::filter_next)]` implied by `#[deny(warnings)]`

error: using `clone` on type `i32` which implements the `Copy` trait
Error:    --> src/sinks/aws_cloudwatch_logs/request.rs:343:30
    |
343 |         let retention_days = self.retention_days.clone();
    |                              ^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: try removing the `clone` call: `self.retention_days`
    |
    = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#clone_on_copy
    = note: `#[deny(clippy::clone_on_copy)]` implied by `#[deny(warnings)]`

Can you take a look? You can run cargo vdev check rust to run clippy against the project to check the errors are fixed.

done

StephenWakely · 2023-11-08T18:18:11Z

Ok... Hopefully final check. The docs are out of date since we have added a new configuration option. You need to run

make generate-component-docs

and check in the resulting changes.

AndrewChubatiuk · 2023-11-08T21:19:32Z

@StephenWakely
Please check again

buraizu

Thanks, approving with one minor update requested

buraizu · 2023-11-08T22:29:31Z

website/cue/reference/components/sinks/base/aws_cloudwatch_logs.cue

@@ -639,6 +639,20 @@ base: components: sinks: aws_cloudwatch_logs: configuration: {
 			}
 		}
 	}
+	retention: {
+		description: "Retention policy configuration for AWS Cloudwatch Log Group"


Suggested change

description: "Retention policy configuration for AWS Cloudwatch Log Group"

description: "Retention policy configuration for AWS CloudWatch Log Group"

@buraizu done

StephenWakely

Ok. We are getting some document errors now. These errors should have been highlighted when you generated the component docs, but for some reason they weren't.

Thanks for your patience. We really need to improve the process with these checks.

StephenWakely · 2023-11-09T11:15:48Z

src/sinks/aws_cloudwatch_logs/config.rs

+#[derive(Clone, Debug, Default)]
+/// Retention policy configuration for AWS CloudWatch Log Group
+pub struct Retention {
+    #[configurable(derived)]


Suggested change

#[configurable(derived)]

/// Whether or not to set a retention policy when creating a new Log Group.

StephenWakely · 2023-11-09T11:24:40Z

src/sinks/aws_cloudwatch_logs/config.rs

+    #[serde(default)]
+    pub enabled: bool,
+
+    #[configurable(derived)]


Suggested change

#[configurable(derived)]

/// If retention is enabled, the number of days to retain logs for.

StephenWakely · 2023-11-09T11:25:32Z

src/sinks/aws_cloudwatch_logs/config.rs

+        deserialize_with = "retention_days",
+        skip_serializing_if = "crate::serde::skip_serializing_if_default"
+    )]
+    pub days: i32,


Suggested change

pub days: i32,

pub days: u32,

Unfortunately, the docs aren't able to work with i32. u32 should be fine here.

StephenWakely · 2023-11-09T14:13:44Z

Can you also run make generate-component-docs to update the docs with these changes.

AndrewChubatiuk · 2023-11-10T07:12:35Z

Can you also run make generate-component-docs to update the docs with these changes.

done

StephenWakely

Awesome! Thank you very much for seeing this through.

github-actions · 2023-11-10T15:17:22Z

Regression Detector Results

Run ID: f4c49727-8e08-4c97-885b-b1bddc57f5af
Baseline: 473b720
Comparison: 104984f
Total vector CPUs: 7

Explanation

A regression test is an integrated performance test for vector in a repeatable rig, with varying configuration for vector. What follows is a statistical summary of a brief vector run for each configuration across SHAs given above. The goal of these tests are to determine quickly if vector performance is changed and to what degree by a pull request.

Because a target's optimization goal performance in each experiment will vary somewhat each time it is run, we can only estimate mean differences in optimization goal relative to the baseline target. We express these differences as a percentage change relative to the baseline target, denoted "Δ mean %". These estimates are made to a precision that balances accuracy and cost control. We represent this precision as a 90.00% confidence interval denoted "Δ mean % CI": there is a 90.00% chance that the true value of "Δ mean %" is in that interval.

We decide whether a change in performance is a "regression" -- a change worth investigating further -- if both of the following two criteria are true:

The estimated |Δ mean %| ≥ 5.00%. This criterion intends to answer the question "Does the estimated change in mean optimization goal performance have a meaningful impact on your customers?". We assume that when |Δ mean %| < 5.00%, the impact on your customers is not meaningful. We also assume that a performance change in optimization goal is worth investigating whether it is an increase or decrease, so long as the magnitude of the change is sufficiently large.
Zero is not in the 90.00% confidence interval "Δ mean % CI" about "Δ mean %". This statement is equivalent to saying that there is at least a 90.00% chance that the mean difference in optimization goal is not zero. This criterion intends to answer the question, "Is there a statistically significant difference in mean optimization goal performance?". It also means there is no more than a 10.00% chance this criterion reports a statistically significant difference when the true difference in mean optimization goal is zero -- a "false positive". We assume you are willing to accept a 10.00% chance of inaccurately detecting a change in performance when no true difference exists.

The table below, if present, lists those experiments that have experienced a statistically significant change in mean optimization goal performance between baseline and comparison SHAs with 90.00% confidence OR have been detected as newly erratic. Negative values of "Δ mean %" mean that baseline is faster, whereas positive values of "Δ mean %" mean that comparison is faster. Results that do not exhibit more than a ±5.00% change in their mean optimization goal are discarded. An experiment is erratic if its coefficient of variation is greater than 0.1. The abbreviated table will be omitted if no interesting change is observed.

No interesting changes in experiment optimization goals with confidence ≥ 90.00% and |Δ mean %| ≥ 5.00%.

Fine details of change detection per experiment.

experiment	goal	Δ mean %	Δ mean % CI	confidence
otlp_http_to_blackhole	ingress throughput	+4.53	[+4.38, +4.68]	100.00%
socket_to_socket_blackhole	ingress throughput	+3.90	[+3.83, +3.98]	100.00%
fluent_elasticsearch	ingress throughput	+2.63	[+2.18, +3.09]	100.00%
syslog_log2metric_splunk_hec_metrics	ingress throughput	+1.01	[+0.88, +1.14]	100.00%
http_to_http_acks	ingress throughput	+0.74	[-0.57, +2.05]	64.77%
file_to_blackhole	egress throughput	+0.59	[-1.90, +3.07]	30.32%
datadog_agent_remap_datadog_logs	ingress throughput	+0.56	[+0.47, +0.66]	100.00%
syslog_loki	ingress throughput	+0.52	[+0.50, +0.55]	100.00%
http_text_to_http_json	ingress throughput	+0.23	[+0.12, +0.33]	99.93%
syslog_humio_logs	ingress throughput	+0.21	[+0.13, +0.29]	100.00%
syslog_regex_logs2metric_ddmetrics	ingress throughput	+0.12	[+0.03, +0.22]	97.45%
http_to_http_noack	ingress throughput	+0.09	[-0.01, +0.20]	84.56%
http_to_http_json	ingress throughput	+0.04	[-0.04, +0.11]	59.71%
splunk_hec_indexer_ack_blackhole	ingress throughput	+0.00	[-0.14, +0.14]	1.08%
splunk_hec_to_splunk_hec_logs_acks	ingress throughput	-0.00	[-0.14, +0.14]	2.11%
splunk_hec_to_splunk_hec_logs_noack	ingress throughput	-0.02	[-0.13, +0.10]	20.31%
datadog_agent_remap_datadog_logs_acks	ingress throughput	-0.06	[-0.13, +0.02]	78.94%
syslog_splunk_hec_logs	ingress throughput	-0.07	[-0.12, -0.02]	97.14%
http_to_s3	ingress throughput	-0.07	[-0.34, +0.20]	34.21%
enterprise_http_to_http	ingress throughput	-0.09	[-0.18, -0.00]	90.82%
otlp_grpc_to_blackhole	ingress throughput	-0.14	[-0.24, -0.04]	97.90%
splunk_hec_route_s3	ingress throughput	-0.20	[-0.71, +0.31]	48.49%
datadog_agent_remap_blackhole	ingress throughput	-0.26	[-0.34, -0.17]	100.00%
datadog_agent_remap_blackhole_acks	ingress throughput	-0.98	[-1.07, -0.90]	100.00%
syslog_log2metric_humio_metrics	ingress throughput	-1.09	[-1.17, -1.01]	100.00%

…rdotdev#18865) * enable cloudwatch logs sink retention * MR comments Co-authored-by: Stephen Wakely <stephen@lisp.space> * make fmt * fixed warnings * generated docs * pr comments * pr comments * generated docs --------- Co-authored-by: Stephen Wakely <stephen@lisp.space>

noamcohen97 · 2024-01-07T17:40:08Z

When is this supposed to be released?

StephenWakely · 2024-01-08T10:42:15Z

When is this supposed to be released?

We are aiming to release v0.35 later today (8th Jan) which will include this change.

…rdotdev#18865) * enable cloudwatch logs sink retention * MR comments Co-authored-by: Stephen Wakely <stephen@lisp.space> * make fmt * fixed warnings * generated docs * pr comments * pr comments * generated docs --------- Co-authored-by: Stephen Wakely <stephen@lisp.space>

AndrewChubatiuk requested a review from a team October 17, 2023 15:34

github-actions bot added the domain: sinks Anything related to the Vector's sinks label Oct 17, 2023

AndrewChubatiuk mentioned this pull request Oct 17, 2023

feat(aws_cloudwatch_logs): Add retention policy for cloudwatch logs sink #15955

Closed

AndrewChubatiuk force-pushed the cloudwatch-logs-retention branch from 21d9a58 to f8cdef9 Compare October 17, 2023 15:53

neuronull changed the title ~~enable cloudwatch logs sink retention~~ feat(aws_cloudwatch_logs sink): add configurable log retention Oct 17, 2023

neuronull added the sink: aws_cloudwatch_logs Anything `aws_cloudwatch_logs` sink related label Oct 17, 2023

StephenWakely requested changes Oct 20, 2023

View reviewed changes

srstrickland reviewed Oct 20, 2023

View reviewed changes

AndrewChubatiuk force-pushed the cloudwatch-logs-retention branch from 33da68f to f637e89 Compare October 20, 2023 16:10

enable cloudwatch logs sink retention

f649cf9

AndrewChubatiuk force-pushed the cloudwatch-logs-retention branch from f637e89 to f649cf9 Compare October 20, 2023 16:26

StephenWakely requested changes Oct 31, 2023

View reviewed changes

src/sinks/aws_cloudwatch_logs/request.rs Outdated Show resolved Hide resolved

MR comments

6409fbf

Co-authored-by: Stephen Wakely <stephen@lisp.space>

StephenWakely requested changes Oct 31, 2023

View reviewed changes

make fmt

97d882b

fixed warnings

3dd5aff

generated docs

63eccf9

AndrewChubatiuk requested review from a team as code owners November 8, 2023 21:17

github-actions bot added the domain: external docs Anything related to Vector's external, public documentation label Nov 8, 2023

buraizu approved these changes Nov 8, 2023

View reviewed changes

pr comments

8853c58

StephenWakely requested changes Nov 9, 2023

View reviewed changes

pr comments

54b9fc8

generated docs

8371b1d

StephenWakely approved these changes Nov 10, 2023

View reviewed changes

StephenWakely added this pull request to the merge queue Nov 10, 2023

Merged via the queue into vectordotdev:master with commit 104984f Nov 10, 2023
38 checks passed

AndrewChubatiuk deleted the cloudwatch-logs-retention branch November 10, 2023 15:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(aws_cloudwatch_logs sink): add configurable log retention #18865

feat(aws_cloudwatch_logs sink): add configurable log retention #18865

AndrewChubatiuk commented Oct 17, 2023

netlify bot commented Oct 17, 2023 •

edited

Loading

bits-bot commented Oct 17, 2023 •

edited

Loading

netlify bot commented Oct 17, 2023 •

edited

Loading

StephenWakely left a comment

StephenWakely Oct 20, 2023

AndrewChubatiuk Oct 20, 2023

srstrickland Oct 20, 2023

AndrewChubatiuk Oct 20, 2023 •

edited

Loading

AndrewChubatiuk commented Oct 31, 2023

StephenWakely left a comment

StephenWakely Oct 31, 2023

AndrewChubatiuk Oct 31, 2023

AndrewChubatiuk Nov 8, 2023

StephenWakely commented Nov 8, 2023

AndrewChubatiuk commented Nov 8, 2023

StephenWakely commented Nov 8, 2023

AndrewChubatiuk commented Nov 8, 2023

buraizu left a comment

buraizu Nov 8, 2023

AndrewChubatiuk Nov 8, 2023

StephenWakely left a comment

StephenWakely Nov 9, 2023

StephenWakely Nov 9, 2023

StephenWakely Nov 9, 2023

AndrewChubatiuk Nov 9, 2023

StephenWakely commented Nov 9, 2023

AndrewChubatiuk commented Nov 10, 2023

StephenWakely left a comment

github-actions bot commented Nov 10, 2023

noamcohen97 commented Jan 7, 2024

StephenWakely commented Jan 8, 2024

		self.state =
		State::DeleteRetentionPolicy(self.client.delete_retention_policy());


		info!(message = "Retention policy updated for stream.", name = %self.client.stream_name);

		self.state = State::CreateStream(self.client.create_log_stream());

	description: "Retention policy configuration for AWS Cloudwatch Log Group"
	description: "Retention policy configuration for AWS CloudWatch Log Group"

	#[configurable(derived)]
	/// Whether or not to set a retention policy when creating a new Log Group.

	#[configurable(derived)]
	/// If retention is enabled, the number of days to retain logs for.

feat(aws_cloudwatch_logs sink): add configurable log retention #18865

feat(aws_cloudwatch_logs sink): add configurable log retention #18865

Conversation

AndrewChubatiuk commented Oct 17, 2023

netlify bot commented Oct 17, 2023 • edited Loading

👷 Deploy request for vector-project pending review.

bits-bot commented Oct 17, 2023 • edited Loading

netlify bot commented Oct 17, 2023 • edited Loading

✅ Deploy Preview for vrl-playground canceled.

StephenWakely left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AndrewChubatiuk Oct 20, 2023 • edited Loading

Choose a reason for hiding this comment

AndrewChubatiuk commented Oct 31, 2023

StephenWakely left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

StephenWakely commented Nov 8, 2023

AndrewChubatiuk commented Nov 8, 2023

StephenWakely commented Nov 8, 2023

AndrewChubatiuk commented Nov 8, 2023

buraizu left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

StephenWakely left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

StephenWakely commented Nov 9, 2023

AndrewChubatiuk commented Nov 10, 2023

StephenWakely left a comment

Choose a reason for hiding this comment

github-actions bot commented Nov 10, 2023

Regression Detector Results

noamcohen97 commented Jan 7, 2024

StephenWakely commented Jan 8, 2024

netlify bot commented Oct 17, 2023 •

edited

Loading

bits-bot commented Oct 17, 2023 •

edited

Loading

netlify bot commented Oct 17, 2023 •

edited

Loading

AndrewChubatiuk Oct 20, 2023 •

edited

Loading