Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(386)

Side by Side Diff: logdog/appengine/cmd/coordinator/README.md

Issue 2183233002: Add LogDog project and component documentation. (Closed) Base URL: https://github.com/luci/luci-go@master
Patch Set: Created 4 years, 4 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « logdog/appengine/README.md ('k') | logdog/client/README.md » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
(Empty)
1 LogDog Coordinator
2 ==================
3
4 The LogDog Coordinator is an AppEngine application that serves as a central
5 coordinating and interactive authority for a LogDog instance. The Coordinator
6 is responsible for:
7
8 * Supplying logs to end users through its logs API.
9 * Coordinating log stream state throughout its lifecycle.
10 * Handling Butler Prefix registration.
11 * Acting as a configuration authority for its deployment.
12 * Accepting stream registrations from **Collector** instances.
13 * Dispatching archival tasks to **Archivist** instances.
14
15 ## Modules
16
17 A **Coordinator** occupies the AppEngine space of a given cloud project, and
18 assumes ownership of that project's resources. It is composed of several
19 cooperative AppEngine modules.
20
21 ### Default
22
23 The [default](vmuser/) module exposes the
24 [Logs API](../../../api/endpoints/coordinator/logs/v1/) for log stream querying
25 and consumption.
26
27 It is currently an AppEngine Managed VM, since Managed VMs are the only type of
28 AppEngine instance that can use gRPC, and gRPC is needed to read from BigTable.
29
30 ### Services
31
32 The [services](services/) module exposes management endpoints to the instance's
33 microservices, notably the [Collector](../../../server/cmd/logdog_collector) and
34 [Archivist](../../../server/cmd/logdog_archivist) microservices. These endpoints
35 are used to coordinate the microservice-managed aspects of the log stream
36 lifecycle.
37
38 ### Backend
39
40 The [backend](backend/) module hosts the [Tumble](/tumble) journaled processing
41 service, which handles log stream lifecycle transitions and deadlines.
42
43 ### Static
44
45 The [static](static/) module hosts static content, including:
46 * The LogDog Web Application
47 * The LogDog Lightweight Stream Viewer
48 * `rpcexplorer`
OLDNEW
« no previous file with comments | « logdog/appengine/README.md ('k') | logdog/client/README.md » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698