mirror of
https://github.com/warmcat/libwebsockets.git
synced 2025-03-30 00:00:16 +01:00
d291c02a23
This provides a way to get ahold of LWS_WITH_CONMON telemetry from Secure
Streams, it works the same with direct onward connections or via the proxy.
You can mark streamtypes with a "perf": true policy attribute... this
causes the onward connections on those streamtypes to collect information
about the connection performance, and the unsorted DNS results.
Streams with that policy attribute receive extra data in their rx callback,
with the LWSSS_FLAG_PERF_JSON flag set on it, containing JSON describing the
performance of the onward connection taken from CONMON data, in a JSON
representation. Streams without the "perf" attribute set never receive
this extra rx.
The received JSON is based on the CONMON struct info and looks like
{"peer":"46.105.127.147","dns_us":596,"sockconn_us":31382,"tls_us":28180,"txn_resp_us:23015,"dns":["2001:41d0:2:ee93::1","46.105.127.147"]}
A new minimal example minimal-secure-streams-perf is added that collects
this data on an HTTP GET from warmcat.com, and is built with a -client
version as well if LWS_WITH_SECURE_STREAMS_PROXY_API is set, that operates
via the ss proxy and produces the same result at the client.
109 lines
4.2 KiB
C
109 lines
4.2 KiB
C
/*
|
|
* libwebsockets - small server side websockets and web server implementation
|
|
*
|
|
* Copyright (C) 2010 - 2021 Andy Green <andy@warmcat.com>
|
|
*
|
|
* 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.
|
|
*/
|
|
|
|
/** \defgroup conmon Connection Latency information
|
|
* ## Connection Latency information
|
|
*
|
|
* When LWS_WITH_CONMON is enabled at build, collects detailed statistics
|
|
* about the client connection setup latency, available to the connection
|
|
* itself
|
|
*/
|
|
///@{
|
|
|
|
/* enough for 4191us, or just over an hour */
|
|
typedef uint32_t lws_conmon_interval_us_t;
|
|
|
|
/*
|
|
* Connection latency information... note that not all wsi actually make
|
|
* connections, for example h2 streams after the initial one will have 0
|
|
* for everything except ciu_txn_resp.
|
|
*
|
|
* If represented in JSON, it should look like this
|
|
*
|
|
* {
|
|
* "peer": "46.105.127.147",
|
|
* "dns_us": 1234,
|
|
* "sockconn_us": 1234,
|
|
* "tls_us": 1234,
|
|
* "txn_resp_us": 1234,
|
|
* "dns":["46.105.127.147", "2001:41d0:2:ee93::1"]
|
|
* }
|
|
*/
|
|
|
|
struct lws_conmon {
|
|
lws_sockaddr46 peer46;
|
|
/**< The peer we actually connected to, if any. .peer46.sa4.sa_family
|
|
* is either 0 if invalid, or the AF_ */
|
|
|
|
struct addrinfo *dns_results_copy;
|
|
/**< NULL, or Allocated copy of dns results, owned by this object and
|
|
* freed when object destroyed.
|
|
* Only set if client flag LCCSCF_CONMON applied */
|
|
|
|
lws_conmon_interval_us_t ciu_dns;
|
|
/**< 0, or if a socket connection, us taken to acquire this DNS response
|
|
*
|
|
*/
|
|
lws_conmon_interval_us_t ciu_sockconn;
|
|
/**< 0, or if connection-based, the us interval between the socket
|
|
* connect() attempt that succeeded, and the connection setup */
|
|
lws_conmon_interval_us_t ciu_tls;
|
|
/**< 0 if no tls, or us taken to establish the tls tunnel */
|
|
lws_conmon_interval_us_t ciu_txn_resp;
|
|
/**< 0, or if the protocol supports transactions, the interval between
|
|
* sending the transaction request and starting to receive the resp */
|
|
};
|
|
|
|
/**
|
|
* lws_conmon_wsi_take() - create a connection latency object from client wsi
|
|
*
|
|
* \param context: lws wsi
|
|
* \param dest: conmon struct to fill
|
|
*
|
|
* Copies wsi conmon data into the caller's struct. Passes ownership of
|
|
* any allocations in the addrinfo list to the caller, lws will not delete that
|
|
* any more on wsi close after this call. The caller must call
|
|
* lws_conmon_release() on the struct to destroy any addrinfo in the struct
|
|
* that is prepared by this eventually but it can defer it as long as it wants.
|
|
*
|
|
* Other than the addrinfo list, the contents of the returned object are
|
|
* completely selfcontained and don't point outside of the object itself, ie,
|
|
* everything else in there remains in scope while the object itself does.
|
|
*/
|
|
LWS_VISIBLE LWS_EXTERN void
|
|
lws_conmon_wsi_take(struct lws *wsi, struct lws_conmon *dest);
|
|
|
|
/**
|
|
* lws_conmon_release() - free any allocations in the conmon struct
|
|
*
|
|
* \param conmon: pointer to conmon struct
|
|
*
|
|
* Destroys any allocations in the conmon struct so it can go out of scope.
|
|
* It doesn't free \p dest itself, it's designed to clean out a struct that
|
|
* is on the stack or embedded in another object.
|
|
*/
|
|
LWS_VISIBLE LWS_EXTERN void
|
|
lws_conmon_release(struct lws_conmon *conmon);
|
|
|
|
///@}
|