AMLII-1647 Added duration to Flare's stream-logs

[DDuongNguyen]

What does this PR do?

This PR adjusts the --with-stream-logs flag from a bool to duration so that it would accept a duration and attach a stream-logs for that duration to the flare

Motivation

The motivation behind this change is to provide users with more flexibility when using the flare command. By allowing users to adjust the duration of the the stream log output, they can easily save troubleshoot or send it to our support for troubleshooting

Additional Notes

Describe how to test/QA your changes

• Run:

datad-agent flare -L 10s 

or

datad-agent flare --with-stream-logs 10s

Check to see if negative number also throw errors:

datad-agent flare -L -10s 

Logs should be output in the same agent log directory

and attached to the flare

[pr-commenter]

Test changes on VM

Use this command from test-infra-definitions to manually test this PR changes on a VM:

inv create-vm --pipeline-id=34386821 --os-family=ubuntu

[pr-commenter]

Regression Detector

Regression Detector Results

Run ID: a886d37e-83ae-489c-a28b-8f6c6b466ba1
Baseline: 1f10c8a
Comparison: 15aa9b1

Performance changes are noted in the perf column of each table:

• ✅ = significantly better comparison variant performance
• ❌ = significantly worse comparison variant performance
• ➖ = no significant change in performance

No significant changes in experiment optimization goals

Confidence level: 90.00%
Effect size tolerance: |Δ mean %| ≥ 5.00%

There were no significant changes in experiment optimization goals at this confidence level and effect size tolerance.

Experiments ignored for regressions

Regressions in experiments with settings containing erratic: true are ignored.

perf	experiment	goal	Δ mean %	Δ mean % CI
✅	file_to_blackhole	% cpu utilization	-32.62	[-36.89, -28.36]

Fine details of change detection per experiment

perf	experiment	goal	Δ mean %	Δ mean % CI
➖	pycheck_1000_100byte_tags	% cpu utilization	+3.11	[-1.60, +7.81]
➖	process_agent_real_time_mode	memory utilization	+0.97	[+0.93, +1.01]
➖	tcp_syslog_to_blackhole	ingress throughput	+0.78	[-20.50, +22.07]
➖	process_agent_standard_check	memory utilization	+0.49	[+0.44, +0.54]
➖	idle	memory utilization	+0.45	[+0.41, +0.49]
➖	file_tree	memory utilization	+0.30	[+0.22, +0.38]
➖	process_agent_standard_check_with_stats	memory utilization	+0.20	[+0.16, +0.24]
➖	tcp_dd_logs_filter_exclude	ingress throughput	+0.01	[-0.02, +0.04]
➖	trace_agent_json	ingress throughput	-0.00	[-0.01, +0.01]
➖	trace_agent_msgpack	ingress throughput	-0.00	[-0.00, +0.00]
➖	uds_dogstatsd_to_api	ingress throughput	-0.01	[-0.21, +0.20]
➖	otel_to_otel_logs	ingress throughput	-0.02	[-0.37, +0.34]
➖	uds_dogstatsd_to_api_cpu	% cpu utilization	-0.16	[-3.02, +2.70]
➖	basic_py_check	% cpu utilization	-0.38	[-2.84, +2.08]
✅	file_to_blackhole	% cpu utilization	-32.62	[-36.89, -28.36]

Explanation

A regression test is an A/B test of target performance in a repeatable rig, where "performance" is measured as "comparison variant minus baseline variant" for an optimization goal (e.g., ingress throughput). Due to intrinsic variability in measuring that goal, we can only estimate its mean value for each experiment; we report uncertainty in that value as a 90.00% confidence interval denoted "Δ mean % CI".

For each experiment, we decide whether a change in performance is a "regression" -- a change worth investigating further -- if all of the following criteria are true:

1. Its estimated |Δ mean %| ≥ 5.00%, indicating the change is big enough to merit a closer look.

2. Its 90.00% confidence interval "Δ mean % CI" does not contain zero, indicating that if our statistical model is accurate, there is at least a 90.00% chance there is a difference in performance between baseline and comparison variants.

3. Its configuration does not mark it "erratic".

[gh123man]

One small suggestion.
Also may want to update the QA steps - I think the QA steps will produce the error case since --with-stream-logs is not also set with --stream-logs-duration?

Would be good to add QA steps for both cases

[sgnn7]

Tiny nit around long description (+ same comment as @gh123man around duration comparison)

[DDuongNguyen]

/merge

[dd-devflow]

🚂 MergeQueue

Pull request added to the queue.

There are 2 builds ahead! (estimated merge in less than 1h)

Use /merge -c to cancel this operation!