Add configuration schemas for various components in the receiver category

Author: jkoronaAtCisco

.schemagen.yaml

@@ -11,6 +11,9 @@ mappings:
   go.opentelemetry.io/collector/component:
     ID:
       schemaType: string
+  github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/operator:
+    Config:
+      schemaType: ""
   golang.org/x/time/rate:
     Limit:
       schemaType: number

Makefile

@@ -702,7 +702,7 @@ generate-gh-issue-templates:
 SCHEMA_DIRS := $(shell find $(CURDIR) -path "*testdata*" -prune -o -name "config.schema.yaml" -exec dirname {} \; | sort -u)
 
 .PHONY: generate-schemas
-generate-schemas:
+generate-schemas: $(SCHEMAGEN)
 	@$(foreach dir,$(SCHEMA_DIRS), $(SCHEMAGEN) $(dir) -o $(dir);)
 
 .PHONY: checks

internal/coreinternal/consumerretry/config.schema.yaml

@@ -0,0 +1,20 @@
+$defs:
+  config:
+    description: Config defines configuration for retrying batches in case of receiving a retryable error from a downstream consumer. If the retryable error doesn't provide a delay, exponential backoff is applied.
+    type: object
+    properties:
+      enabled:
+        description: Enabled indicates whether to not retry sending logs in case of receiving a retryable error from a downstream consumer. Default is false.
+        type: boolean
+      initial_interval:
+        description: InitialInterval the time to wait after the first failure before retrying. Default value is 1 second.
+        type: string
+        format: duration
+      max_elapsed_time:
+        description: MaxElapsedTime is the maximum amount of time (including retries) spent trying to send a logs batch to a downstream consumer. Once this value is reached, the data is discarded. It never stops if MaxElapsedTime == 0. Default value is 5 minutes.
+        type: string
+        format: duration
+      max_interval:
+        description: MaxInterval is the upper bound on backoff interval. Once this value is reached the delay between consecutive retries will always be `MaxInterval`. Default value is 30 seconds.
+        type: string
+        format: duration

pkg/stanza/adapter/config.schema.yaml

@@ -0,0 +1,15 @@
+$defs:
+  base_config:
+    description: BaseConfig is the common configuration of a stanza-based receiver
+    type: object
+    properties:
+      operators:
+        type: array
+        items:
+          x-customType: github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/operator.Config
+      retry_on_failure:
+        $ref: github.com/open-telemetry/opentelemetry-collector-contrib/internal/coreinternal/consumerretry.config
+      storage:
+        x-pointer: true
+        type: string
+        x-customType: go.opentelemetry.io/collector/component.ID

pkg/stanza/entry/config.schema.yaml

@@ -0,0 +1,4 @@
+$defs:
+  severity:
+    description: Severity indicates the seriousness of a log entry
+    type: integer

pkg/stanza/operator/config.schema.yaml

@@ -0,0 +1 @@
+{}

pkg/stanza/operator/helper/config.schema.yaml

