Show diff to closest metric match

[sethsamuel]

What does this PR do?

Adds a diff in tests between the expected metric and the closest found match.

Example output:

E   AssertionError: Needed exactly 1 candidates for 'mysql.can_connect', got 0
E   Expected:
E           ServiceCheckStub(check_id=None, name='mysql.can_connect', status=1, tags=['dd.internal.resource:database_instance:stubbed.hostname1', 'port:213306'], hostname=None, message=None)
E   Difference to closest:
E           Expected status: 1
E           Found 0
E           Expected tag dd.internal.resource:database_instance:stubbed.hostname1
E           Found dd.internal.resource:database_instance:stubbed.hostname
E           Expected tag port:213306
E           Found port:13306
E   
E   Similar submitted:
E   Score   Most similar
E   0.80    ServiceCheckStub(check_id='', name='mysql.can_connect', status=0, tags=['dd.internal.resource:database_instance:stubbed.hostname', 'port:13306'], hostname='stubbed.hostname', message='')

Motivation

It can be challenging to spot the difference between an expected and a found element. Adding an explicit diff to the closest match can help.

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

[codecov]

Codecov Report

Attention: Patch coverage is 55.55556% with 8 lines in your changes missing coverage. Please review.

Project coverage is 88.86%. Comparing base (e844766) to head (a30e0ad).
Report is 69 commits behind head on master.

Additional details and impacted files

