Add new scraper decorator that adds http code class to OpenMetrics #20528

AAraKKe · 2025-06-17T16:27:42Z

What does this PR do?

This PR adds a OpenMetricsScraper decorator that automatically adds code_class to the loaded OpenMetrics if an http code tag is configured.

It also moves the scraper module to a package preserving the existing import mechanism while allowing it to grow without making the scraper module too big.

Motivation

When dealing with metrics that track HTTP requests it is common to include the response code in the tags. These tags are useful but can contribute to busy dashboards and a common approach is to group them by 2xx, 4xx etc.

The Kuma integration already does this and likely the KrakenD integration will as well. This centralizes the logic of such approach to easily load this in the future.

Why a decorator?

I thought that we might want to do these kind of things often for common practices and having it as a decorator means that we can easily compose them. On top of that is an extension with no impact on the existing scraper.

Review checklist (to be filled by reviewers)

Feature or bugfix MUST have appropriate tests (unit, integration, e2e)
Add the qa/skip-qa label if the PR doesn't need to be tested during QA.
If you need to backport this PR to another branch, you can add the backport/<branch-name> label to the PR and it will automatically open a backport PR once this one is merged

AAraKKe · 2025-06-17T16:28:01Z

Add new scraper decorator that adds http code class to OpenMetrics #20528 👈 (View in Graphite)
master

This stack of pull requests is managed by Graphite. Learn more about stacking.

codecov · 2025-06-17T16:30:13Z

Codecov Report

Attention: Patch coverage is 94.91525% with 3 lines in your changes missing coverage. Please review.

Project coverage is 90.52%. Comparing base (47776a7) to head (9b2f6f3).
Report is 12 commits behind head on master.

Additional details and impacted files

