recorder

type Constructor ¶ added in v0.8.1

type Constructor interface {
	SetLogger(logger tools.FieldLogger)
	SetName(name string)
	SetIndexName(indexName string)
	SetEndpoint(endpoint string)
	SetTimeout(timeout time.Duration)
	SetBackoff(backoff int)
}

Constructor is an interface for setting up an object for testing.

type DataRecorder ¶

type DataRecorder interface {
	Name() string
	Record(context.Context, Job) error
	Ping() error
	IndexName() string
	Timeout() time.Duration
	Endpoint() string
	Backoff() int
}

DataRecorder receives a payload for shipping data to a repository. The repository should have the concept of index/database and type/table abstractions. See ElasticSearch for more information.

Notes ¶

Recorders should not change the index name coming in the payload unless they have a valid reason. The engine might add a date to this index name if the user has specified in the configuration file. Ping() should ping the endpoint and return nil if was successful. The Engine will not launch the reader if the ping result is an error. IndexName() comes from the configuration, but the engine takes over. Recorder() should record the Job and report the errors. When the context is timed-out or cancelled, the recorder should return with the context's error.

package main

import (
	"context"
	"fmt"
	"net/http"
	"net/http/httptest"
	"time"

	"github.com/arsham/expipe/datatype"
	"github.com/arsham/expipe/recorder"
	"github.com/arsham/expipe/recorder/testing"
)

func main() {
	ctx := context.Background()
	receivedPayload := make(chan string)
	pinged := false
	ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		if !pinged {
			pinged = true
			return
		}
		receivedPayload <- "I have received the payload!"
	}))
	defer ts.Close()

	rec := testing.GetRecorder(ts.URL)
	rec.Ping()

	fmt.Println("Pinging successful")
	payload := datatype.New([]datatype.DataType{
		datatype.NewStringType("key", "value"),
	})
	job := recorder.Job{
		Payload:   payload,
		IndexName: "my index",
		Time:      time.Now(),
	}

	go func() {
		err := rec.Record(ctx, job)
		if err != nil {
			panic("Wasn't expecting any errors")
		}
	}()
	fmt.Println(<-receivedPayload)
	fmt.Println("No errors reported")

	go rec.Record(ctx, job) // Issuing another job
	fmt.Println(<-receivedPayload)

}

Output:

Pinging successful
I have received the payload!
No errors reported
I have received the payload!

type EndpointNotAvailableError ¶ added in v0.9.2

type EndpointNotAvailableError struct {
	Endpoint string
	Err      error
}

EndpointNotAvailableError is returned when the endpoint is not available.

func (e EndpointNotAvailableError) Error() string

type InvalidEndpointError ¶ added in v0.9.2

type InvalidEndpointError string

InvalidEndpointError is returned when the endpoint is not a valid URL.

func (e InvalidEndpointError) Error() string

type InvalidIndexNameError ¶ added in v0.9.2

type InvalidIndexNameError string

InvalidIndexNameError is returned when the index name is invalid.

func (e InvalidIndexNameError) Error() string

type Job ¶ added in v0.7.0

type Job struct {
	// ID is the job ID generated at the time the payload was generated.
	ID token.ID

	// Payload has a Bytes() method for returning the data.
	// It is guaranteed to be json marshallable.
	Payload datatype.DataContainer

	// Time is the recorded time at the time of fetching data by the readers.
	// You should use this value to fetch the content of the payload
	Time time.Time

	// IndexName might be different than the one is set in the recorder.
	// Engine might decide to change it and you have to use the provided one.
	IndexName string

	// TypeName comes from the configuration of readers.
	TypeName string
}

Job is sent with a context and a payload to be recorded. If the TypeName and IndexName are different than the previous one, the recorder should use the ones engine provides. If any errors occurred, recorders should return the error on Read return value.

type LowBackoffValueError ¶ added in v0.9.2

type LowBackoffValueError int64

LowBackoffValueError is returned when the endpoint is not a valid URL.

func (e LowBackoffValueError) Error() string

type LowTimeout ¶ added in v0.9.2

type LowTimeout time.Duration

LowTimeout is returned when the interval is zero.

func (e LowTimeout) Error() string

type ParseTimeOutError ¶ added in v0.9.2

type ParseTimeOutError struct {
	Timeout string
	Err     error
}

ParseTimeOutError is returned when the timeout cannot be parsed.

func (e ParseTimeOutError) Error() string