Flag	Coverage Δ
active_directory	86.36% <ø> (ø)
activemq	52.80% <ø> (ø)
activemq_xml	82.20% <ø> (ø)
amazon_msk	89.19% <ø> (ø)
ambari	85.75% <ø> (ø)
apache	95.08% <ø> (ø)
appgate_sdp	93.93% <ø> (ø)
arangodb	98.23% <ø> (ø)
argo_rollouts	90.00% <ø> (ø)
argo_workflows	87.87% <ø> (ø)
argocd	87.23% <ø> (ø)
aspdotnet	100.00% <ø> (ø)
avi_vantage	91.35% <ø> (ø)
aws_neuron	92.42% <ø> (ø)
azure_iot_edge	82.08% <ø> (ø)
boundary	100.00% <ø> (ø)
btrfs	83.33% <ø> (ø)
cacti	87.90% <ø> (ø)
calico	84.61% <ø> (ø)
cassandra	66.66% <ø> (ø)
cert_manager	77.41% <ø> (ø)
cisco_aci	89.59% <ø> (ø)
citrix_hypervisor	87.50% <ø> (ø)
cloud_foundry_api	96.11% <ø> (ø)
cloudera	99.51% <ø> (ø)
cockroachdb	77.63% <ø> (-16.23%)	⬇️
consul	90.14% <ø> (-1.79%)	⬇️
coredns	95.65% <ø> (ø)
couch	95.07% <ø> (ø)
crio	89.79% <ø> (ø)
datadog_checks_base	89.55% <55.55%> (+0.26%)	⬆️
datadog_checks_dev	77.63% <ø> (ø)
datadog_checks_downloader	81.35% <ø> (+3.23%)	⬆️
datadog_cluster_agent	90.19% <ø> (ø)
dcgm	93.54% <ø> (ø)
ddev	87.46% <ø> (ø)
directory	96.46% <ø> (ø)
disk	89.44% <ø> (ø)
dns_check	93.81% <ø> (ø)
druid	97.70% <ø> (ø)
ecs_fargate	83.71% <ø> (ø)
eks_fargate	94.05% <ø> (ø)
envoy	95.41% <ø> (+5.46%)	⬆️
esxi	93.92% <ø> (ø)
etcd	95.56% <ø> (ø)
external_dns	89.28% <ø> (ø)
fluentd	84.32% <ø> (ø)
fluxcd	88.31% <ø> (ø)
fly_io	97.13% <ø> (ø)
foundationdb	83.83% <ø> (ø)
gitlab_runner	92.76% <ø> (ø)
glusterfs	80.00% <ø> (ø)
go_expvar	92.66% <ø> (ø)
gunicorn	92.16% <ø> (-0.75%)	⬇️
hazelcast	92.30% <ø> (ø)
hdfs_datanode	89.63% <ø> (ø)
hdfs_namenode	86.60% <ø> (ø)
hive	51.42% <ø> (ø)
hivemq	61.90% <ø> (ø)
http_check	94.25% <ø> (ø)
hudi	73.91% <ø> (ø)
ibm_db2	86.29% <ø> (-0.59%)	⬇️
ibm_i	82.36% <ø> (ø)
ibm_mq	47.55% <ø> (-43.63%)	⬇️
ignite	46.66% <ø> (ø)
impala	97.97% <ø> (ø)
istio	77.86% <ø> (ø)
jboss_wildfly	47.36% <ø> (ø)
kafka	64.70% <ø> (ø)
karpenter	95.06% <ø> (ø)
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% <ø> (ø)
kyototycoon	85.96% <ø> (ø)
kyverno	82.27% <ø> (ø)
lighttpd	83.64% <ø> (ø)
linkerd	84.70% <ø> (ø)
linux_proc_extras	96.20% <ø> (ø)
mapr	82.70% <ø> (ø)
mapreduce	81.99% <ø> (ø)
marathon	83.06% <ø> (ø)
mcache	93.48% <ø> (ø)
mesos_master	89.71% <ø> (ø)
mesos_slave	93.56% <ø> (ø)
nagios	89.01% <ø> (ø)
network	93.77% <ø> (ø)
nfsstat	95.20% <ø> (ø)
nginx	94.65% <ø> (ø)
nginx_ingress_controller	98.55% <ø> (ø)
nvidia_triton	88.52% <ø> (ø)
openldap	96.33% <ø> (ø)
openmetrics	98.05% <ø> (ø)
openstack	55.11% <ø> (ø)
pgbouncer	91.66% <ø> (ø)
php_fpm	90.45% <ø> (ø)
postfix	88.04% <ø> (ø)
postgres	77.52% <ø> (-11.81%)	⬇️
powerdns_recursor	96.65% <ø> (ø)
presto	59.09% <ø> (ø)
process	85.99% <ø> (ø)
prometheus	94.17% <ø> (ø)
proxysql	98.97% <ø> (ø)
pulsar	100.00% <ø> (ø)
rethinkdb	98.27% <ø> (ø)
riak	99.21% <ø> (ø)
riakcs	88.82% <ø> (ø)
silk	93.82% <ø> (ø)
singlestore	90.81% <ø> (ø)
slurm	88.17% <ø> (?)
snowflake	96.27% <ø> (ø)
solr	56.25% <ø> (ø)
spark	93.17% <ø> (ø)
squid	100.00% <ø> (ø)
ssh_check	92.20% <ø> (ø)
statsd	87.36% <ø> (ø)
strimzi	89.78% <ø> (ø)
supervisord	90.14% <ø> (ø)
system_core	92.52% <ø> (ø)
system_swap	98.30% <ø> (ø)
tcp_check	90.72% <ø> (ø)
tekton	82.30% <ø> (ø)
teleport	99.61% <ø> (ø)
temporal	100.00% <ø> (ø)
teradata	94.27% <ø> (ø)
tibco_ems	91.98% <ø> (ø)
tls	91.78% <ø> (ø)
torchserve	97.32% <ø> (ø)
traefik_mesh	76.75% <ø> (ø)
traffic_server	96.13% <ø> (ø)
twemproxy	79.45% <ø> (ø)
twistlock	80.41% <ø> (ø)
varnish	84.22% <ø> (ø)
vllm	93.10% <ø> (ø)
weaviate	76.27% <ø> (ø)
win32_event_log	82.55% <ø> (ø)
wmi_check	97.50% <ø> (ø)
yarn	89.89% <ø> (ø)

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

---- 🚨 Try these New Features:

• Flaky Tests Detection - Detect and resolve failed and flaky tests
• JS Bundle Analysis - Avoid shipping oversized bundles