Add more documentation for the OpenMetricsV2 class #13400

iliakur · 2022-11-28T11:02:54Z

What does this PR do?

Motivation

Additional Notes

Review checklist (to be filled by reviewers)

Feature or bugfix MUST have appropriate tests (unit, integration, e2e)
PR title must be written as a CHANGELOG entry (see why)
Files changes must correspond to the primary purpose of the PR as described in the title (small unrelated changes should have their own PR)
PR must have changelog/ and integration/ labels attached
If the PR doesn't need to be tested during QA, please add a qa/skip-qa label.

codecov · 2022-11-28T11:10:44Z

Codecov Report

Merging #13400 (4c542b8) into master (b10e1e0) will increase coverage by 3.90%.
The diff coverage is n/a.

Flag	Coverage Δ
active_directory	`100.00% <ø> (+17.64%)`	⬆️
activemq_xml	`82.31% <ø> (ø)`
airflow	`89.57% <ø> (ø)`
amazon_msk	`89.07% <ø> (ø)`
ambari	`85.75% <ø> (ø)`
apache	`95.08% <ø> (ø)`
arangodb	`98.23% <ø> (ø)`
argocd	`88.04% <ø> (ø)`
aspdotnet	`100.00% <ø> (ø)`
avi_vantage	`91.35% <ø> (ø)`
azure_iot_edge	`82.08% <ø> (ø)`
boundary	`100.00% <ø> (ø)`
btrfs	`82.91% <ø> (ø)`
cacti	`87.90% <ø> (ø)`
calico	`84.61% <ø> (ø)`
cassandra_nodetool	`93.16% <ø> (ø)`
ceph	`91.07% <ø> (ø)`
cert_manager	`77.41% <ø> (ø)`
cilium	`77.63% <ø> (+0.87%)`	⬆️
cisco_aci	`95.27% <ø> (ø)`
cloud_foundry_api	`96.35% <ø> (+0.12%)`	⬆️
cloudera	`99.49% <ø> (ø)`
cockroachdb	`91.52% <ø> (ø)`
consul	`91.65% <ø> (ø)`
coredns	`94.57% <ø> (ø)`
couch	`95.43% <ø> (+0.48%)`	⬆️
couchbase	`84.28% <ø> (ø)`
crio	`89.79% <ø> (ø)`
datadog_checks_base	`89.62% <ø> (+9.12%)`	⬆️
datadog_checks_dev	`82.51% <ø> (+0.07%)`	⬆️
datadog_checks_downloader	`81.65% <ø> (ø)`
dcgm	`97.33% <ø> (ø)`
ddev	`99.48% <ø> (ø)`
directory	`95.87% <ø> (+0.65%)`	⬆️
disk	`89.23% <ø> (-2.14%)`	⬇️
dns_check	`93.90% <ø> (ø)`
dotnetclr	`91.39% <ø> (+12.90%)`	⬆️
druid	`98.47% <ø> (ø)`
ecs_fargate	`82.91% <ø> (ø)`
eks_fargate	`94.05% <ø> (ø)`
envoy	`95.30% <ø> (+0.62%)`	⬆️
etcd	`95.56% <ø> (ø)`
exchange_server	`96.85% <ø> (+11.81%)`	⬆️
external_dns	`89.28% <ø> (ø)`
fluentd	`94.77% <ø> (ø)`
foundationdb	`78.50% <ø> (ø)`
gearmand	`78.26% <ø> (+1.24%)`	⬆️
gitlab_runner	`91.94% <ø> (ø)`
go_expvar	`92.73% <ø> (ø)`
haproxy	`95.13% <ø> (+0.16%)`	⬆️
harbor	`80.04% <ø> (ø)`
hazelcast	`92.39% <ø> (ø)`
hdfs_namenode	`86.72% <ø> (ø)`
http_check	`96.09% <ø> (+2.15%)`	⬆️
ibm_ace	`91.79% <ø> (ø)`
ibm_db2	`95.30% <ø> (ø)`
ibm_i	`81.91% <ø> (ø)`
ibm_was	`96.08% <ø> (ø)`
impala	`97.97% <ø> (ø)`
istio	`76.45% <ø> (+0.55%)`	⬆️
kafka_consumer	`93.38% <ø> (ø)`
kube_apiserver_metrics	`97.85% <ø> (ø)`
kube_controller_manager	`96.03% <ø> (ø)`
kube_dns	`95.97% <ø> (ø)`
kube_metrics_server	`94.87% <ø> (ø)`
kube_proxy	`96.80% <ø> (ø)`
kube_scheduler	`96.53% <ø> (ø)`
kubelet	`91.00% <ø> (ø)`
kubernetes_state	`89.18% <ø> (ø)`
kyototycoon	`85.96% <ø> (ø)`
linkerd	`85.14% <ø> (+1.14%)`	⬆️
linux_proc_extras	`96.22% <ø> (ø)`
mapr	`82.70% <ø> (ø)`
mapreduce	`81.35% <ø> (-0.47%)`	⬇️
marathon	`83.43% <ø> (ø)`
mcache	`93.50% <ø> (ø)`
mesos_master	`89.75% <ø> (ø)`
mesos_slave	`93.63% <ø> (ø)`
mongo	`95.94% <ø> (ø)`
nagios	`89.01% <ø> (ø)`
network	`62.21% <ø> (-30.34%)`	⬇️
nfsstat	`95.20% <ø> (ø)`
nginx	`95.24% <ø> (+0.54%)`	⬆️
nginx_ingress_controller	`98.36% <ø> (ø)`
openmetrics	`98.08% <ø> (ø)`
openstack	`51.45% <ø> (ø)`
openstack_controller	`91.12% <ø> (ø)`
pdh_check	`97.82% <ø> (ø)`
pgbouncer	`91.33% <ø> (ø)`
php_fpm	`90.25% <ø> (+0.84%)`	⬆️
postfix	`88.04% <ø> (ø)`
powerdns_recursor	`96.65% <ø> (ø)`
process	`85.42% <ø> (+0.28%)`	⬆️
prometheus	`94.17% <ø> (ø)`
proxysql	`98.97% <ø> (ø)`
pulsar	`100.00% <ø> (ø)`
redisdb	`87.78% <ø> (ø)`
rethinkdb	`97.93% <ø> (ø)`
riak	`99.22% <ø> (ø)`
riakcs	`93.61% <ø> (ø)`
scylla	`100.00% <ø> (ø)`
silk	`93.82% <ø> (ø)`
singlestore	`90.81% <ø> (ø)`
snowflake	`96.61% <ø> (ø)`
spark	`93.91% <ø> (+0.28%)`	⬆️
squid	`100.00% <ø> (ø)`
ssh_check	`91.58% <ø> (ø)`
statsd	`87.36% <ø> (+1.05%)`	⬆️
strimzi	`89.70% <ø> (ø)`
supervisord	`90.14% <ø> (ø)`
system_core	`92.66% <ø> (ø)`
system_swap	`98.30% <ø> (ø)`
tcp_check	`92.92% <ø> (ø)`
teamcity	`88.74% <ø> (+3.21%)`	⬆️
temporal	`100.00% <ø> (ø)`
teradata	`94.06% <ø> (ø)`
tls	`92.18% <ø> (+0.82%)`	⬆️
tokumx	`58.40% <ø> (ø)`
torchserve	`97.33% <ø> (ø)`
traffic_server	`96.13% <ø> (ø)`
twemproxy	`79.45% <ø> (ø)`
twistlock	`79.62% <ø> (ø)`
varnish	`84.39% <ø> (+0.26%)`	⬆️
vault	`95.53% <ø> (+0.57%)`	⬆️
vertica	`98.34% <ø> (ø)`
voltdb	`96.85% <ø> (ø)`
vsphere	`95.73% <ø> (+0.06%)`	⬆️
weaviate	`76.27% <ø> (ø)`
win32_event_log	`86.40% <ø> (+0.27%)`	⬆️
windows_performance_counters	`98.36% <ø> (ø)`
windows_service	`98.00% <ø> (ø)`
wmi_check	`92.91% <ø> (ø)`
yarn	`89.50% <ø> (ø)`
zk	`82.62% <ø> (+1.33%)`	⬆️

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

