timescale

README

Timescale reader

Timescale reader provides message repository implementation for Timescale.

Configuration

The service is configured using the environment variables presented in the following table. Note that any unset variables will be replaced with their default values.

Variable	Description	Default
MG_TIMESCALE_READER_LOG_LEVEL	Service log level	info
MG_TIMESCALE_READER_HTTP_HOST	Service HTTP host	localhost
MG_TIMESCALE_READER_HTTP_PORT	Service HTTP port	8180
MG_TIMESCALE_READER_HTTP_SERVER_CERT	Service HTTP server certificate path	""
MG_TIMESCALE_READER_HTTP_SERVER_KEY	Service HTTP server key path	""
MG_TIMESCALE_HOST	Timescale DB host	localhost
MG_TIMESCALE_PORT	Timescale DB port	5432
MG_TIMESCALE_USER	Timescale user	magistrala
MG_TIMESCALE_PASS	Timescale password	magistrala
MG_TIMESCALE_NAME	Timescale database name	messages
MG_TIMESCALE_SSL_MODE	Timescale SSL mode	disabled
MG_TIMESCALE_SSL_CERT	Timescale SSL certificate path	""
MG_TIMESCALE_SSL_KEY	Timescale SSL key	""
MG_TIMESCALE_SSL_ROOT_CERT	Timescale SSL root certificate path	""
MG_THINGS_AUTH_GRPC_URL	Things service Auth gRPC URL	localhost:7000
MG_THINGS_AUTH_GRPC_TIMEOUT	Things service Auth gRPC timeout in seconds	1s
MG_THINGS_AUTH_GRPC_CLIENT_TLS	Things service Auth gRPC TLS enabled flag	false
MG_THINGS_AUTH_GRPC_CA_CERTS	Things service Auth gRPC CA certificates	""
MG_AUTH_GRPC_URL	Auth service gRPC URL	localhost:7001
MG_AUTH_GRPC_TIMEOUT	Auth service gRPC timeout in seconds	1s
MG_AUTH_GRPC_CLIENT_TLS	Auth service gRPC TLS enabled flag	false
MG_AUTH_GRPC_CA_CERT	Auth service gRPC CA certificate	""
MG_JAEGER_URL	Jaeger server URL	http://jaeger:4318/v1/traces
MG_SEND_TELEMETRY	Send telemetry to magistrala call home server	true
MG_TIMESCALE_READER_INSTANCE_ID	Timescale reader instance ID	""

Deployment

The service itself is distributed as Docker container. Check the timescale-reader service section in docker-compose file to see how service is deployed.

To start the service, execute the following shell script:

# download the latest version of the service
git clone https://github.com/absmach/magistrala

cd magistrala

# compile the timescale writer
make timescale-writer

# copy binary to bin
make install

# Set the environment variables and run the service
MG_TIMESCALE_READER_LOG_LEVEL=[Service log level] \
MG_TIMESCALE_READER_HTTP_HOST=[Service HTTP host] \
MG_TIMESCALE_READER_HTTP_PORT=[Service HTTP port] \
MG_TIMESCALE_READER_HTTP_SERVER_CERT=[Service HTTP server cert] \
MG_TIMESCALE_READER_HTTP_SERVER_KEY=[Service HTTP server key] \
MG_TIMESCALE_HOST=[Timescale host] \
MG_TIMESCALE_PORT=[Timescale port] \
MG_TIMESCALE_USER=[Timescale user] \
MG_TIMESCALE_PASS=[Timescale password] \
MG_TIMESCALE_NAME=[Timescale database name] \
MG_TIMESCALE_SSL_MODE=[Timescale SSL mode] \
MG_TIMESCALE_SSL_CERT=[Timescale SSL cert] \
MG_TIMESCALE_SSL_KEY=[Timescale SSL key] \
MG_TIMESCALE_SSL_ROOT_CERT=[Timescale SSL Root cert] \
MG_THINGS_AUTH_GRPC_URL=[Things service Auth GRPC URL] \
MG_THINGS_AUTH_GRPC_TIMEOUT=[Things service Auth gRPC request timeout in seconds] \
MG_THINGS_AUTH_GRPC_CLIENT_TLS=[Things service Auth gRPC TLS enabled flag] \
MG_THINGS_AUTH_GRPC_CA_CERTS=[Things service Auth gRPC CA certificates] \
MG_AUTH_GRPC_URL=[Auth service Auth gRPC URL] \
MG_AUTH_GRPC_TIMEOUT=[Auth service Auth gRPC request timeout in seconds] \
MG_AUTH_GRPC_CLIENT_TLS=[Auth service Auth gRPC TLS enabled flag] \
MG_AUTH_GRPC_CA_CERT=[Auth service Auth gRPC CA certificates] \
MG_JAEGER_URL=[Jaeger server URL] \
MG_SEND_TELEMETRY=[Send telemetry to magistrala call home server] \
MG_TIMESCALE_READER_INSTANCE_ID=[Timescale reader instance ID] \
$GOBIN/magistrala-timescale-reader

Usage

Starting service will start consuming normalized messages in SenML format.

Comparator Usage Guide:

Comparator	Usage	Example
eq	Return values that are equal to the query	eq["active"] -> "active"
ge	Return values that are substrings of the query	ge["tiv"] -> "active" and "tiv"
gt	Return values that are substrings of the query and not equal to the query	gt["tiv"] -> "active"
le	Return values that are superstrings of the query	le["active"] -> "tiv"
lt	Return values that are superstrings of the query and not equal to the query	lt["active"] -> "active" and "tiv"

Official docs can be found here.

Documentation

Overview

Package timescale contains repository implementations using Timescale as the underlying database.

Index

• func Connect(cfg Config) (*sqlx.DB, error)
• func New(db *sqlx.DB) readers.MessageRepository
• type Config

Functions

func Connect

func Connect(cfg Config) (*sqlx.DB, error)

Connect creates a connection to the TimescaleSQL instance and applies any unapplied database migrations. A non-nil error is returned to indicate failure.

func New

func New(db *sqlx.DB) readers.MessageRepository

New returns new TimescaleSQL writer.

Types

type Config

type Config struct {
	Host        string
	Port        string
	User        string
	Pass        string
	Name        string
	SSLMode     string
	SSLCert     string
	SSLKey      string
	SSLRootCert string
}

Config defines the options that are used when connecting to a TimescaleSQL instance.