Decide on naming rules for Settings structs #9428
Description
Per #9406 (comment) we want to have a set of naming rules for structs ending in Settings. Current (as of 1ed45ec) structs that have this are the following:
Output for rg 'type ([A-Z].*Settings|Settings) struct' -tgo --glob '!internal' (click to expand)
otelcol/collector.go
56:type CollectorSettings struct {
otelcol/configprovider.go
74:type ConfigProviderSettings struct {
extension/extension.go
66:type CreateSettings struct {
receiver/scraperhelper/obsreport.go
43:type ObsReportSettings struct {
receiver/receiverhelper/obsreport.go
47:type ObsReportSettings struct {
receiver/scraperhelper/settings.go
23:type ScraperControllerSettings struct {
connector/connector.go
65:type CreateSettings struct {
confmap/resolver.go
31:type ResolverSettings struct {
receiver/receiver.go
44:type CreateSettings struct {
processor/processor.go
35:type CreateSettings struct {
config/configgrpc/configgrpc.go
51:type GRPCClientSettings struct {
120:type GRPCServerSettings struct {
processor/processorhelper/obsreport.go
59:type ObsReportSettings struct {
service/extensions/extensions.go
165:type Settings struct {
component/telemetry.go
20:type TelemetrySettings struct {
service/service.go
37:type Settings struct {
exporter/exporter.go
35:type CreateSettings struct {
service/telemetry/telemetry.go
37:type Settings struct {
exporter/exporterhelper/queue_sender.go
31:type QueueSettings struct {
exporter/exporterhelper/timeout_sender.go
13:type TimeoutSettings struct {
exporter/exporterhelper/obsexporter.go
46:type ObsReportSettings struct {
Questions that arise to me are:
- Can we remove the
Createprefix fromCreateSettings? - Can we remove other prefixes (e.g.
GRPCfrom structs withinconfiggrpc,Collectorfromotelcol...)?
cc @dmitryax to fill in other rules.
Adding this to configgrpc milestone per the question above.
Metadata
Metadata
Assignees
Type
Projects
Status