Instrument obsreport.Scraper #6460

moh-osman3 · 2022-11-02T02:28:01Z

Description:

This PR instruments obsreport.Scraper with otel go. This is a followup PR that is based on similar changes made for obsreport.Receiver: #6222

Link to tracking Issue: Part of #816

Testing:
Ran contrib collector with prometheusreceiver and hostmetricsreceiver and confirmed that new metrics show up. Tested both with feature gate disabled and enabled.

curl http://localhost:8888/metrics | tail -n 13
# HELP otelcol_scraper_errored_metric_points_ratio_total Number of metric points that were unable to be scraped.
# TYPE otelcol_scraper_errored_metric_points_ratio_total counter
otelcol_scraper_errored_metric_points_ratio_total{receiver="hostmetrics",scraper="memory"} 0
# HELP otelcol_scraper_errored_metric_points_ratio_total_total Number of metric points that were unable to be scraped.
# TYPE otelcol_scraper_errored_metric_points_ratio_total_total counter
otelcol_scraper_errored_metric_points_ratio_total_total{receiver="hostmetrics",scraper="cpu"} 4
# HELP otelcol_scraper_scraped_metric_points_ratio_total Number of metric points successfully scraped.
# TYPE otelcol_scraper_scraped_metric_points_ratio_total counter
otelcol_scraper_scraped_metric_points_ratio_total{receiver="hostmetrics",scraper="cpu"} 0
# HELP otelcol_scraper_scraped_metric_points_ratio_total_total Number of metric points successfully scraped.
# TYPE otelcol_scraper_scraped_metric_points_ratio_total_total counter
otelcol_scraper_scraped_metric_points_ratio_total_total{receiver="hostmetrics",scraper="memory"} 2
# HELP otelcol_target_info Target metadata

obsreport/obsreporttest/otelprometheuschecker.go

obsreport/obsreport_scraper.go

.chloggen/obsreport-scraper.yaml

obsreport/obsreport_scraper.go

* instrument obsreport.scraper metrics with otel go

.chloggen/obsreport-scraper.yaml

obsreport/obsreport_scraper.go

obsreport/obsreporttest/otelprometheuschecker.go

bogdandrutu · 2022-11-15T22:39:54Z

obsreport/obsreport_test.go

