[Cloud Run Jobs] Enhanced Metrics by nhulston · Pull Request #39246 · DataDog/datadog-agent

nhulston · 2025-07-24T16:39:51Z

What does this PR do?

Fix flushing enhanced metrics at the end of a Cloud Run Job. The container shuts down immediately after execution is done, so we need to force flush dogstatsd
Rename Cloud Run Jobs start+end metrics to gcp.run.job.enhanced.task.started and gcp.run.job.enhanced.task.ended to clarify that each metric is per task, not per execution. And better align with the naming convention set by Step Functions
Add a gcp.run.job.enhanced.task.duration metric in unit milliseconds
Due to cyclic imports, I had to do some refactoring. I removed the originToMetricSource() method and instead, each cloudservice implements a GetSource() method
I added default descriptions and units for these metrics: https://github.com/DataDog/integrations-internal-core/pull/1926

Motivation

Better enhanced metrics for Cloud Run Jobs

Describe how you validated your changes

Tested manually and verified that all metrics are delivered with the correct values and tags.

Possible Drawbacks / Trade-offs

Additional Notes

nhulston · 2025-07-24T16:46:19Z

 func (d *ServerlessDemultiplexer) ForceFlushToSerializer(start time.Time, waitForSerializer bool) {
-	d.forceFlushToSerializer(start, waitForSerializer, false)
+	_, forceFlushAll := os.LookupEnv(cloudservice.CloudRunJobNameEnvVar)
+	d.forceFlushToSerializer(start, waitForSerializer, forceFlushAll)
 }


This is not optimal, but I can't think of any other way to do this. Unless we modify ForceFlushToSerializer in the Demultiplexer interface, which affects the entire agent, not just serverless

Update: I also tried enabling dogstatsd_flush_incomplete_buckets, but that did not solve the problem

cit-pr-commenter · 2025-07-24T18:07:10Z

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 7f63181e-0c4f-41ec-9798-3656781a7f5e

Baseline: 22d66d9
Comparison: 5c4d05b
Diff

Optimization Goals: ✅ No significant changes detected

Experiments ignored for regressions

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

perf	experiment	goal	Δ mean %	Δ mean % CI	trials	links
➖	docker_containers_cpu	% cpu utilization	+4.58	[+1.42, +7.73]	1	Logs

Fine details of change detection per experiment

perf	experiment	goal	Δ mean %	Δ mean % CI	trials	links
➖	docker_containers_cpu	% cpu utilization	+4.58	[+1.42, +7.73]	1	Logs
➖	docker_containers_memory	memory utilization	+0.42	[+0.38, +0.47]	1	Logs
➖	tcp_syslog_to_blackhole	ingress throughput	+0.29	[+0.22, +0.36]	1	Logs
➖	otlp_ingest_metrics	memory utilization	+0.29	[+0.15, +0.43]	1	Logs
➖	ddot_logs	memory utilization	+0.28	[+0.19, +0.38]	1	Logs
➖	file_tree	memory utilization	+0.18	[+0.14, +0.22]	1	Logs
➖	file_to_blackhole_0ms_latency	egress throughput	+0.06	[-0.53, +0.65]	1	Logs
➖	file_to_blackhole_1000ms_latency	egress throughput	+0.05	[-0.55, +0.65]	1	Logs
➖	quality_gate_idle_all_features	memory utilization	+0.05	[-0.01, +0.10]	1	Logs bounds checks dashboard
➖	quality_gate_idle	memory utilization	+0.02	[-0.02, +0.05]	1	Logs bounds checks dashboard
➖	uds_dogstatsd_to_api	ingress throughput	+0.01	[-0.32, +0.33]	1	Logs
➖	tcp_dd_logs_filter_exclude	ingress throughput	+0.00	[-0.02, +0.02]	1	Logs
➖	file_to_blackhole_500ms_latency	egress throughput	-0.01	[-0.57, +0.55]	1	Logs
➖	file_to_blackhole_100ms_latency	egress throughput	-0.04	[-0.69, +0.61]	1	Logs
➖	otlp_ingest_logs	memory utilization	-0.10	[-0.23, +0.02]	1	Logs
➖	quality_gate_logs	% cpu utilization	-0.13	[-2.88, +2.63]	1	Logs bounds checks dashboard
➖	ddot_metrics	memory utilization	-0.24	[-0.36, -0.12]	1	Logs
➖	uds_dogstatsd_20mb_12k_contexts_20_senders	memory utilization	-0.58	[-0.62, -0.54]	1	Logs
➖	quality_gate_metrics_logs	memory utilization	-1.47	[-1.86, -1.08]	1	Logs bounds checks dashboard

