[service] Validate pipeline type against component types #9257

ycombinator · 2024-01-10T02:55:05Z

Description:

This change adds another layer of validation to pipelines. It validates that all the components in a pipeline are of the same type as the pipeline.

For example, if a metrics pipeline contains a traces-only receiver, the otelcol validate -config ... command will fail.

Link to tracking Issue:
Fixes #8007.

Testing:
Added unit test + existing tests are passing.

Documentation:
godoc.

sfc-gh-bdrutu · 2024-01-17T04:06:58Z

service/service.go

@@ -141,6 +146,39 @@ func New(ctx context.Context, set Settings, cfg Config) (*Service, error) {
 	return srv, nil
 }

+func Validate(ctx context.Context, set Settings, cfg Config) error {


Why public?

Because it's being called from the otelcol package.

@ycombinator please take this as strong feedback that adding new public API to packages is discouraged at this time. Please add a godoc comment and prepare to discuss why this must be public.

Got it, thanks for letting me know about trying not to increase the public API surface. It makes sense. Let me see if I can reimplement this functionality without adding to the public API, otherwise I will add a godoc here.

Hmmm, I'm not really seeing an easy way around adding a new public API here given that the implementation of this function is using symbols from internal packages. But if there's some way to accomplish not adding
a new public API, I'm open to suggestions on how to go about it.

For now, I've added a godoc comment to this function as suggested.

Could we get the same result by just calling New? Is there a side effect to calling New which is being avoided by having a separate function?

Thanks for the suggestion, @djaglowski - it totally works! Not sure why I didn't consider that much simpler approach 🤦. Anyway, implemented in e373dd9.

sfc-gh-bdrutu · 2024-01-17T04:08:49Z

service/service.go

+	// validate the configuration
+	if err := validate(ctx, set, cfg, srv.telemetrySettings); err != nil {
+		return nil, err
+	}


Would we not find out about this error anyway when we call graph.Build?

Yes, that's true. I was trying to validate it even earlier than that but you're right — it doesn't really matter. Removing this call, thanks for catching it.

Removed in 8729b39.

sfc-gh-bdrutu · 2024-01-17T04:09:11Z

service/service.go

+	telSettings := servicetelemetry.TelemetrySettings{
+		Logger:         tel.Logger(),
+		TracerProvider: tel.TracerProvider(),
+		MeterProvider:  noop.NewMeterProvider(),
+	}


Why not using noop everywhere?

Do you mean for the Logger and TracerProvider fields? I'm not seeing anything in the noop package that could be used to initialize those fields.

github-actions · 2024-02-01T03:15:26Z

This PR was marked stale due to lack of activity. It will be closed in 14 days.

ycombinator · 2024-02-01T12:55:00Z

PR is still active; waiting on review.

codecov · 2024-02-12T07:46:00Z

Codecov Report

Attention: Patch coverage is 82.05128% with 14 lines in your changes are missing coverage. Please review.

Project coverage is 90.97%. Comparing base (c6d1482) to head (da1f5d8).
Report is 3 commits behind head on main.

❗ Current head da1f5d8 differs from pull request most recent head 58523a4. Consider uploading reports for the commit 58523a4 to get more accurate results

Files	Patch %	Lines
receiver/receivertest/nop_receiver.go	23.52%	13 Missing ⚠️
otelcol/collector.go	94.44%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #9257      +/-   ##
==========================================
- Coverage   91.31%   90.97%   -0.34%     
==========================================
  Files         357      353       -4     
  Lines       19202    18748     -454     
==========================================
- Hits        17534    17056     -478     
- Misses       1340     1364      +24     
  Partials      328      328

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

ycombinator · 2024-02-12T23:31:17Z

Hi @bogdandrutu, would you mind kicking off the CI checks again on this PR, please? Thanks!

ycombinator · 2024-02-13T00:44:58Z

Thanks @atoulme, for kicking off CI again. I've fixed another linter error (from impi) in 8b53d4e. Would you mind kicking off CI one more time, please? Thank you.

BTW, I noticed that CI, specifically the contrib-tests / contrib-tests-matrix (receiver-1) (pull_request) check, is failing on these tests from opentelemetry-collector-contrib:

--- FAIL: TestScrape (0.06s)
    --- FAIL: TestScrape/Standard (0.01s)
        network_scraper_test.go:234: 
            	Error Trace:	/tmp/opentelemetry-collector-contrib/receiver/hostmetricsreceiver/internal/scraper/networkscraper/network_scraper_test.go:234
            	            				/tmp/opentelemetry-collector-contrib/receiver/hostmetricsreceiver/internal/scraper/networkscraper/network_scraper_test.go:203
            	Error:      	Not equal: 
            	            	expected: 12
            	            	actual  : 13
            	Test:       	TestScrape/Standard
    --- FAIL: TestScrape/Standard_with_direction_removed (0.01s)
        network_scraper_test.go:234: 
            	Error Trace:	/tmp/opentelemetry-collector-contrib/receiver/hostmetricsreceiver/internal/scraper/networkscraper/network_scraper_test.go:234
            	            				/tmp/opentelemetry-collector-contrib/receiver/hostmetricsreceiver/internal/scraper/networkscraper/network_scraper_test.go:203
            	Error:      	Not equal: 
            	            	expected: 12
            	            	actual  : 13
            	Test:       	TestScrape/Standard_with_direction_removed
    --- FAIL: TestScrape/Validate_Start_Time (0.01s)
        network_scraper_test.go:234: 
            	Error Trace:	/tmp/opentelemetry-collector-contrib/receiver/hostmetricsreceiver/internal/scraper/networkscraper/network_scraper_test.go:234
            	            				/tmp/opentelemetry-collector-contrib/receiver/hostmetricsreceiver/internal/scraper/networkscraper/network_scraper_test.go:203
            	Error:      	Not equal: 
            	            	expected: 12
            	            	actual  : 13
            	Test:       	TestScrape/Validate_Start_Time
    --- FAIL: TestScrape/Include_Filter_that_matches_nothing (0.01s)
        network_scraper_test.go:234: 
            	Error Trace:	/tmp/opentelemetry-collector-contrib/receiver/hostmetricsreceiver/internal/scraper/networkscraper/network_scraper_test.go:234
            	            				/tmp/opentelemetry-collector-contrib/receiver/hostmetricsreceiver/internal/scraper/networkscraper/network_scraper_test.go:203
            	Error:      	Not equal: 
            	            	expected: 12
            	            	actual  : 13
            	Test:       	TestScrape/Include_Filter_that_matches_nothing
    --- FAIL: TestScrape/Conntrack_error_ignored_if_metric_disabled (0.01s)
        network_scraper_test.go:234: 
            	Error Trace:	/tmp/opentelemetry-collector-contrib/receiver/hostmetricsreceiver/internal/scraper/networkscraper/network_scraper_test.go:234
            	            				/tmp/opentelemetry-collector-contrib/receiver/hostmetricsreceiver/internal/scraper/networkscraper/network_scraper_test.go:203
            	Error:      	Not equal: 
            	            	expected: 12
            	            	actual  : 13
            	Test:       	TestScrape/Conntrack_error_ignored_if_metric_disabled
FAIL
FAIL	github.com/open-telemetry/opentelemetry-collector-contrib/receiver/hostmetricsreceiver/internal/scraper/networkscraper	0.081s

I'm not following how the failing assertion in a test for the hostmetricsreceiver component might be failing because of the change in this PR here. 🤔

atoulme · 2024-02-13T00:46:39Z

It's possible contrib CI is broken. Rerunning.

ycombinator · 2024-02-13T00:48:46Z

It's possible contrib CI is broken. Rerunning.

Thanks. ~~Or could it be because I'm not a OTel Community member (yet)?~~

[EDIT] Never mind, I misunderstood what you meant by "contrib CI". I understand now that you were referring to the failing tests, not the fact that you have to manually trigger CI runs for me on this PR.

atoulme · 2024-02-13T00:52:09Z

Nothing like that, we just run CI by checking out the latest main of contrib, which can break.

FWIW CI doesn't run for you on commit because this is your first PR. After you have a commit in the repository, CI will run when you push to your branch without our intervention.

github-actions · 2024-02-27T03:15:34Z

This PR was marked stale due to lack of activity. It will be closed in 14 days.

ycombinator · 2024-02-28T17:20:01Z

Hi @atoulme, could you please guide me on what's needed to merge this PR? I'm afraid it will be closed in 14 days otherwise due to being stale. Thanks!

atoulme · 2024-02-28T17:34:48Z

Hi @atoulme, could you please guide me on what's needed to merge this PR? I'm afraid it will be closed in 14 days otherwise due to being stale. Thanks!

you ask for review by pinging approvers. I'm not an approver. You can participate in the SIG meeting as well, which is happening right now, to ask for review.

ycombinator · 2024-04-09T06:08:44Z

@codeboten @bogdandrutu @dmitryax @mx-psi Would one of you have some time to review this PR and merge it if it's ready, please? It's been open for nearly three months now. Thank you!

mx-psi

Thanks, merging!

#### Description This PR reverts the change made in #9257 due to problems reported in #10031.  #### Link to tracking issue Fixes #10031.

#### Description This PR reverts the change made in open-telemetry#9257 due to problems reported in open-telemetry#10031.  #### Link to tracking issue Fixes open-telemetry#10031.

ycombinator changed the title ~~Validate pipeline types~~ service: validate pipeline type against component types Jan 10, 2024

ycombinator changed the title ~~service: validate pipeline type against component types~~ [service] validate pipeline type against component types Jan 10, 2024

ycombinator changed the title ~~[service] validate pipeline type against component types~~ [service] Validate pipeline type against component types Jan 10, 2024

ycombinator changed the title ~~[service] Validate pipeline type against component types~~ WIP [service] Validate pipeline type against component types Jan 10, 2024

ycombinator force-pushed the validate-pipeline-types branch 2 times, most recently from 2193534 to 2da328c Compare January 11, 2024 22:17

ycombinator changed the title ~~WIP [service] Validate pipeline type against component types~~ [service] Validate pipeline type against component types Jan 12, 2024

ycombinator marked this pull request as ready for review January 12, 2024 00:42

ycombinator requested a review from a team as a code owner January 12, 2024 00:42

ycombinator requested a review from bogdandrutu January 12, 2024 00:42

sfc-gh-bdrutu reviewed Jan 17, 2024

View reviewed changes

ycombinator force-pushed the validate-pipeline-types branch from 3218b81 to 8729b39 Compare January 17, 2024 22:21

ycombinator requested a review from sfc-gh-bdrutu January 17, 2024 22:59

github-actions bot added the Stale label Feb 1, 2024

ycombinator force-pushed the validate-pipeline-types branch from 8729b39 to 8eb53a6 Compare February 1, 2024 13:00

github-actions bot removed the Stale label Feb 2, 2024

ycombinator force-pushed the validate-pipeline-types branch from 8b5979d to be6c277 Compare February 12, 2024 23:24

github-actions bot added Stale and removed Stale labels Feb 27, 2024

ycombinator added 13 commits April 9, 2024 11:00

Remove accidentally committed file

1234101

Remove unnecessary validation when constructing new Service

a6e92be

Fix formatting

652454a

Make linter happy

fe472be

Make error check more resilient

7004bc6

Making impi happy

a49175b

Add godoc comment on service.Validate function

baeebb7

Call service.New to validate pipeline types

9903642

Use functional options to dynamically construct nop receiver

66fa0e4

Fix type mismatches

8669a58

Implement new nop factor constructor for specific data type

0294904

Run make fmt

ef47aa5

Update test

382fcae

ycombinator force-pushed the validate-pipeline-types branch from 972934d to 382fcae Compare April 9, 2024 06:05

ycombinator and others added 3 commits April 9, 2024 11:42

Fixing linting error with import groups

4e4f31b

Try reordering imports

9ba6c10

Merge branch 'main' into validate-pipeline-types

58523a4

mx-psi approved these changes Apr 10, 2024

View reviewed changes

mx-psi merged commit de3ef01 into open-telemetry:main Apr 10, 2024
46 of 47 checks passed

github-actions bot added this to the next release milestone Apr 10, 2024

ycombinator deleted the validate-pipeline-types branch April 10, 2024 14:07

mx-psi mentioned this pull request Apr 25, 2024

otelcol.Collector.DryRun() now instantiates all components #10031

Closed

TylerHelmuth mentioned this pull request Apr 29, 2024

[receiver/kubeletstats] validate command expects local certificate files. open-telemetry/opentelemetry-collector-contrib#32692

Closed

This was referenced Apr 30, 2024

[Flaky Test]: TestOtelFileProcessing – there should be exported logs by now elastic/elastic-agent#4617

Closed

Use otel version 0.97.0 elastic/elastic-agent#4638

Merged

ycombinator mentioned this pull request May 3, 2024

Revert pipeline type validation #10078

Merged

mergify bot mentioned this pull request May 8, 2024

[8.14](backport #4638) Use otel version 0.97.0 elastic/elastic-agent#4714

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[service] Validate pipeline type against component types #9257

[service] Validate pipeline type against component types #9257

ycombinator commented Jan 10, 2024 •

edited

Loading

sfc-gh-bdrutu Jan 17, 2024

ycombinator Jan 17, 2024

atoulme Feb 28, 2024

ycombinator Feb 29, 2024

ycombinator Mar 5, 2024 •

edited

Loading

djaglowski Mar 5, 2024

ycombinator Mar 5, 2024

sfc-gh-bdrutu Jan 17, 2024

ycombinator Jan 17, 2024

ycombinator Jan 17, 2024

sfc-gh-bdrutu Jan 17, 2024

ycombinator Jan 17, 2024

github-actions bot commented Feb 1, 2024

ycombinator commented Feb 1, 2024

codecov bot commented Feb 12, 2024 •

edited

Loading

ycombinator commented Feb 12, 2024

ycombinator commented Feb 13, 2024 •

edited

Loading

atoulme commented Feb 13, 2024

ycombinator commented Feb 13, 2024 •

edited

Loading

atoulme commented Feb 13, 2024

github-actions bot commented Feb 27, 2024

ycombinator commented Feb 28, 2024

atoulme commented Feb 28, 2024

ycombinator commented Apr 9, 2024

mx-psi left a comment

[service] Validate pipeline type against component types #9257

[service] Validate pipeline type against component types #9257

Conversation

ycombinator commented Jan 10, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ycombinator Mar 5, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Feb 1, 2024

ycombinator commented Feb 1, 2024

codecov bot commented Feb 12, 2024 • edited Loading

Codecov Report

ycombinator commented Feb 12, 2024

ycombinator commented Feb 13, 2024 • edited Loading

atoulme commented Feb 13, 2024

ycombinator commented Feb 13, 2024 • edited Loading

atoulme commented Feb 13, 2024

github-actions bot commented Feb 27, 2024

ycombinator commented Feb 28, 2024

atoulme commented Feb 28, 2024

ycombinator commented Apr 9, 2024

mx-psi left a comment

Choose a reason for hiding this comment

ycombinator commented Jan 10, 2024 •

edited

Loading

ycombinator Mar 5, 2024 •

edited

Loading

codecov bot commented Feb 12, 2024 •

edited

Loading

ycombinator commented Feb 13, 2024 •

edited

Loading

ycombinator commented Feb 13, 2024 •

edited

Loading