Skip to content

[pkg/scraperhelper] Switch scraper/scraperhelper to schema-based configuration#15318

Merged
dmitryax merged 11 commits into
open-telemetry:mainfrom
jkoronaAtCisco:scraperhelper_config_schema
May 20, 2026
Merged

[pkg/scraperhelper] Switch scraper/scraperhelper to schema-based configuration#15318
dmitryax merged 11 commits into
open-telemetry:mainfrom
jkoronaAtCisco:scraperhelper_config_schema

Conversation

@jkoronaAtCisco

@jkoronaAtCisco jkoronaAtCisco commented May 19, 2026

Copy link
Copy Markdown
Member

Description

Switch scraper/scraperhelper ControllerConfig to schema-based generated configuration.

This adds metadata-driven config generation for the scraper controller settings, publishes the reusable controller_config schema from pkg/scraperhelper, and updates the mdatagen sample scraper to embed that exported config via schema reference.

Link to tracking issue

Fixes #15258

Testing

Added usage example to samplescraper test component.

@jkoronaAtCisco
jkoronaAtCisco requested review from a team and dmitryax as code owners May 19, 2026 11:06
@codspeed-hq

codspeed-hq Bot commented May 19, 2026 •
edited
Loading

Copy link
Copy Markdown

Merging this PR will not alter performance

⚠️ Unknown Walltime execution environment detected

Using the Walltime instrument on standard Hosted Runners will lead to inconsistent data.

For the most accurate results, we recommend using CodSpeed Macro Runners: bare-metal machines fine-tuned for performance measurement consistency.

✅ 7 untouched benchmarks
⏩ 76 skipped benchmarks1

Comparing jkoronaAtCisco:scraperhelper_config_schema (517056a) with main (0881189)

Open in CodSpeed

Footnotes

  1. 76 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩

@codecov

codecov Bot commented May 19, 2026 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.23%. Comparing base (0881189) to head (517056a).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main   #15318      +/-   ##
==========================================
- Coverage   91.25%   91.23%   -0.02%     
==========================================
  Files         706      708       +2     
  Lines       46165    46171       +6     
==========================================
- Hits        42127    42124       -3     
- Misses       2830     2836       +6     
- Partials     1208     1211       +3

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@linux-foundation-easycla

linux-foundation-easycla Bot commented May 20, 2026 •
edited
Loading

Copy link
Copy Markdown

CLA Signed
The committers listed above are authorized under a signed CLA.

@jkoronaAtCisco
jkoronaAtCisco force-pushed the scraperhelper_config_schema branch from a0ea863 to 18cc709 Compare May 20, 2026 09:08
dmitryax
dmitryax approved these changes May 20, 2026
View reviewed changes

@dmitryax dmitryax left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

Comment thread scraper/scraperhelper/internal/controller/generated_config.go
"time"
)

// ControllerConfig ControllerConfig defines common settings for a scraper controller configuration. Scraper controller receivers can embed this struct, instead of receiver.Settings, and extend it with more fields if needed.

@dmitryax dmitryax May 20, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ControllerConfig is duplicated. Let's fix this separately

@dmitryax
dmitryax added this pull request to the merge queue May 20, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to failed status checks May 20, 2026
@dmitryax
dmitryax added this pull request to the merge queue May 20, 2026
Merged via the queue into open-telemetry:main with commit c5644ab May 20, 2026
68 checks passed
@jkoronaAtCisco
jkoronaAtCisco deleted the scraperhelper_config_schema branch May 21, 2026 09:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dmitryax dmitryax dmitryax approved these changes
@evan-bradley evan-bradley Awaiting requested review from evan-bradley
@mx-psi mx-psi Awaiting requested review from mx-psi
@dmathieu dmathieu Awaiting requested review from dmathieu
@bogdandrutu bogdandrutu Awaiting requested review from bogdandrutu
@andrzej-stencel andrzej-stencel Awaiting requested review from andrzej-stencel

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[cmd/mdatagen] Switch scraperhelper library to schema-based configs

2 participants

@jkoronaAtCisco @dmitryax