bootstrap

Documentation

Index

• Constants
• type Config
• type Server
  • func NewServer(cfg *Config, app *fiber.App, logger mlog.Logger, ...) *Server
  • func (s *Server) Run(l *pkg.Launcher) error
  • func (s *Server) ServerAddress() string
• type ServerGRPC
  • func NewServerGRPC(cfg *Config, server *grpc.Server, logger mlog.Logger, ...) *ServerGRPC
  • func (sgrpc *ServerGRPC) ProtoAddress() string
  • func (sgrpc *ServerGRPC) Run(l *pkg.Launcher) error
• type Service
  • func InitServers() *Service
  • func (app *Service) Run()

Constants

const ApplicationName = "ledger"

Types

type Config

type Config struct {
	EnvName                 string `env:"ENV_NAME"`
	LogLevel                string `env:"LOG_LEVEL"`
	ServerAddress           string `env:"SERVER_ADDRESS"`
	ProtoAddress            string `env:"PROTO_ADDRESS"`
	PrimaryDBHost           string `env:"DB_HOST"`
	PrimaryDBUser           string `env:"DB_USER"`
	PrimaryDBPassword       string `env:"DB_PASSWORD"`
	PrimaryDBName           string `env:"DB_NAME"`
	PrimaryDBPort           string `env:"DB_PORT"`
	ReplicaDBHost           string `env:"DB_REPLICA_HOST"`
	ReplicaDBUser           string `env:"DB_REPLICA_USER"`
	ReplicaDBPassword       string `env:"DB_REPLICA_PASSWORD"`
	ReplicaDBName           string `env:"DB_REPLICA_NAME"`
	ReplicaDBPort           string `env:"DB_REPLICA_PORT"`
	MongoDBHost             string `env:"MONGO_HOST"`
	MongoDBName             string `env:"MONGO_NAME"`
	MongoDBUser             string `env:"MONGO_USER"`
	MongoDBPassword         string `env:"MONGO_PASSWORD"`
	MongoDBPort             string `env:"MONGO_PORT"`
	CasdoorAddress          string `env:"CASDOOR_ADDRESS"`
	CasdoorClientID         string `env:"CASDOOR_CLIENT_ID"`
	CasdoorClientSecret     string `env:"CASDOOR_CLIENT_SECRET"`
	CasdoorOrganizationName string `env:"CASDOOR_ORGANIZATION_NAME"`
	CasdoorApplicationName  string `env:"CASDOOR_APPLICATION_NAME"`
	CasdoorModelName        string `env:"CASDOOR_MODEL_NAME"`
	JWKAddress              string `env:"CASDOOR_JWK_ADDRESS"`
	RabbitMQHost            string `env:"RABBITMQ_HOST"`
	RabbitMQPortHost        string `env:"RABBITMQ_PORT_HOST"`
	RabbitMQPortAMQP        string `env:"RABBITMQ_PORT_AMPQ"`
	RabbitMQUser            string `env:"RABBITMQ_DEFAULT_USER"`
	RabbitMQPass            string `env:"RABBITMQ_DEFAULT_PASS"`
	RabbitMQExchange        string `env:"RABBITMQ_EXCHANGE"`
	RabbitMQKey             string `env:"RABBITMQ_KEY"`
	RabbitMQQueue           string `env:"RABBITMQ_QUEUE"`
	OtelServiceName         string `env:"OTEL_RESOURCE_SERVICE_NAME"`
	OtelLibraryName         string `env:"OTEL_LIBRARY_NAME"`
	OtelServiceVersion      string `env:"OTEL_RESOURCE_SERVICE_VERSION"`
	OtelDeploymentEnv       string `env:"OTEL_RESOURCE_DEPLOYMENT_ENVIRONMENT"`
	OtelColExporterEndpoint string `env:"OTEL_EXPORTER_OTLP_ENDPOINT"`
	RedisHost               string `env:"REDIS_HOST"`
	RedisPort               string `env:"REDIS_PORT"`
	RedisUser               string `env:"REDIS_USER"`
	RedisPassword           string `env:"REDIS_PASSWORD"`
}

Config is the top level configuration struct for the entire application.

type Server

type Server struct {
	mlog.Logger
	mopentelemetry.Telemetry
	// contains filtered or unexported fields
}

Server represents the http server for Ledger service.

func NewServer

func NewServer(cfg *Config, app *fiber.App, logger mlog.Logger, telemetry *mopentelemetry.Telemetry) *Server

NewServer creates an instance of Server.

func (*Server) Run

func (s *Server) Run(l *pkg.Launcher) error

Run runs the server.

func (*Server) ServerAddress

func (s *Server) ServerAddress() string

ServerAddress returns is a convenience method to return the server address.

type ServerGRPC

type ServerGRPC struct {
	mlog.Logger
	mopentelemetry.Telemetry
	// contains filtered or unexported fields
}

ServerGRPC represents the gRPC server for Ledger service.

func NewServerGRPC

func NewServerGRPC(cfg *Config, server *grpc.Server, logger mlog.Logger, telemetry *mopentelemetry.Telemetry) *ServerGRPC

NewServerGRPC creates an instance of gRPC Server.

func (*ServerGRPC) ProtoAddress

func (sgrpc *ServerGRPC) ProtoAddress() string

ProtoAddress returns is a convenience method to return the proto server address.

func (*ServerGRPC) Run

func (sgrpc *ServerGRPC) Run(l *pkg.Launcher) error

Run gRPC server.

type Service

type Service struct {
	*Server
	*ServerGRPC
	mlog.Logger
}

Service is the application glue where we put all top level components to be used.

func InitServers

func InitServers() *Service

InitServers initiate http and grpc servers.

func (*Service) Run

func (app *Service) Run()

Run starts the application. This is the only necessary code to run an app in main.go