mirror of
https://github.com/hanzoai/telemetry.git
synced 2026-10-30 20:01:49 +00:00
8e9c14c012
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue. Ex. Adding a feature - Explain what this achieves.--> #### 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. <!-- Issue number if applicable --> #### Link to tracking issue Fixes #15258 <!--Describe what testing was performed and which tests were added.--> #### Testing Added usage example to `samplescraper` test component. --------- Co-authored-by: Dmitry Anoshin <[email protected]>
35 lines
1.3 KiB
YAML
35 lines
1.3 KiB
YAML
type: scraperhelper/controller
|
|
github_project: open-telemetry/opentelemetry-collector
|
|
parent: scraperhelper
|
|
|
|
status:
|
|
disable_codecov_badge: true
|
|
class: pkg
|
|
|
|
exported_configs:
|
|
controller_config:
|
|
description: 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.
|
|
type: object
|
|
properties:
|
|
collection_interval:
|
|
description: CollectionInterval sets how frequently the scraper should be called and used as the context timeout to ensure that scrapers don't exceed the interval.
|
|
type: string
|
|
x-customType: time.Duration
|
|
format: duration
|
|
default: 1m
|
|
initial_delay:
|
|
description: InitialDelay sets the initial start delay for the scraper, any non positive value is assumed to be immediately.
|
|
type: string
|
|
x-customType: time.Duration
|
|
format: duration
|
|
default: 1s
|
|
timeout:
|
|
description: Timeout is an optional value used to set scraper's context deadline.
|
|
type: string
|
|
x-customType: time.Duration
|
|
format: duration
|
|
default: 0
|
|
go_struct:
|
|
custom_validator:
|
|
name: validateControllerConfig
|