grackle

Documentation

Index

• Constants
• Variables
• type IngestApp
  • func NewIngestApp(opts IngestOptions) *IngestApp
  • func (a *IngestApp) Start()
• type IngestOptions
• type RethinkdbOptions
• type TwitterOptions
• type WebApp
  • func NewWebApp(opts WebOptions) *WebApp
  • func (a *WebApp) Start()
• type WebOptions

Constants

const (
	// EnvLogLevel is the log level environment variable.
	EnvLogLevel = "GRK_LOG_LEVEL"
)

Variables

var (
	// Version is the application version.
	Version = "0.0.1"
)

Types

type IngestApp

type IngestApp struct {
	// contains filtered or unexported fields
}

IngestApp represents the Ingest process.

func NewIngestApp

func NewIngestApp(opts IngestOptions) *IngestApp

NewIngestApp will create a new IngestApp.

func (*IngestApp) Start

func (a *IngestApp) Start()

Start will initialize and run the application.

type IngestOptions

type IngestOptions struct {
	// LogLevel is the requested logging level for the application.
	LogLevel string

	// Twitter options.
	Twitter *TwitterOptions

	// RethinkDB options.
	RethinkDB *RethinkdbOptions
}

IngestOptions stores data for tweet ingestion.

type RethinkdbOptions

type RethinkdbOptions struct {
	Host              string
	Port              string
	Database          string
	Username          string
	Password          string
	TLSCACertPath     string
	TLSClientCertPath string
	TLSClientKeyPath  string
	TLSConfig         *tls.Config
}

RethinkdbOptions stores data related to a RethinkDB connection.

type TwitterOptions

type TwitterOptions struct {
	AccessToken    string
	AccessSecret   string
	ConsumerKey    string
	ConsumerSecret string
	Track          []string
	Logger         *logrusAnacondaLogger
}

TwitterOptions stores data related to a Twitter connection.

type WebApp

type WebApp struct {
	// contains filtered or unexported fields
}

WebApp represents the web ui process.

func NewWebApp

func NewWebApp(opts WebOptions) *WebApp

NewWebApp will create a new WebApp.

func (*WebApp) Start

func (a *WebApp) Start()

Start will initialize and run the application.

type WebOptions

type WebOptions struct {
	// LogLevel is the requested logging level for the application.
	LogLevel string

	// ListenAddress is the host:port to listen for requests.
	ListenAddress string

	// TemplateDir is the directory that contains HTML templates.
	TemplateDir string

	// RethinkDB options.
	RethinkDB *RethinkdbOptions
}

WebOptions stores configuration options for the server.