Bounds Checks: ✅ Passed

perf	experiment	bounds_check_name	replicates_passed	links
✅	docker_containers_cpu	simple_check_run	10/10
✅	docker_containers_memory	memory_usage	10/10
✅	docker_containers_memory	simple_check_run	10/10
✅	file_to_blackhole_0ms_latency	lost_bytes	10/10
✅	file_to_blackhole_0ms_latency	memory_usage	10/10
✅	file_to_blackhole_1000ms_latency	memory_usage	10/10
✅	file_to_blackhole_100ms_latency	lost_bytes	10/10
✅	file_to_blackhole_100ms_latency	memory_usage	10/10
✅	file_to_blackhole_500ms_latency	lost_bytes	10/10
✅	file_to_blackhole_500ms_latency	memory_usage	10/10
✅	quality_gate_idle	intake_connections	10/10	bounds checks dashboard
✅	quality_gate_idle	memory_usage	10/10	bounds checks dashboard
✅	quality_gate_idle_all_features	intake_connections	10/10	bounds checks dashboard
✅	quality_gate_idle_all_features	memory_usage	10/10	bounds checks dashboard
✅	quality_gate_logs	intake_connections	10/10	bounds checks dashboard
✅	quality_gate_logs	lost_bytes	10/10	bounds checks dashboard
✅	quality_gate_logs	memory_usage	10/10	bounds checks dashboard
✅	quality_gate_metrics_logs	cpu_usage	10/10	bounds checks dashboard
✅	quality_gate_metrics_logs	intake_connections	10/10	bounds checks dashboard
✅	quality_gate_metrics_logs	lost_bytes	10/10	bounds checks dashboard
✅	quality_gate_metrics_logs	memory_usage	10/10	bounds checks dashboard

Explanation

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

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

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:

Its estimated |Δ mean %| ≥ 5.00%, indicating the change is big enough to merit a closer look.
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.
Its configuration does not mark it "erratic".

CI Pass/Fail Decision

✅ Passed. All Quality Gates passed.

quality_gate_idle, bounds check intake_connections: 10/10 replicas passed. Gate passed.
quality_gate_idle, bounds check memory_usage: 10/10 replicas passed. Gate passed.
quality_gate_idle_all_features, bounds check intake_connections: 10/10 replicas passed. Gate passed.
quality_gate_idle_all_features, bounds check memory_usage: 10/10 replicas passed. Gate passed.
quality_gate_metrics_logs, bounds check cpu_usage: 10/10 replicas passed. Gate passed.
quality_gate_metrics_logs, bounds check lost_bytes: 10/10 replicas passed. Gate passed.
quality_gate_metrics_logs, bounds check memory_usage: 10/10 replicas passed. Gate passed.
quality_gate_metrics_logs, bounds check intake_connections: 10/10 replicas passed. Gate passed.
quality_gate_logs, bounds check memory_usage: 10/10 replicas passed. Gate passed.
quality_gate_logs, bounds check lost_bytes: 10/10 replicas passed. Gate passed.
quality_gate_logs, bounds check intake_connections: 10/10 replicas passed. Gate passed.

agent-platform-auto-pr · 2025-07-24T18:20:31Z

Static quality checks

✅ Please find below the results from static quality gates
Comparison made with ancestor 22d66d9

Successful checks

Info

	Quality gate	Delta	On disk size (MiB)	Delta	On wire size (MiB)
