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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
|
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
#include "state_api.h"
#include <vespa/vespalib/net/connection_auth_context.h>
#include <vespa/vespalib/net/tls/capability.h>
#include <vespa/vespalib/util/jsonwriter.h>
#include <functional>
using vespalib::net::tls::Capability;
using vespalib::net::tls::CapabilitySet;
namespace vespalib {
namespace {
struct ConfigRenderer : ComponentConfigProducer::Consumer {
JSONStringer &json;
ConfigRenderer(JSONStringer &j) : json(j) {}
void add(const ComponentConfigProducer::Config &config) override {
json.appendKey(config.name);
json.beginObject();
json.appendKey("generation");
json.appendInt64(config.gen);
if (!config.msg.empty()) {
json.appendKey("message");
json.appendString(config.msg);
}
json.endObject();
}
};
struct ConfigGenerationObserver : ComponentConfigProducer::Consumer {
size_t maxGen;
bool seenSome;
ConfigGenerationObserver() : maxGen(0), seenSome(false) {}
void add(const ComponentConfigProducer::Config &config) override {
if (seenSome) {
maxGen = std::max(maxGen, config.gen);
} else {
maxGen = config.gen;
seenSome = true;
}
}
};
void build_health_status(JSONStringer &json, const HealthProducer &healthProducer) {
HealthProducer::Health health = healthProducer.getHealth();
json.appendKey("status");
json.beginObject();
json.appendKey("code");
if (health.ok) {
json.appendString("up");
} else {
json.appendString("down");
json.appendKey("message");
json.appendString(health.msg);
}
json.endObject();
}
vespalib::string get_consumer(const std::map<vespalib::string,vespalib::string> ¶ms,
vespalib::stringref default_consumer)
{
auto consumer_lookup = params.find("consumer");
if (consumer_lookup == params.end()) {
return default_consumer;
}
return consumer_lookup->second;
}
void render_link(JSONStringer &json, const vespalib::string &host, const vespalib::string &path) {
json.beginObject();
json.appendKey("url");
json.appendString("http://" + host + path);
json.endObject();
}
vespalib::string respond_root(const JsonHandlerRepo &repo, const vespalib::string &host) {
JSONStringer json;
json.beginObject();
json.appendKey("resources");
json.beginArray();
for (auto path: {"/state/v1/health", "/state/v1/metrics", "/state/v1/config"}) {
render_link(json, host, path);
}
for (const vespalib::string &path: repo.get_root_resources()) {
render_link(json, host, path);
}
json.endArray();
json.endObject();
return json.toString();
}
vespalib::string respond_health(const HealthProducer &healthProducer) {
JSONStringer json;
json.beginObject();
build_health_status(json, healthProducer);
json.endObject();
return json.toString();
}
vespalib::string respond_metrics(const vespalib::string &consumer,
const HealthProducer &healthProducer,
MetricsProducer &metricsProducer)
{
JSONStringer json;
json.beginObject();
build_health_status(json, healthProducer);
{ // metrics
vespalib::string metrics = metricsProducer.getMetrics(consumer);
if (!metrics.empty()) {
json.appendKey("metrics");
json.appendJSON(metrics);
}
}
json.endObject();
return json.toString();
}
vespalib::string respond_config(ComponentConfigProducer &componentConfigProducer) {
JSONStringer json;
json.beginObject();
{ // config
ConfigRenderer renderer(json);
json.appendKey("config");
json.beginObject();
ConfigGenerationObserver observer;
componentConfigProducer.getComponentConfig(observer);
if (observer.seenSome) {
json.appendKey("generation");
json.appendInt64(observer.maxGen);
}
componentConfigProducer.getComponentConfig(renderer);
json.endObject();
}
json.endObject();
return json.toString();
}
JsonGetHandler::Response cap_checked(const net::ConnectionAuthContext &auth_ctx,
CapabilitySet required_caps,
std::function<vespalib::string()> fn)
{
if (!auth_ctx.capabilities().contains_all(required_caps)) {
return JsonGetHandler::Response::make_failure(403, "Forbidden");
}
return JsonGetHandler::Response::make_ok_with_json(fn());
}
JsonGetHandler::Response cap_checked(const net::ConnectionAuthContext &auth_ctx,
Capability required_cap,
std::function<vespalib::string()> fn)
{
return cap_checked(auth_ctx, CapabilitySet::of({required_cap}), std::move(fn));
}
} // namespace vespalib::<unnamed>
JsonGetHandler::Response
StateApi::get(const vespalib::string &host,
const vespalib::string &path,
const std::map<vespalib::string,vespalib::string> ¶ms,
const net::ConnectionAuthContext &auth_ctx) const
{
if (path == "/state/v1/" || path == "/state/v1") {
return cap_checked(auth_ctx, CapabilitySet::make_empty(), [&] { // TODO consider http_unclassified
return respond_root(_handler_repo, host);
});
} else if (path == "/state/v1/health") {
return cap_checked(auth_ctx, CapabilitySet::make_empty(), [&] { // TODO consider http_unclassified
return respond_health(_healthProducer);
});
} else if (path == "/state/v1/metrics") {
// Using a 'statereporter' consumer by default removes many uninteresting per-thread
// metrics but retains their aggregates.
return cap_checked(auth_ctx, Capability::content_metrics_api(), [&] {
return respond_metrics(get_consumer(params, "statereporter"), _healthProducer, _metricsProducer);
});
} else if (path == "/state/v1/config") {
return cap_checked(auth_ctx, Capability::content_state_api(), [&] {
return respond_config(_componentConfigProducer);
});
} else if (path == "/metrics/total") {
return cap_checked(auth_ctx, Capability::content_metrics_api(), [&] {
return _metricsProducer.getTotalMetrics(get_consumer(params, ""));
});
} else {
// Assume this is for the nested state v1 stuff; may delegate capability check to handler later if desired.
if (!auth_ctx.capabilities().contains(Capability::content_state_api())) {
return Response::make_failure(403, "Forbidden");
}
return _handler_repo.get(host, path, params, auth_ctx);
}
}
//-----------------------------------------------------------------------------
StateApi::StateApi(const HealthProducer &hp,
MetricsProducer &mp,
ComponentConfigProducer &ccp)
: _healthProducer(hp),
_metricsProducer(mp),
_componentConfigProducer(ccp)
{
}
StateApi::~StateApi() = default;
} // namespace vespalib
|
