-
Notifications
You must be signed in to change notification settings - Fork 281
/
doc.go
157 lines (156 loc) · 4.92 KB
/
doc.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
// Copyright (c) 2017 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
// Package fx is the UberFx Service Framework.
//
// UberFx is a flexible, modularized framework for building robust and performant
// services. It takes care of the boilerplate code and lets you focus on your
// application logic.
//
//
// Status
//
// Beta. Expect minor API changes and bug fixes. See our changelog (CHANGELOG.md)for more.
//
//
// What's included
//
// UberFx builds the following into your service:
//
// • Logging backed by the zap logger
//
// • Configuration provider that seamlessly merges static and dynamic config
//
// • Application-level as well as runtime metrics for effective monitoring
//
// • Request tracing for application-level instrumentation
//
// • Context-aware logging for easy debugging
//
// • RPC module with Thrift interfaces for microservices
//
// • HTTP module with intelligent defaults for web applications
//
// • Task module for executing async tasks durably
//
// Examples
//
// To get a feel for what an UberFx service looks like, see our
// examples (examples/).
//
// Service Model
//
// A service is a container for a set of **modules** and controls their lifecycle.
// A service can have any number of modules, each 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 (service/README.md)
//
// Core Packages
//
// The top-level packages contain the nuts and bolts useful for a fully-fledged
// service. That said, none (except for
// service) requires an instance or even
// the idea of a service. You can use the packages independently.
//
//
// If, for example, you only want use the configuration logic from UberFx, you
// can import
// go.uber.org/fx/config and use it in a standalone CLI app.
//
// The service package contains logic specific to a running service. configis separate from
// service.
//
// Modules
//
// A modules is a pluggable component that provides an encapsulated set of
// functionality, and all modules are managed by the service.
//
//
// Implemented modules:
//
// • HTTP server
//
// • TChannel server
//
// • Async task execution
//
// Planned modules:
//
// • Kafka ingester
//
// • Delayed jobs
//
// Module Configuration
//
// You give your modules named keys for the purpose of looking up their
// configuration. This naming is arbitrary and only needs to be unique across
// modules. We do this because it's possible for a service to have multiple
// modules of the same type, such as multiple Kafka ingesters.
//
//
// modules:
// yarpc:
// bind: :28941
// advertiseName: kvserver
// uhttp:
// port: 8080
// timeout: 60s
//
// In this example, a module named: "yarpc" would look up its advertise name as
// modules.yarpc.advertiseName.
//
// Metrics
//
// UberFx exposes a simple, consistent way to track metrics and is built on top of
// Tally (https://github.com/uber-go/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).
//
// Configuration
//
// 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.
//
//
// Read more about configuration. (config/README.md)
//
// Compatibility
//
// UberFx is compatible with Go 1.7 and above.
//
// License
//
// MIT (LICENSE.txt)
//
//
package fx