✅	agent_deb_amd64	$${0}$$	$${699.53}$$ < $${704.84}$$	$${-0.02}$$	$${177.12}$$ < $${178.58}$$
✅	agent_deb_amd64_fips	$${0}$$	$${697.78}$$ < $${703.09}$$	$${-0.03}$$	$${176.54}$$ < $${178.12}$$
✅	agent_heroku_amd64	$${0}$$	$${349.7}$$ < $${355.37}$$	$${-0.01}$$	$${93.79}$$ < $${95.72}$$
✅	agent_msi	$${+0}$$	$${974.43}$$ < $${979.61}$$	$${-0.03}$$	$${147.61}$$ < $${149.31}$$
✅	agent_rpm_amd64	$${0}$$	$${699.52}$$ < $${704.83}$$	$${+0.02}$$	$${178.75}$$ < $${180.22}$$
✅	agent_rpm_amd64_fips	$${0}$$	$${697.77}$$ < $${703.08}$$	$${-0.01}$$	$${178.42}$$ < $${179.85}$$
✅	agent_rpm_arm64	$${0}$$	$${688.5}$$ < $${694.74}$$	$${+0.01}$$	$${161.81}$$ < $${163.96}$$
✅	agent_rpm_arm64_fips	$${0}$$	$${686.81}$$ < $${693.05}$$	$${+0.02}$$	$${160.86}$$ < $${163.0}$$
✅	agent_suse_amd64	$${0}$$	$${699.52}$$ < $${704.83}$$	$${+0.02}$$	$${178.75}$$ < $${180.22}$$
✅	agent_suse_amd64_fips	$${0}$$	$${697.77}$$ < $${703.08}$$	$${-0.01}$$	$${178.42}$$ < $${179.85}$$
✅	agent_suse_arm64	$${0}$$	$${688.5}$$ < $${694.74}$$	$${+0.01}$$	$${161.81}$$ < $${163.96}$$
✅	agent_suse_arm64_fips	$${0}$$	$${686.81}$$ < $${693.05}$$	$${+0.02}$$	$${160.86}$$ < $${163.0}$$
✅	docker_agent_amd64	$${-0}$$	$${781.25}$$ < $${788.65}$$	$${-0}$$	$${269.25}$$ < $${272.01}$$
✅	docker_agent_arm64	$${+0}$$	$${793.56}$$ < $${802.0}$$	$${+0.01}$$	$${256.08}$$ < $${259.7}$$
✅	docker_agent_jmx_amd64	$${-0}$$	$${972.55}$$ < $${979.84}$$	$${+0}$$	$${338.3}$$ < $${340.95}$$
✅	docker_agent_jmx_arm64	$${+0}$$	$${973.46}$$ < $${981.8}$$	$${-0}$$	$${321.09}$$ < $${324.65}$$
✅	docker_cluster_agent_amd64	$${+0}$$	$${214.01}$$ < $${214.5}$$	$${-0}$$	$${72.75}$$ < $${73.51}$$
✅	docker_cluster_agent_arm64	$${-0}$$	$${229.88}$$ < $${230.33}$$	$${-0}$$	$${68.99}$$ < $${69.77}$$
✅	docker_cws_instrumentation_amd64	$${0}$$	$${7.07}$$ < $${7.12}$$	$${-0}$$	$${2.95}$$ < $${3.29}$$
✅	docker_cws_instrumentation_arm64	$${0}$$	$${6.69}$$ < $${6.92}$$	$${0}$$	$${2.7}$$ < $${3.07}$$
✅	docker_dogstatsd_amd64	$${-0}$$	$${38.53}$$ < $${39.57}$$	$${-0}$$	$${14.88}$$ < $${15.76}$$
✅	docker_dogstatsd_arm64	$${0}$$	$${37.23}$$ < $${38.2}$$	$${+0}$$	$${14.34}$$ < $${14.83}$$
✅	dogstatsd_deb_amd64	$${0}$$	$${29.77}$$ < $${31.4}$$	$${-0}$$	$${7.85}$$ < $${8.95}$$
✅	dogstatsd_deb_arm64	$${0}$$	$${28.37}$$ < $${29.97}$$	$${-0}$$	$${6.81}$$ < $${7.89}$$
✅	dogstatsd_rpm_amd64	$${0}$$	$${29.77}$$ < $${31.4}$$	$${-0}$$	$${7.86}$$ < $${8.96}$$
✅	dogstatsd_suse_amd64	$${0}$$	$${29.77}$$ < $${31.4}$$	$${-0}$$	$${7.86}$$ < $${8.96}$$
✅	iot_agent_deb_amd64	$${0}$$	$${54.12}$$ < $${54.55}$$	$${-0}$$	$${13.64}$$ < $${14.45}$$
✅	iot_agent_deb_arm64	$${0}$$	$${51.44}$$ < $${51.9}$$	$${-0.01}$$	$${11.8}$$ < $${12.63}$$
✅	iot_agent_deb_armhf	$${0}$$	$${50.95}$$ < $${51.42}$$	$${+0.04}$$	$${11.92}$$ < $${12.74}$$
✅	iot_agent_rpm_amd64	$${0}$$	$${54.12}$$ < $${54.55}$$	$${-0}$$	$${13.66}$$ < $${14.47}$$
✅	iot_agent_rpm_arm64	$${0}$$	$${51.44}$$ < $${51.91}$$	$${-0}$$	$${11.82}$$ < $${12.65}$$
✅	iot_agent_suse_amd64	$${0}$$	$${54.12}$$ < $${54.55}$$	$${-0}$$	$${13.66}$$ < $${14.47}$$

…rics

…d circularly imports. metric.go should not import each cloudservice

…ask duration metric

…rics

github-actions · 2025-07-29T20:32:45Z

Serverless Benchmark Results