Flag	Coverage Δ
active_directory	`93.18% <ø> (ø)`
activemq	`52.80% <ø> (ø)`
activemq_xml	`82.20% <ø> (ø)`
aerospike	`88.83% <ø> (ø)`
airflow	`93.03% <ø> (ø)`
amazon_msk	`89.50% <ø> (ø)`
ambari	`85.75% <ø> (ø)`
apache	`95.08% <ø> (ø)`
appgate_sdp	`93.93% <ø> (ø)`
arangodb	`98.23% <ø> (ø)`
argo_rollouts	`90.00% <ø> (ø)`
argo_workflows	`89.61% <ø> (ø)`
argocd	`87.16% <ø> (ø)`
aspdotnet	`100.00% <ø> (ø)`
avi_vantage	`93.83% <ø> (ø)`
aws_neuron	`92.42% <ø> (ø)`
azure_iot_edge	`82.08% <ø> (ø)`
boundary	`100.00% <ø> (ø)`
btrfs	`83.33% <ø> (ø)`
cacti	`87.90% <ø> (ø)`
calico	`84.61% <ø> (ø)`
cassandra	`66.66% <ø> (ø)`
cassandra_nodetool	`93.16% <ø> (ø)`
celery	`95.45% <ø> (ø)`
ceph	`91.35% <ø> (ø)`
cert_manager	`77.41% <ø> (ø)`
cilium	`77.92% <ø> (ø)`
cisco_aci	`89.43% <ø> (ø)`
citrix_hypervisor	`87.97% <ø> (ø)`
clickhouse	`94.55% <ø> (ø)`
cloud_foundry_api	`96.11% <ø> (ø)`
cloudera	`99.51% <ø> (ø)`
cockroachdb	`92.98% <ø> (ø)`
confluent_platform	81.96% <ø> (ø)
consul	`91.92% <ø> (ø)`
coredns	`95.65% <ø> (ø)`
couch	`94.76% <ø> (ø)`
couchbase	`85.23% <ø> (+0.36%)`	⬆️
crio	`89.79% <ø> (ø)`
datadog_checks_base	`89.55% <94.91%> (+0.30%)`	⬆️
datadog_checks_dev	`77.61% <ø> (ø)`
datadog_checks_downloader	`81.37% <ø> (+3.22%)`	⬆️
datadog_cluster_agent	`90.19% <ø> (ø)`
dcgm	`93.54% <ø> (ø)`
ddev	`87.37% <ø> (-0.62%)`	⬇️
directory	`97.11% <ø> (ø)`
disk	`87.72% <ø> (ø)`
dns_check	`93.84% <ø> (ø)`
dotnetclr	`84.05% <ø> (ø)`
druid	`97.70% <ø> (ø)`
duckdb	`84.53% <ø> (ø)`
ecs_fargate	`83.71% <ø> (ø)`
eks_fargate	`94.05% <ø> (ø)`
elastic	`93.92% <ø> (ø)`
envoy	`95.41% <ø> (+5.46%)`	⬆️
esxi	`93.98% <ø> (ø)`
etcd	`95.56% <ø> (ø)`
exchange_server	`93.06% <ø> (ø)`
external_dns	`89.28% <ø> (ø)`
falco	`95.65% <ø> (ø)`
fluentd	`84.21% <ø> (ø)`
fluxcd	`88.31% <ø> (ø)`
fly_io	`97.13% <ø> (ø)`
foundationdb	`81.99% <ø> (-0.79%)`	⬇️
gearmand	`77.84% <ø> (ø)`
gitlab	`92.27% <ø> (ø)`
gitlab_runner	`92.76% <ø> (ø)`
glusterfs	`80.00% <ø> (ø)`
go_expvar	`92.66% <ø> (ø)`
gunicorn	`93.28% <ø> (ø)`
haproxy	`95.35% <ø> (ø)`
harbor	`89.65% <ø> (ø)`
hazelcast	`92.30% <ø> (ø)`
hdfs_datanode	`89.63% <ø> (ø)`
hdfs_namenode	`86.60% <ø> (ø)`
hive	`51.42% <ø> (ø)`
hivemq	`61.90% <ø> (ø)`
http_check	`94.26% <ø> (ø)`
hudi	`73.91% <ø> (ø)`
ibm_ace	`92.25% <ø> (ø)`
ibm_db2	`86.29% <ø> (ø)`
ibm_i	`82.36% <ø> (ø)`
ibm_mq	`91.46% <ø> (+0.13%)`	⬆️
ibm_was	`96.06% <ø> (ø)`
ignite	`46.66% <ø> (ø)`
iis	`95.02% <ø> (ø)`
impala	`97.97% <ø> (ø)`
infiniband	`92.34% <ø> (ø)`
istio	`77.86% <ø> (ø)`
jboss_wildfly	`47.36% <ø> (ø)`
kafka	`64.70% <ø> (ø)`
kafka_consumer	`92.55% <ø> (+1.51%)`	⬆️
karpenter	`95.06% <ø> (ø)`
keda	`88.05% <ø> (ø)`
kong	`88.42% <ø> (ø)`
kube_apiserver_metrics	`97.75% <ø> (ø)`
kube_controller_manager	`97.88% <ø> (ø)`
kube_dns	`95.94% <ø> (ø)`
kube_metrics_server	`94.87% <ø> (ø)`
kube_proxy	`96.80% <ø> (ø)`
kube_scheduler	`97.92% <ø> (ø)`
kubeflow	`93.22% <ø> (ø)`
kubelet	`91.09% <ø> (ø)`
kubernetes_cluster_autoscaler	`93.22% <ø> (ø)`
kubernetes_state	`89.49% <ø> (ø)`
kubevirt_api	`82.75% <ø> (ø)`
kubevirt_controller	`85.36% <ø> (ø)`
kubevirt_handler	`91.32% <ø> (ø)`
kuma	`79.03% <ø> (ø)`
kyototycoon	`85.96% <ø> (ø)`
kyverno	`82.27% <ø> (ø)`
lighttpd	`83.64% <ø> (ø)`
linkerd	`84.70% <ø> (ø)`
linux_proc_extras	`96.20% <ø> (ø)`
litellm	`95.65% <ø> (ø)`
mac_audit_logs	`80.79% <ø> (ø)`
mapr	`82.70% <ø> (ø)`
mapreduce	`81.99% <ø> (ø)`
marathon	`83.06% <ø> (ø)`
marklogic	`96.08% <ø> (+2.37%)`	⬆️
mcache	`93.99% <ø> (ø)`
mesos_master	`89.71% <ø> (ø)`
milvus	`92.30% <ø> (ø)`
mongo	`93.12% <ø> (+0.22%)`	⬆️
mysql	`89.30% <ø> (ø)`
nagios	`89.01% <ø> (ø)`
network	`93.89% <ø> (ø)`
nfsstat	`94.67% <ø> (ø)`
nginx	`94.65% <ø> (ø)`
nginx_ingress_controller	`98.55% <ø> (ø)`
nvidia_nim	`93.10% <ø> (ø)`
nvidia_triton	`88.52% <ø> (ø)`
octopus_deploy	`99.25% <ø> (ø)`
openldap	`96.33% <ø> (ø)`
openmetrics	`98.05% <ø> (ø)`
openstack	`55.11% <ø> (ø)`
openstack_controller	`94.65% <ø> (ø)`
pdh_check	`95.65% <ø> (ø)`
pgbouncer	`94.91% <ø> (ø)`
php_fpm	`90.45% <ø> (ø)`
postfix	`88.04% <ø> (ø)`
postgres	`93.14% <ø> (+3.50%)`	⬆️
powerdns_recursor	`96.65% <ø> (ø)`
presto	`59.09% <ø> (ø)`
process	`85.99% <ø> (ø)`
prometheus	`94.17% <ø> (ø)`
proxysql	`98.97% <ø> (ø)`
pulsar	`100.00% <ø> (ø)`
quarkus	`100.00% <ø> (ø)`
rabbitmq	`95.67% <ø> (ø)`
ray	`96.45% <ø> (ø)`
redisdb	`89.72% <ø> (ø)`
rethinkdb	`98.27% <ø> (ø)`
riak	`99.21% <ø> (ø)`
riakcs	`88.82% <ø> (ø)`
sap_hana	`90.54% <ø> (ø)`
scylla	`98.82% <ø> (ø)`
silk	`93.91% <ø> (ø)`
silverstripe_cms	`76.00% <ø> (ø)`
singlestore	`91.70% <ø> (ø)`
slurm	`90.86% <ø> (ø)`
snmp	`95.71% <ø> (ø)`
snowflake	`96.27% <ø> (ø)`
solr	`56.25% <ø> (ø)`
sonarqube	`98.10% <ø> (ø)`
sonatype_nexus	`76.69% <ø> (ø)`
spark	`93.50% <ø> (ø)`
sqlserver	`91.25% <ø> (+4.51%)`	⬆️
squid	`100.00% <ø> (ø)`
ssh_check	`91.32% <ø> (ø)`
statsd	`87.36% <ø> (ø)`
strimzi	`83.00% <ø> (-6.78%)`	⬇️
supabase	`93.97% <ø> (ø)`
supervisord	`90.14% <ø> (ø)`
system_core	`92.52% <ø> (ø)`
system_swap	`98.30% <ø> (ø)`
tcp_check	`92.05% <ø> (ø)`
teamcity	`87.39% <ø> (ø)`
tekton	`82.45% <ø> (ø)`
teleport	`98.16% <ø> (ø)`
temporal	`100.00% <ø> (ø)`
teradata	`94.27% <ø> (ø)`
tibco_ems	`91.98% <ø> (ø)`
tls	`90.26% <ø> (ø)`
tomcat	`60.41% <ø> (ø)`
torchserve	`97.32% <ø> (ø)`
traefik_mesh	`76.75% <ø> (ø)`
traffic_server	`96.13% <ø> (ø)`
twemproxy	`79.45% <ø> (ø)`
twistlock	`80.41% <ø> (ø)`
varnish	`84.22% <ø> (ø)`
vault	`95.67% <ø> (ø)`
velero	`85.00% <ø> (ø)`
vertica	`98.34% <ø> (ø)`
vllm	`94.44% <ø> (ø)`
voltdb	`96.84% <ø> (ø)`
vsphere	`96.62% <ø> (ø)`
weaviate	`76.27% <ø> (ø)`
weblogic	`70.83% <ø> (ø)`
win32_event_log	`86.54% <ø> (ø)`
windows_performance_counters	`98.36% <ø> (ø)`
windows_service	`94.53% <ø> (ø)`
wmi_check	`92.91% <ø> (ø)`
yarn	`89.93% <ø> (ø)`
zk	`82.30% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

nubtron

Very nice! This will be super useful.

…b8c7

datadog-agent-integrations-bot bot added the base_package label Jun 17, 2025

AAraKKe added the qa/skip-qa Automatically skip this PR for the next QA label Jun 17, 2025 — with Graphite App

AAraKKe force-pushed the aarakke/open-metrics-http-class-scraper branch 4 times, most recently from dc826af to 41bff27 Compare June 18, 2025 08:55

Add new scraper that adds http code class to OpenMetrics

9b2f6f3

AAraKKe force-pushed the aarakke/open-metrics-http-class-scraper branch from 41bff27 to 9b2f6f3 Compare June 18, 2025 09:06

AAraKKe marked this pull request as ready for review June 18, 2025 09:56

AAraKKe requested review from a team as code owners June 18, 2025 09:56

datadog-agent-integrations-bot bot added team/container-integrations team/agent-integrations labels Jun 18, 2025

AAraKKe changed the title ~~Add new scraper that adds http code class to OpenMetrics~~ Add new scraper decorator that adds http code class to OpenMetrics Jun 18, 2025

nubtron approved these changes Jun 18, 2025

View reviewed changes

AAraKKe added this pull request to the merge queue Jun 18, 2025

Merged via the queue into master with commit f98b8c7 Jun 18, 2025
436 of 438 checks passed

AAraKKe deleted the aarakke/open-metrics-http-class-scraper branch June 18, 2025 10:32

github-actions bot pushed a commit that referenced this pull request Jun 18, 2025

Add new scraper that adds http code class to OpenMetrics (#20528) f98…

e67bba9

…b8c7

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add new scraper decorator that adds http code class to OpenMetrics #20528

Add new scraper decorator that adds http code class to OpenMetrics #20528

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Add new scraper decorator that adds http code class to OpenMetrics #20528

Add new scraper decorator that adds http code class to OpenMetrics #20528

Uh oh!

Conversation

Uh oh!

What does this PR do?

Motivation

Why a decorator?

Review checklist (to be filled by reviewers)

Uh oh!

Uh oh!

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!