@@ -0,0 +1,153 @@
+$defs:
+  attributer_config:
+    description: AttributerConfig is the configuration of a attributer
+    type: object
+    properties:
+      attributes:
+        type: object
+        additionalProperties:
+          $ref: expr_string_config
+  basic_config:
+    description: BasicConfig provides a basic implemention for an operator config.
+    type: object
+    properties:
+      id:
+        type: string
+      type:
+        type: string
+  byte_size:
+    type: integer
+    x-customType: int64
+  expr_string_config:
+    description: ExprStringConfig is a string that represents an expression
+    type: string
+  identifier_config:
+    description: IdentifierConfig is the configuration of a resource identifier
+    type: object
+    properties:
+      resource:
+        type: object
+        additionalProperties:
+          $ref: expr_string_config
+  input_config:
+    description: InputConfig provides a basic implementation of an input operator config.
+    type: object
+    allOf:
+      - $ref: attributer_config
+      - $ref: identifier_config
+      - $ref: writer_config
+  output_config:
+    description: OutputConfig provides a basic implementation of an output operator config.
+    type: object
+    allOf:
+      - $ref: basic_config
+  parser_config:
+    description: ParserConfig provides the basic implementation of a parser config.
+    type: object
+    properties:
+      body:
+        x-pointer: true
+        $ref: github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/entry.field
+      parse_from:
+        $ref: github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/entry.field
+      parse_to:
+        $ref: github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/entry.rootable_field
+      scope_name:
+        x-pointer: true
+        $ref: scope_name_parser
+      severity:
+        x-pointer: true
+        $ref: severity_config
+      timestamp:
+        x-pointer: true
+        $ref: time_parser
+      trace:
+        x-pointer: true
+        $ref: trace_parser
+    allOf:
+      - $ref: transformer_config
+  scope_name_parser:
+    description: ScopeNameParser is a helper that parses severity onto an entry.
+    type: object
+    properties:
+      parse_from:
+        $ref: github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/entry.field
+  severity_config:
+    description: SeverityConfig allows users to specify how to parse a severity from a field.
+    type: object
+    properties:
+      mapping:
+        type: object
+        additionalProperties:
+          x-customType: any
+      overwrite_text:
+        type: boolean
+      parse_from:
+        x-pointer: true
+        $ref: github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/entry.field
+      preset:
+        type: string
+  span_id_config:
+    type: object
+    properties:
+      parse_from:
+        x-pointer: true
+        $ref: github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/entry.field
+  time_parser:
+    description: TimeParser is a helper that parses time onto an entry.
+    type: object
+    properties:
+      layout:
+        type: string
+      layout_type:
+        type: string
+      location:
+        type: string
+      parse_from:
+        x-pointer: true
+        $ref: github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/entry.field
+  trace_flags_config:
+    type: object
+    properties:
+      parse_from:
+        x-pointer: true
+        $ref: github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/entry.field
+  trace_id_config:
+    type: object
+    properties:
+      parse_from:
+        x-pointer: true
+        $ref: github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/entry.field
+  trace_parser:
+    description: TraceParser is a helper that parses trace spans (and flags) onto an entry.
+    type: object
+    properties:
+      span_id:
+        x-pointer: true
+        $ref: span_id_config
+      trace_flags:
+        x-pointer: true
+        $ref: trace_flags_config
+      trace_id:
+        x-pointer: true
+        $ref: trace_id_config
+  transformer_config:
+    description: TransformerConfig provides a basic implementation of a transformer config.
+    type: object
+    properties:
+      if:
+        type: string
+      on_error:
+        type: string
+    allOf:
+      - $ref: writer_config
+  writer_config:
+    description: WriterConfig is the configuration of a writer operator.
+    type: object
+    properties:
+      output:
+        type: array
+        items:
+          type: string
+    allOf:
+      - $ref: basic_config

pkg/stanza/operator/input/journald/config.schema.yaml

@@ -0,0 +1,46 @@
+$defs:
+  config:
+    description: Config is the configuration of a journald input operator
+    type: object
+    properties:
+      all:
+        type: boolean
+      convert_message_bytes:
+        type: boolean
+      directory:
+        x-pointer: true
+        type: string
+      dmesg:
+        type: boolean
+      files:
+        type: array
+        items:
+          type: string
+      grep:
+        type: string
+      identifiers:
+        type: array
+        items:
+          type: string
+      journalctl_path:
+        type: string
+      matches:
+        type: array
+        items:
+          $ref: match_config
+      merge:
+        type: boolean
+      namespace:
+        type: string
+      priority:
+        type: string
+      root_path:
+        type: string
+      start_at:
+        type: string
+      units:
+        type: array
+        items:
+          type: string
+    allOf:
+      - $ref: github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/operator/helper.input_config

pkg/stanza/operator/input/journald/metadata.yaml

@@ -2,7 +2,7 @@ type: journald
 
 status:
   disable_codecov_badge: true
-  class: pkg/stanza/operator/input
+  class: pkg
   stability:
     alpha: [logs]
   codeowners:

receiver/haproxyreceiver/config.schema.yaml

@@ -0,0 +1,5 @@
+type: object
+allOf:
+  - $ref: go.opentelemetry.io/collector/config/confighttp.client_config
+  - $ref: go.opentelemetry.io/collector/scraper/scraperhelper.controller_config
+  - $ref: ./internal/metadata.metrics_builder_config