BenchmarkStartEndInvocation comparison between 3f3ad3c and e223db58ab282a256f0b5ecdfc06374e819a1fb4.

tl;dr

Use these benchmarks as an insight tool during development.

Skim down the vs base column in each chart. If there is a ~, then there was no statistically significant change to the benchmark. Otherwise, ensure the estimated percent change is either negative or very small.
The last row of each chart is the geomean. Ensure this percentage is either negative or very small.

What is this benchmarking?

The BenchmarkStartEndInvocation compares the amount of time it takes to call the start-invocation and end-invocation endpoints. For universal instrumentation languages (Dotnet, Golang, Java, Ruby), this represents the majority of the duration overhead added by our tracing layer.

The benchmark is run using a large variety of lambda request payloads. In the charts below, there is one row for each event payload type.

How do I interpret these charts?

The charts below comes from benchstat. They represent the statistical change in duration (sec/op), memory overhead (B/op), and allocations (allocs/op).

The benchstat docs explain how to interpret these charts.

Before the comparison table, we see common file-level configuration. If there are benchmarks with different configuration (for example, from different packages), benchstat will print separate tables for each configuration.

The table then compares the two input files for each benchmark. It shows the median and 95% confidence interval summaries for each benchmark before and after the change, and an A/B comparison under "vs base". ... The p-value measures how likely it is that any differences were due to random chance (i.e., noise). The "~" means benchstat did not detect a statistically significant difference between the two inputs. ...

Note that "statistically significant" is not the same as "large": with enough low-noise data, even very small changes can be distinguished from noise and considered statistically significant. It is, of course, generally easier to distinguish large changes from noise.

Finally, the last row of the table shows the geometric mean of each column, giving an overall picture of how the benchmarks changed. Proportional changes in the geomean reflect proportional changes in the benchmarks. For example, given n benchmarks, if sec/op for one of them increases by a factor of 2, then the sec/op geomean will increase by a factor of ⁿ√2.

I need more help

First off, do not worry if the benchmarks are failing. They are not tests. The intention is for them to be a tool for you to use during development.

If you would like a hand interpreting the results come chat with us in #serverless-agent in the internal DataDog slack or in #serverless in the public DataDog slack. We're happy to help!

Benchmark stats

apiarian-datadog

ok. if we're not going to fix the demultiplexer hack now, let's do it in a quick followup. at least to move the "is this cloudrun" boolean logic out of the demultiplexer file and up into the serverless-init main and/or cloudservice.

…rics

nhulston · 2025-07-30T18:35:04Z

/merge

dd-devflow-routing-codex · 2025-07-30T18:35:08Z

View all feedbacks in Devflow UI.

2025-07-30 18:35:08 UTC ℹ️ Start processing command /merge

2025-07-30 18:35:20 UTC ℹ️ MergeQueue: waiting for PR to be ready

This merge request is not mergeable yet, because of pending checks/missing approvals. It will be added to the queue as soon as checks pass and/or get approvals.
Note: if you pushed new commits since the last approval, you may need additional approval.
You can remove it from the waiting list with /remove command.

2025-07-30 19:23:15 UTC ℹ️ MergeQueue: merge request added to the queue

The expected merge time in main is approximately 56m (p90).

2025-07-30 20:01:21 UTC ℹ️ MergeQueue: This merge request was merged

nhulston added 5 commits July 23, 2025 18:11

fix dogstatsd shutdown flush

74db216

Create and implement GetShutdownMetricName() for each cloud service

f108299

use new GetShutdownMetricName instead of AddShutdownMetric

96058c7

fix metric_test.go

ca24855

enhanced metric for task duration

2ebaf23

github-actions Bot added the medium review PR review might take time label Jul 24, 2025

nhulston commented Jul 24, 2025

View reviewed changes

Comment thread cmd/serverless-init/main.go Outdated

nhulston commented Jul 24, 2025

View reviewed changes

nhulston added the team/serverless-azure-gcp label Jul 24, 2025

add changelog

509a40f

nhulston added the qa/done QA done before merge and regressions are covered by tests label Jul 24, 2025

lint

2527455

Merge branch 'main' into nicholas.hulston/cloud-run-jobs-enhanced-met…

1295515

…rics

nhulston marked this pull request as ready for review July 25, 2025 13:55

nhulston requested review from a team as code owners July 25, 2025 13:55

fix static quality gates check by not importing cloudservice

7dd0550

vickenty reviewed Jul 25, 2025

View reviewed changes

Comment thread pkg/aggregator/demultiplexer_serverless.go Outdated

nhulston marked this pull request as draft July 25, 2025 14:44

nhulston added 4 commits July 25, 2025 13:34

