generator

README

Conduit Connector Generator

General

The generator connector is one of Conduit builtin plugins. It generates sample records using its source connector. It has no destination and trying to use that will result in an error.

Note that the generator currently has no concept of resuming work. For example, if you have configured it to generate 100 records, let it run for some time, and then restart it (by restarting the pipeline or Conduit), then it will start generating the 100 records from scratch.

How to build it

Run make.

Testing

Run make test to run all the unit tests.

How it works

The data is generated in JSON format. The JSON objects themselves are generated using a field specification, which is explained in more details in the Configuration section below.

The connector is great for getting started with Conduit but also for certain types of performance tests.

It's possible to simulate a 'read' time for records. It's also possible to simulate bursts through "sleep and generate" cycles, where the connector is sleeping for some time (not generating any records), then generating records for the specified time, and then repeating the same cycle. The connector always start with the sleeping phase.

Configuration

recordCount

Number of records to be generated. -1 for no limit.

• Required: false
• Possible values: -1 or a non-negative number.
• Default: "-1"
• Example: "15" (generates 15 records)

readTime

The time it takes to 'read' a record.

• Required: false
• Possible values: A duration string, must not be negative. Also see: https://pkg.go.dev/time#ParseDuration
• Default: "0s"
• Example: "100ms" (generates records every 100ms)

format.type

Format of the generated payload data.

• Required: true
• Possible values: raw, structured, file
• Default: ""
• Example: "raw" (generates a record, with raw data payload)

format.options

An options string for the type of format specified in format.type.

• Required: true
• Possible values:
  • If format.type: raw or format.type: structured, format.options is a comma-separated list of name:type tokens, where type can be: int, string, time, bool. format.type will define how the payload will be serialized (it will be either raw or structured).
  • If format.type: file, format.options is a path to a file, which will be taken as a payload for the generated records. The file will be cached.
• Default: ""
• Example: "id:int,name:string" (generates a struct with an ID field, type int, and a name field, type string)

burst.sleepTime

The time the generator 'sleeps' between bursts.

• Required: false
• Possible values: A duration string, must not be negative. Also see: https://pkg.go.dev/time#ParseDuration
• Default: "0s"
• Example: "30s" (the generator sleeps for 30 seconds, then started generating records)

burst.generateTime

The amount of time the generator is generating records. Has effect only if burst.sleepTime is set.

• Required: false
• Possible values: A duration string, must be positive. Also see: https://pkg.go.dev/time#ParseDuration
• Default: max. duration in Go
• Example: "60s" (the generator will be generating records for 60 seconds)

Documentation

Index

• Constants
• Variables
• func NewSource() sdk.Source
• func Specification() sdk.Specification
• type Config
  • func Parse(config map[string]string) (Config, error)
• type RecordConfig
  • func ParseRecordConfig(formatType, formatOptions string) (RecordConfig, error)
• type Source
  • func (s *Source) Ack(ctx context.Context, position sdk.Position) error
  • func (s *Source) Configure(_ context.Context, config map[string]string) error
  • func (s *Source) Open(_ context.Context, _ sdk.Position) error
  • func (s *Source) Parameters() map[string]sdk.Parameter
  • func (s *Source) Read(ctx context.Context) (sdk.Record, error)
  • func (s *Source) Teardown(_ context.Context) error

Constants

const (
	RecordCount   = "recordCount"
	ReadTime      = "readTime"
	SleepTime     = "burst.sleepTime"
	GenerateTime  = "burst.generateTime"
	FormatType    = "format.type"
	FormatOptions = "format.options"

	FormatRaw        = "raw"
	FormatStructured = "structured"
	FormatFile       = "file"
)

Variables

var Connector = sdk.Connector{
	NewSpecification: Specification,
	NewSource:        NewSource,
	NewDestination:   nil,
}

Functions

func NewSource

func NewSource() sdk.Source

func Specification

func Specification() sdk.Specification

Specification returns the Plugin's Specification.

Types

type Config

type Config struct {
	RecordCount  int64
	ReadTime     time.Duration
	SleepTime    time.Duration
	GenerateTime time.Duration
	RecordConfig RecordConfig
}

func Parse

func Parse(config map[string]string) (Config, error)

type RecordConfig

type RecordConfig struct {
	FormatType    string
	FormatOptions interface{}
}

func ParseRecordConfig

func ParseRecordConfig(formatType, formatOptions string) (RecordConfig, error)

type Source

type Source struct {
	sdk.UnimplementedSource
	// contains filtered or unexported fields
}

Source connector

func (*Source) Ack

func (s *Source) Ack(ctx context.Context, position sdk.Position) error

func (*Source) Configure

func (s *Source) Configure(_ context.Context, config map[string]string) error

func (*Source) Open

func (s *Source) Open(_ context.Context, _ sdk.Position) error

func (*Source) Parameters

func (s *Source) Parameters() map[string]sdk.Parameter

func (*Source) Read

func (s *Source) Read(ctx context.Context) (sdk.Record, error)

func (*Source) Teardown

func (s *Source) Teardown(_ context.Context) error