-
-	parentCtx, parentSpan := tt.TracerProvider.Tracer("test").Start(context.Background(), t.Name())
-	defer parentSpan.End()
+	testTelemetry(t, func(tt obsreporttest.TestTelemetry, registry *featuregate.Registry) {


This API is horrible, makes everything be super indented...

/cc @paivagustavo

@jmacd suggested the creation of new top level function tests as 5961f60, which keeps the same indentation for the existing tests and can be easily removed once we're done with the transition.

cc @moh-osman3

Please refactor as suggested, and we can get this finalized + merged

Let me know if my latest commit matches what was suggested.

codecov · 2022-11-17T02:23:37Z

Codecov Report

Base: 91.33% // Head: 90.96% // Decreases project coverage by -0.36% ⚠️

Coverage data is based on head (ee51526) compared to base (375a859).
Patch coverage: 85.71% of modified lines in pull request are covered.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #6460      +/-   ##
==========================================
- Coverage   91.33%   90.96%   -0.37%     
==========================================
  Files         242      241       -1     
  Lines       13888    14063     +175     
==========================================
+ Hits        12684    12792     +108     
- Misses        959     1019      +60     
- Partials      245      252       +7

Impacted Files	Coverage Δ
internal/obsreportconfig/obsreportconfig.go	`94.17% <75.00%> (-2.74%)`	⬇️
obsreport/obsreport_scraper.go	`91.30% <84.90%> (+1.72%)`	⬆️
obsreport/obsreporttest/obsreporttest.go	`83.62% <100.00%> (-3.48%)`	⬇️
obsreport/obsreporttest/otelprometheuschecker.go	`94.05% <100.00%> (+0.65%)`	⬆️
consumer/consumertest/base_consumer.go	`0.00% <0.00%> (-100.00%)`	⬇️
component/config.go	`0.00% <0.00%> (-40.00%)`	⬇️
component/component.go	`62.22% <0.00%> (-37.78%)`	⬇️
component/componenttest/nop_factories.go	`0.00% <0.00%> (-29.42%)`	⬇️
processor/batchprocessor/metrics.go	`84.71% <0.00%> (-15.29%)`	⬇️
component/extension.go	`86.66% <0.00%> (-13.34%)`	⬇️
... and 10 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

obsreport/obsreport_scraper.go

codeboten · 2022-11-17T16:45:07Z

obsreport/obsreport_test.go

-
-	parentCtx, parentSpan := tt.TracerProvider.Tracer("test").Start(context.Background(), t.Name())
-	defer parentSpan.End()
+	testTelemetry(t, func(tt obsreporttest.TestTelemetry, registry *featuregate.Registry) {


Please refactor as suggested, and we can get this finalized + merged

codeboten

Thanks @moh-osman3!

moh-osman3 requested review from a team and Aneurysm9 November 2, 2022 02:28

moh-osman3 force-pushed the mohosman/instrument-obsreport-scraper-and-test branch from 3b37e8f to 45a051a Compare November 3, 2022 17:27

paivagustavo reviewed Nov 3, 2022

View reviewed changes

obsreport/obsreporttest/otelprometheuschecker.go Outdated Show resolved Hide resolved

obsreport/obsreport_scraper.go Outdated Show resolved Hide resolved

moh-osman3 changed the title ~~Instrument obsreport.Scraper (#19)~~ Instrument obsreport.Scraper Nov 3, 2022

moh-osman3 force-pushed the mohosman/instrument-obsreport-scraper-and-test branch 2 times, most recently from bdc7135 to 3436c45 Compare November 9, 2022 18:36

bogdandrutu reviewed Nov 14, 2022

View reviewed changes

.chloggen/obsreport-scraper.yaml Outdated Show resolved Hide resolved

obsreport/obsreport_scraper.go Outdated Show resolved Hide resolved

moh-osman3 and others added 5 commits November 14, 2022 22:12

Instrument obsreport.Scraper (#19)

34e94fd

* instrument obsreport.scraper metrics with otel go

add changelog

0f05e8b

update API to use MustNewScraper

23001c9

fix typo add testing for checkScraperMetrics

11c682c

remove accidental merge conflict references

238e140

moh-osman3 force-pushed the mohosman/instrument-obsreport-scraper-and-test branch from adb6a40 to 238e140 Compare November 15, 2022 03:13

fix references after rebase

e4dde75

moh-osman3 requested review from bogdandrutu and removed request for Aneurysm9 November 15, 2022 17:12

bogdandrutu reviewed Nov 15, 2022

View reviewed changes

.chloggen/obsreport-scraper.yaml Outdated Show resolved Hide resolved

obsreport/obsreport_scraper.go Outdated Show resolved Hide resolved

address review comments

87d68fd

moh-osman3 requested a review from bogdandrutu November 15, 2022 20:23

remove unneded log

f08252f

bogdandrutu approved these changes Nov 15, 2022

View reviewed changes

add newlines

8040fb4

moh-osman3 requested a review from bogdandrutu November 16, 2022 18:21

bogdandrutu approved these changes Nov 17, 2022

View reviewed changes

run gofmt

80e28b1

codeboten reviewed Nov 17, 2022

View reviewed changes

fix indenting

ee51526

moh-osman3 requested a review from codeboten November 17, 2022 18:29

codeboten approved these changes Nov 17, 2022

View reviewed changes

bogdandrutu merged commit 4565692 into open-telemetry:main Nov 17, 2022

moh-osman3 mentioned this pull request Aug 15, 2023

REQUEST: New membership for moh-osman3 open-telemetry/community#1647

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Instrument obsreport.Scraper #6460

Instrument obsreport.Scraper #6460

moh-osman3 commented Nov 2, 2022 •

edited

Loading

bogdandrutu Nov 15, 2022

paivagustavo Nov 17, 2022

codeboten Nov 17, 2022

moh-osman3 Nov 17, 2022

codecov bot commented Nov 17, 2022 •

edited

Loading

codeboten Nov 17, 2022

codeboten left a comment

Instrument obsreport.Scraper #6460

Instrument obsreport.Scraper #6460

Conversation

moh-osman3 commented Nov 2, 2022 • edited Loading

bogdandrutu Nov 15, 2022

Choose a reason for hiding this comment

paivagustavo Nov 17, 2022

Choose a reason for hiding this comment

codeboten Nov 17, 2022

Choose a reason for hiding this comment

moh-osman3 Nov 17, 2022

Choose a reason for hiding this comment

codecov bot commented Nov 17, 2022 • edited Loading

Codecov Report

codeboten Nov 17, 2022

Choose a reason for hiding this comment

codeboten left a comment

Choose a reason for hiding this comment

moh-osman3 commented Nov 2, 2022 •

edited

Loading

codecov bot commented Nov 17, 2022 •

edited

Loading