api: Expose mesh status #644
Conversation
The weaveworks mesh package reveals information about the current status of the mesh network between alertmanager instances. This commit exposes the current address and connection status of each instance connected to the targeted alertmanager instance via the /status API endpoint.
api/api.go
Outdated
| @@ -180,14 +184,40 @@ func (api *API) status(w http.ResponseWriter, req *http.Request) { | |||
| "buildDate": version.BuildDate, | |||
| "goVersion": version.GoVersion, | |||
| }, | |||
| Uptime: api.uptime, | |||
| Uptime: api.uptime, | |||
| MeshStatus: getStrippedDownMeshStatus(api), | |||
There was a problem hiding this comment.
you can remove the getStrippedDown ... meshStatus is perfect :)
api/api.go
Outdated
| } | ||
|
|
||
| api.mtx.RUnlock() | ||
|
|
||
| respond(w, status) | ||
| } | ||
|
|
||
| type strippedDownMeshStatus struct { |
api/api.go
Outdated
| Connections []strippedDownLocalConnectionStatus `json:"connections"` | ||
| } | ||
|
|
||
| type strippedDownLocalConnectionStatus struct { |
api/api.go
Outdated
|
|
||
| type strippedDownLocalConnectionStatus struct { | ||
| Address string `json:"address"` | ||
| State string `json:"state"` |
There was a problem hiding this comment.
Maybe describe in a comment what Address and State will look like. While I can imagine that Address will be an IPv4 address, an IPv6 address or a hostname I have no idea what State could be (maybe "healthy"?).
api/api.go
Outdated
|
|
||
| func getStrippedDownMeshStatus(api *API) strippedDownMeshStatus { | ||
| status := mesh.NewStatus(api.mrouter) | ||
| strippedStatus := strippedDownMeshStatus{ |
There was a problem hiding this comment.
Technically same here stripped, but I can see that that will cause collisions, generally speaking though you can keep the variable names much shorter. For example:
s := mesh.NewStatus(api.mrouter)
status := meshStatus{
...
}
|
Are we sure we want to use the information from https://godoc.org/github.com/weaveworks/mesh#PeerStatus Connections in the mesh will grow in complexity as we have more connected peers. The number of peers will remain overviewable. |
|
Exposing that information as some form of data visualization might be really cool (and infinitely more grokkable). I agree with @fabxc, as a user I would rather see which peers are in "my" mesh than know which ones a particular node is actively connected to. |
|
I was thinking those are probably the same, but looked a bit more into it and agree that a user is probably more interested in the peers themselves then the connections. |
Now meshStatus contains all peers (Name, NickName, UID) of the network. Additionally adding Name and Nickname of current target to toplevel of meshNetwork object.
|
👍 |
The weaveworks mesh package reveals information about the current status
of the mesh network between alertmanager instances. This commit exposes
the current address and connection status of each instance connected to
the targeted alertmanager instance via the /status API endpoint.