# README
General Information
A scraper defines how to connect and scrape telemetry data from an external source.
Status | |
---|---|
Stability | development: metrics, logs |
Issues |
# Packages
Package scrapererror provides custom error types for scrapers.
Package scraperhelper provides utilities for scrapers.
No description provided by the author
# Functions
MakeFactoryMap takes a list of receiver factories and returns a map with factory type as keys.
NewFactory returns a Factory.
NewLogs creates a new Logs scraper.
NewMetrics creates a new Metrics scraper.
WithLogs overrides the default "error not supported" implementation for CreateLogs and the default "undefined" stability level.
WithMetrics overrides the default "error not supported" implementation for CreateMetrics and the default "undefined" stability level.
WithShutdown sets the function that will be called on shutdown.
WithStart sets the function that will be called on startup.
# Interfaces
Factory is factory interface for scrapers.
FactoryOption apply changes to Options.
Logs is the base interface for logs scrapers.
Metrics is the base interface for metrics scrapers.
Option apply changes to internal options.
# Type aliases
CreateLogsFunc is the equivalent of Factory.CreateLogs().
CreateMetricsFunc is the equivalent of Factory.CreateMetrics().
ScrapeFunc scrapes data.