cmd

package
v0.6.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 5, 2022 License: MIT Imports: 12 Imported by: 0

README

cmd

Contains applications (apps) used in Substation deployments. Apps are organized by either the infrastructure they are deployed to (e.g., AWS) or the source of the data (e.g., file, http).

Any app that implements the ingest, transform, load (ITL) functionality of Substation is named substation and shares the same configuration file format (see build/config/ for more information).

app.go

Contains the core Substation application code. This code can be used to create new Substation applications.

design

Substation operates using a system of goroutines and channels:

  • data ingest, transform, and load are handled by unique goroutines
  • data streams between goroutines using a pipeline pattern
  • errors in any goroutine interrupt the application

This execution model was chosen for its ability to support horizontal scaling, high-latency data processing, and efficient delivery of data.

aws/lambda

Contains Substation apps deployed as AWS Lambda functions. More information is available in cmd/aws/lambda/README.md.

file/substation

Reads and processes data stored in a local file. The app can be deployed anywhere, including non-container infrastructure, and is recommended for local testing and development.

Documentation

Overview

package cmd provides definitions and methods for building Substation applications.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func New added in v0.5.0

func New() *substation

New returns an initialized Substation app. If an error occurs during initialization, then this function will panic.

Concurrency is controlled using the SUBSTATION_CONCURRENCY environment variable and defaults to the number of CPUs on the host. In native Substation applications, this value determines the number of transform goroutines; if set to 1, then multi-core processing is not enabled.

Types

This section is empty.

Directories

Path Synopsis
aws
file
substation command

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL