README
¶
/app/mortar
Code in this directory is related to Mortar and uber-fx
- Mortar Providers invocations.
- Builders
- Your constructors wrapped as
fx.Option - Tracing/Monitoring/Logger implicit configurations
HTTP
Constructors, options, interceptors and everything related to HTTP can be found in http.go
Monitoring
This template is ready to work with a Prometheus service. You need to configure it to expect a metric on this service default internal REST port.
mortar:
# Web server related configuration
server:
...
rest:
...
internal:
port: 5382
By default it's :5382/metrics
Constructors, options and everything else can be found in metrics.go.
Tracing
This template is assuming you will use Jaeger service.
In order for the bundled client to connect your Jaeger service you need to export some ENVIRONMENT variables.
export JAEGER_AGENT_HOST = localhost
export JAEGER_AGENT_PORT = 6831
export JAEGER_SAMPLER_TYPE = const
export JAEGER_SAMPLER_PARAM = 1
They are included in the makefile, when you execute make run they are exported.
Constructors, options and everything else can be found in tracing.go.
Logger
This template is using the zerolog library.
Zerolog can be configured to output in JSON format which is useful in production or the Console format which is useful for debug/local environments.
By default it is configured to use the Console format.
You can export SERVER_LOGGER_CONSOLE=false environment variable to disable this behavior in production or change the config.yml file.
Constructors, options and everything else can be found in logger.go.
Config
This template is using the viper library.
Constructors, options and everything else can be found in config.go.
Authentication
This template doesn't enforce any Authentication. However there is a sample code showing how you can parse a JWT if found.
Default usage can be found in ../validations/auth.go
Constructors, options and everything else can be found in auth.go.
Documentation
¶
Index ¶
- func AuthFxOptions() fx.Option
- func HttpClientFxOptions() fx.Option
- func HttpServerFxOptions() fx.Option
- func InternalHttpHandlersFxOptions() fx.Option
- func JaegerBuilder(lc fx.Lifecycle, config cfg.Config, logger log.Logger) (opentracing.Tracer, error)
- func LoggerFxOption() fx.Option
- func PrometheusBuilder(cfg cfg.Config) monitor.Builder
- func PrometheusFxOption() fx.Option
- func ServiceAPIsAndOtherDependenciesFxOption() fx.Option
- func TracerFxOption() fx.Option
- func ViperFxOption(configFilePath string, additionalFilePaths ...string) fx.Option
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AuthFxOptions ¶
func HttpClientFxOptions ¶
func HttpServerFxOptions ¶
func InternalHttpHandlersFxOptions ¶
These will help you to debug/profile or understand the internals of your service
func JaegerBuilder ¶
func JaegerBuilder(lc fx.Lifecycle, config cfg.Config, logger log.Logger) (opentracing.Tracer, error)
JaegerBuilder constructor assumes you have JAEGER environment variables set
https://github.com/jaegertracing/jaeger-client-go#environment-variables
Once built it will register Lifecycle hooks (connect on start, close on stop)
func LoggerFxOption ¶
func PrometheusBuilder ¶
PrometheusBuilder returns a monitor.Builder that is implemented by Prometheus
func PrometheusFxOption ¶
PrometheusFxOption registers prometheus
func TracerFxOption ¶
Types ¶
This section is empty.
Source Files