datadog_checks_base/datadog_checks/base/checks/openmetrics/v2/base.py

…base.py Co-authored-by: Alex Lopez <[email protected]>

github-actions · 2022-12-08T08:39:09Z

The validations job has failed; please review the Files changed tab for possible suggestions to resolve.

github-actions · 2023-08-16T11:57:53Z

Test Results

    986 files     986 suites 8h 52m 52s ⏱️
  5 899 tests   5 821 ✔️     75 💤 3 ❌
24 029 runs 19 747 ✔️ 4 279 💤 3 ❌

For more details on these failures, see this check.

Results for commit 4c542b8.

* Add more documentation for the OpenMetricsV2 class * add note about init method usage * fix style * Update datadog_checks_base/datadog_checks/base/checks/openmetrics/v2/base.py Co-authored-by: Alex Lopez <[email protected]> --------- Co-authored-by: Alex Lopez <[email protected]> 6ffe167

Add more documentation for the OpenMetricsV2 class

0d96daf

iliakur added the changelog/no-changelog label Nov 28, 2022

iliakur requested review from a team as code owners November 28, 2022 11:02

ghost added base_package documentation labels Nov 28, 2022

iliakur added 2 commits November 28, 2022 14:06

add note about init method usage

c8bba43

fix style

85cb811

iliakur added the qa/skip-qa Automatically skip this PR for the next QA label Nov 28, 2022

buraizu previously approved these changes Nov 28, 2022

View reviewed changes

alopezz reviewed Nov 29, 2022

View reviewed changes

datadog_checks_base/datadog_checks/base/checks/openmetrics/v2/base.py Outdated Show resolved Hide resolved

Update datadog_checks_base/datadog_checks/base/checks/openmetrics/v2/…

2385c83

…base.py Co-authored-by: Alex Lopez <[email protected]>

iliakur dismissed buraizu’s stale review via 2385c83 December 8, 2022 08:38

steveny91 approved these changes Jan 19, 2023

View reviewed changes

Merge branch 'master' into ik/moar-om2-docs

4c542b8

iliakur merged commit 6ffe167 into master Aug 16, 2023
343 of 348 checks passed

iliakur deleted the ik/moar-om2-docs branch August 16, 2023 20:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add more documentation for the OpenMetricsV2 class #13400

Add more documentation for the OpenMetricsV2 class #13400

iliakur commented Nov 28, 2022

codecov bot commented Nov 28, 2022 •

edited

Loading

github-actions bot commented Dec 8, 2022

github-actions bot commented Aug 16, 2023

Add more documentation for the OpenMetricsV2 class #13400

Add more documentation for the OpenMetricsV2 class #13400

Conversation

iliakur commented Nov 28, 2022

What does this PR do?

Motivation

Additional Notes

Review checklist (to be filled by reviewers)

codecov bot commented Nov 28, 2022 • edited Loading

Codecov Report

github-actions bot commented Dec 8, 2022

github-actions bot commented Aug 16, 2023

Test Results

codecov bot commented Nov 28, 2022 •

edited

Loading