[receiver/tlscheck] Move Target Validation to scrape & Implement Scrape Errors #40341
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
michael-burt
commented
May 28, 2025
TylerHelmuth
reviewed
Jun 3, 2025
| if ct.Endpoint != "" && ct.FilePath != "" { | ||
| return errors.New("cannot specify both endpoint and file_path") | ||
| } | ||
| if ct.Endpoint == "" && ct.FilePath == "" { | ||
| return errors.New("must specify either endpoint or file_path") | ||
| } | ||
|
|
||
| // Validate endpoint if specified | ||
| if ct.Endpoint != "" { |
There was a problem hiding this comment.
Do these changes mean the collector can now start in an invalid state? We normally like to catch that at startup.
There was a problem hiding this comment.
We still do this validation, but we do it in the scrape function. The user can now include an invalid target, but it will be logged, the otelcol_scraper_errored_metric_points will be incremented, and the collector will not crash. As currently implemented, the collector will fail to start if there is an invalid target in the TLS Check configuration, such as a nonexistent file certificate. I do not think this is desirable behavior for the user. The new behavior matches that of the File Stats Receiver, HTTP Check Receiver, and others.
atoulme
approved these changes
Jun 4, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR moves target validation from
config.gotoscraper.go. This causes a change in behavior. Previously, the receiver would crash if a target failed validation. With this change, the receiver will log an error message and increment theotelcol_scraper_errored_metric_pointsmetric.Testing
I added tests for the new validation function.