(refactor): create a GetSource() method for each cloudservice to avoi…

c088068

…d circularly imports. metric.go should not import each cloudservice

Use Shutdown() method for each cloudservice; Cloud Run Jobs sends t…

174d5e6

…ask duration metric

fix test

0986cbf

unexport cloudRunJobNameEnvVar

29f0930

nhulston commented Jul 25, 2025

View reviewed changes

Comment thread cmd/serverless-init/cloudservice/cloudrun_jobs.go Outdated

nhulston commented Jul 25, 2025

View reviewed changes

Comment thread cmd/serverless-init/cloudservice/cloudrun_jobs.go Outdated

nhulston marked this pull request as ready for review July 25, 2025 17:50

nhulston requested a review from vickenty July 25, 2025 17:52

apiarian-datadog reviewed Jul 25, 2025

View reviewed changes

Comment thread cmd/serverless-init/cloudservice/service.go

github-actions Bot added long review PR is complex, plan time to review it and removed medium review PR review might take time labels Jul 25, 2025

apiarian-datadog reviewed Jul 25, 2025

View reviewed changes

Comment thread cmd/serverless-init/main.go Outdated

apiarian-datadog reviewed Jul 25, 2025

View reviewed changes

Comment thread cmd/serverless-init/cloudservice/cloudrun_jobs.go

nhulston added 3 commits July 25, 2025 15:07

Merge branch 'main' into nicholas.hulston/cloud-run-jobs-enhanced-met…

2957535

…rics

use UTC timestamps in case timezones change during a task

e078b8b

simplify metric.Add()

e5f089a

nhulston requested a review from apiarian-datadog July 25, 2025 19:51

vickenty approved these changes Jul 28, 2025

View reviewed changes

nhulston added 3 commits July 28, 2025 10:06

Merge branch 'main' into nicholas.hulston/cloud-run-jobs-enhanced-met…

b281133

…rics

fix test

dd29c26

simplify time

b18d00e

apiarian-datadog requested changes Jul 29, 2025

View reviewed changes

Comment thread cmd/serverless-init/main.go Outdated

Comment thread pkg/aggregator/demultiplexer_serverless.go

Comment thread cmd/serverless-init/cloudservice/cloudrun_jobs.go

Comment thread cmd/serverless-init/cloudservice/cloudrun.go Outdated

defer lastFlush

0064446

nhulston requested a review from a team as a code owner July 29, 2025 20:29

nhulston force-pushed the nicholas.hulston/cloud-run-jobs-enhanced-metrics branch from 0a8585e to 0064446 Compare July 29, 2025 20:30

nhulston removed the request for review from a team July 29, 2025 20:49

convert GetPrefix() to local string consts

846df66

nhulston requested a review from apiarian-datadog July 29, 2025 21:40

apiarian-datadog approved these changes Jul 30, 2025

View reviewed changes

nhulston added 2 commits July 30, 2025 12:53

defer cloudService.Shutdown

831a395

Merge branch 'main' into nicholas.hulston/cloud-run-jobs-enhanced-met…

5c4d05b

…rics

dd-mergequeue Bot merged commit 1a205d7 into main Jul 30, 2025
264 of 265 checks passed

dd-mergequeue Bot deleted the nicholas.hulston/cloud-run-jobs-enhanced-metrics branch July 30, 2025 20:01

github-actions Bot added this to the 7.70.0 milestone Jul 30, 2025

Uh oh!

Conversation

nhulston commented Jul 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Motivation

Describe how you validated your changes

Possible Drawbacks / Trade-offs

Additional Notes

Uh oh!

Uh oh!

nhulston Jul 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cit-pr-commenter Bot commented Jul 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Regression Detector

Regression Detector Results

Optimization Goals: ✅ No significant changes detected

Experiments ignored for regressions

Fine details of change detection per experiment

Bounds Checks: ✅ Passed

Explanation

CI Pass/Fail Decision

Uh oh!

agent-platform-auto-pr Bot commented Jul 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Static quality checks

Info

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Jul 29, 2025

Serverless Benchmark Results

Uh oh!

apiarian-datadog left a comment

Choose a reason for hiding this comment

Uh oh!

nhulston commented Jul 30, 2025

Uh oh!

dd-devflow-routing-codex Bot commented Jul 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

nhulston commented Jul 24, 2025 •

edited

Loading

nhulston Jul 24, 2025 •

edited

Loading

cit-pr-commenter Bot commented Jul 24, 2025 •

edited

Loading

agent-platform-auto-pr Bot commented Jul 24, 2025 •

edited

Loading

dd-devflow-routing-codex Bot commented Jul 30, 2025 •

edited

Loading