Files
espurna/code/espurna/prometheus.cpp
Max Prokhorov 8e80a7786c api: rework plain and JSON implementations (#2405)
- match paths through a custom AsyncWebHandler instead of using generic not-found fallback handler
- allow MQTT-like patterns when registering paths (`simple/path`, `path/+/something`, `path/#`)
Replaces `relay/0`, `relay/1` etc. with `relay/+`. Magnitudes are plain paths, but using `/+` in case there's more than 1 magnitude of the same type.
- restore `std::function` as callback container (no more single-byte arg nonsense). Still, limit to 1 type per handler type
- adds JSON handlers which will receive JsonObject root as both input and output. Same logic as plain - GET returns resource data, PUT updates it.
- breaking change to `apiAuthenticate(request)`, it no longer will do `request->send(403)` and expect this to be handled externally.
- allow `Api-Key` header containing the key, works for both GET & PUT plain requests. The only way to set apikey for JSON.
- add `ApiRequest::param` to retrieve both GET and PUT params (aka args), remove ApiBuffer
- remove `API_BUFFER_SIZE`. Allow custom form-data key=value pairs for requests, allow to send basic `String`.
- add `API_JSON_BUFFER_SIZE` for the JSON buffer (both input and output)
- `/apis` replaced with `/api/list`, no longer uses custom handler and is an `apiRegister` callback
- `/api/rpc` custom handler replaced with an `apiRegister` callback

WIP further down:
- no more `webLog` for API requests, unless `webAccessLog` / `WEB_ACCESS_LOG` is set to `1`. This also needs to happen to the other handlers. 
- migrate to ArduinoJson v6, since it become apparent it is actually a good upgrade :)
- actually make use of JSON endpoints more, right now it's just existing GET for sensors and relays
- fork ESPAsyncWebServer to cleanup path parsing and temporary objects attached to the request (also, fix things a lot of things based on PRs there...)
2020-12-05 14:14:38 +03:00

91 lines
2.3 KiB
C++

/*
PROMETHEUS METRICS MODULE
Copyright (C) 2020 by Maxim Prokhorov <prokhorov dot max at outlook dot com>
*/
#include "espurna.h"
#if WEB_SUPPORT && PROMETHEUS_SUPPORT
#include "prometheus.h"
#include "api.h"
#include "relay.h"
#include "sensor.h"
#include "web.h"
#include <cmath>
void _prometheusRequestHandler(AsyncWebServerRequest* request) {
static_assert((RELAY_SUPPORT) || (SENSOR_SUPPORT), "");
// TODO: Add more stuff?
// Note: Response 'stream' backing buffer is customizable. Default is 1460 bytes (see ESPAsyncWebServer.h)
// In case printf overflows, memory of CurrentSize+N{overflow} will be allocated to replace
// the existing buffer. Previous buffer will be copied into the new and destroyed after that.
AsyncResponseStream *response = request->beginResponseStream("text/plain");
#if RELAY_SUPPORT
for (unsigned char index = 0; index < relayCount(); ++index) {
response->printf("relay%u %d\n", index, static_cast<int>(relayStatus(index)));
}
#endif
#if SENSOR_SUPPORT
char buffer[64] { 0 };
for (unsigned char index = 0; index < magnitudeCount(); ++index) {
auto value = magnitudeValue(index);
if (std::isnan(value.get()) || std::isinf(value.get())) {
continue;
}
String topic(magnitudeTopicIndex(index));
topic.replace("/", "");
magnitudeFormat(value, buffer, sizeof(buffer));
response->printf("%s %s\n", topic.c_str(), buffer);
}
#endif
response->write('\n');
request->send(response);
}
#if API_SUPPORT
void prometheusSetup() {
apiRegister(F("metrics"),
[](ApiRequest& request) {
request.handle(_prometheusRequestHandler);
return true;
},
nullptr
);
}
#else
void prometheusSetup() {
webRequestRegister([](AsyncWebServerRequest* request) {
if (request->url().equals(F(API_BASE_PATH "metrics"))) {
if (apiAuthenticate(request)) {
_prometheusRequestHandler(request);
return true;
}
request->send(403);
return true;
}
return false;
});
}
#endif // API_SUPPORT
#endif // PROMETHEUS_SUPPORT