Pre-ALPHA. API Changes are highly likely.
This framework is a flexible, modularized basis for building robust and performant services at Uber with the minimum amount of developer code.
To get a feel for what an UberFx service looks like, see our examples.
A service is a container for a set of modules, controlling their lifecycle. Service can have any number of modules that are responsible for a specific type of functionality, such as a Kafka message ingestion, exposing an HTTP server, or a set of RPC service endpoints.
The core service is responsible for loading basic configuration and starting and stopping a set of these modules. Each module gets a reference to the service to access standard values such as the Service name or basic configuration.
Read more about the service model
The top-level packages (except for service) contain the nuts and bolts useful
to have in a fully-fledged service, but are not specific to an instance of a
service or even the idea of a service.
If, for example, you just want use the configuration logic from UberFx, you
could import go.uber.org/config and use it in a stand-alone CLI app.
It is separate from the service package, which contains logic specific to
a running service.
Modules are pluggable components that provide an encapsulated set of functionality that is managed by the service.
Implemented modules:
- HTTP server
- TChannel server
Planned modules:
- Kafka ingester
- Delayed jobs
Modules are given named keys by the developer for the purpose of looking up their configuration. This naming is arbitrary and only needs to be unique across modules and exists because it's possible that a service may have multiple modules of the same type, such as multiple Kafka ingesters.
modules:
yarpc:
bind: :28941
advertiseName: kvserver
http:
port: 8080
timeout: 60sIn this example, a module named: "rpc" would lookup it's advertise name as
modules.rpc.advertiseName.
UberFx exposes a simple, consistent way to track metrics and is built on top of Tally.
Internally, this uses a pluggable mechanism for reporting these values, so they
can be reported to M3, logging, etc., at the service owner's discretion.
By default the metrics are not reported (using a tally.NoopScope)
UberFx introduces a simplified configuration model that provides a consistent interface to configuration from pluggable configuration sources. This interface defines methods for accessing values directly or into strongly typed structs.
UberFx is compatible with Go 1.7 and above.