LCOV - code coverage report
Current view: top level - app/fdctl/run/tiles - fd_metric.c (source / functions) Hit Total Coverage
Test: cov.lcov Lines: 10 85 11.8 %
Date: 2025-03-10 12:29:05 Functions: 2 8 25.0 %

          Line data    Source code
       1             : #include "../../version.h"
       2             : 
       3             : #include "../../../../disco/metrics/fd_prometheus.h"
       4             : #include "../../../../ballet/http/fd_http_server.h"
       5             : #include "../../../../util/net/fd_ip4.h"
       6             : 
       7             : #include <sys/types.h>
       8             : #include <sys/socket.h> /* SOCK_CLOEXEC, SOCK_NONBLOCK needed for seccomp filter */
       9             : #include <unistd.h>
      10             : #include <string.h>
      11             : 
      12             : #if defined(__aarch64__)
      13             : #include "generated/metric.arm64_seccomp.h"
      14             : #else
      15             : #include "generated/metric_seccomp.h"
      16             : #endif
      17             : 
      18             : #define FD_HTTP_SERVER_METRICS_MAX_CONNS          128
      19             : #define FD_HTTP_SERVER_METRICS_MAX_REQUEST_LEN    8192
      20             : #define FD_HTTP_SERVER_METRICS_OUTGOING_BUFFER_SZ (32UL<<20UL) /* 32MiB reserved for buffering metrics responses */
      21             : 
      22             : const fd_http_server_params_t METRICS_PARAMS = {
      23             :   .max_connection_cnt    = FD_HTTP_SERVER_METRICS_MAX_CONNS,
      24             :   .max_ws_connection_cnt = 0UL,
      25             :   .max_request_len       = FD_HTTP_SERVER_METRICS_MAX_REQUEST_LEN,
      26             :   .max_ws_recv_frame_len = 0UL,
      27             :   .max_ws_send_frame_cnt = 0UL,
      28             :   .outgoing_buffer_sz    = FD_HTTP_SERVER_METRICS_OUTGOING_BUFFER_SZ,
      29             : };
      30             : 
      31             : typedef struct {
      32             :   fd_topo_t * topo;
      33             : 
      34             :   fd_http_server_t * metrics_server;
      35             : } fd_metric_ctx_t;
      36             : 
      37             : FD_FN_CONST static inline ulong
      38           3 : scratch_align( void ) {
      39           3 :   return 128UL;
      40           3 : }
      41             : 
      42             : FD_FN_PURE static inline ulong
      43           3 : scratch_footprint( fd_topo_tile_t const * tile ) {
      44           3 :   (void)tile;
      45             : 
      46           3 :   ulong l = FD_LAYOUT_INIT;
      47           3 :   l = FD_LAYOUT_APPEND( l, alignof( fd_metric_ctx_t ), sizeof( fd_metric_ctx_t ) );
      48           3 :   l = FD_LAYOUT_APPEND( l, fd_http_server_align(), fd_http_server_footprint( METRICS_PARAMS ) );
      49           3 :   return FD_LAYOUT_FINI( l, scratch_align() );
      50           3 : }
      51             : 
      52             : static inline void
      53             : before_credit( fd_metric_ctx_t *   ctx,
      54             :                fd_stem_context_t * stem,
      55           0 :                int *               charge_busy ) {
      56           0 :   (void)stem;
      57           0 :   *charge_busy = fd_http_server_poll( ctx->metrics_server, 1 ); /* 1ms */
      58           0 : }
      59             : 
      60             : static fd_http_server_response_t
      61           0 : metrics_http_request( fd_http_server_request_t const * request ) {
      62           0 :   fd_metric_ctx_t * ctx = (fd_metric_ctx_t *)request->ctx;
      63             : 
      64           0 :   if( FD_UNLIKELY( request->method!=FD_HTTP_SERVER_METHOD_GET ) ) {
      65           0 :     return (fd_http_server_response_t){
      66           0 :       .status = 400,
      67           0 :     };
      68           0 :   }
      69             : 
      70           0 :   if( FD_LIKELY( !strcmp( request->path, "/metrics" ) ) ) {
      71           0 :     fd_prometheus_render_all( ctx->topo, ctx->metrics_server );
      72             : 
      73           0 :     fd_http_server_response_t response = {
      74           0 :       .status       = 200,
      75           0 :       .content_type = "text/plain; version=0.0.4",
      76           0 :     };
      77           0 :     if( FD_UNLIKELY( fd_http_server_stage_body( ctx->metrics_server, &response ) ) ) {
      78           0 :       FD_LOG_WARNING(( "fd_http_server_stage_body failed, metrics response too long" ));
      79           0 :       return (fd_http_server_response_t){
      80           0 :         .status = 500,
      81           0 :       };
      82           0 :     }
      83           0 :     return response;
      84           0 :   } else {
      85           0 :     return (fd_http_server_response_t){
      86           0 :       .status = 404,
      87           0 :     };
      88           0 :   }
      89           0 : }
      90             : 
      91             : static void
      92             : privileged_init( fd_topo_t *      topo,
      93           0 :                  fd_topo_tile_t * tile ) {
      94           0 :   void * scratch = fd_topo_obj_laddr( topo, tile->tile_obj_id );
      95             : 
      96           0 :   FD_SCRATCH_ALLOC_INIT( l, scratch );
      97           0 :   fd_metric_ctx_t * ctx = FD_SCRATCH_ALLOC_APPEND( l, alignof( fd_metric_ctx_t ), sizeof( fd_metric_ctx_t ) );
      98             : 
      99           0 :   fd_http_server_t * _metrics = FD_SCRATCH_ALLOC_APPEND( l, fd_http_server_align(), fd_http_server_footprint( METRICS_PARAMS ) );
     100             : 
     101           0 :   fd_http_server_callbacks_t metrics_callbacks = {
     102           0 :     .request = metrics_http_request,
     103           0 :   };
     104           0 :   ctx->metrics_server = fd_http_server_join( fd_http_server_new( _metrics, METRICS_PARAMS, metrics_callbacks, ctx ) );
     105           0 :   fd_http_server_listen( ctx->metrics_server, tile->metric.prometheus_listen_addr, tile->metric.prometheus_listen_port );
     106           0 : }
     107             : 
     108             : static void
     109             : unprivileged_init( fd_topo_t *      topo,
     110           0 :                    fd_topo_tile_t * tile ) {
     111           0 :   void * scratch = fd_topo_obj_laddr( topo, tile->tile_obj_id );
     112             : 
     113           0 :   FD_SCRATCH_ALLOC_INIT( l, scratch );
     114           0 :   fd_metric_ctx_t * ctx = FD_SCRATCH_ALLOC_APPEND( l, alignof( fd_metric_ctx_t ), sizeof( fd_metric_ctx_t ) );
     115             : 
     116           0 :   ctx->topo = topo;
     117             : 
     118           0 :   ulong scratch_top = FD_SCRATCH_ALLOC_FINI( l, 1UL );
     119           0 :   if( FD_UNLIKELY( scratch_top > (ulong)scratch + scratch_footprint( tile ) ) )
     120           0 :     FD_LOG_ERR(( "scratch overflow %lu %lu %lu", scratch_top - (ulong)scratch - scratch_footprint( tile ), scratch_top, (ulong)scratch + scratch_footprint( tile ) ));
     121             : 
     122           0 :   FD_LOG_WARNING(( "Prometheus metrics endpoint listening at http://" FD_IP4_ADDR_FMT ":%u/metrics", FD_IP4_ADDR_FMT_ARGS( tile->metric.prometheus_listen_addr ), tile->metric.prometheus_listen_port ));
     123           0 : }
     124             : 
     125             : static ulong
     126             : populate_allowed_seccomp( fd_topo_t const *      topo,
     127             :                           fd_topo_tile_t const * tile,
     128             :                           ulong                  out_cnt,
     129           0 :                           struct sock_filter *   out ) {
     130           0 :   void * scratch = fd_topo_obj_laddr( topo, tile->tile_obj_id );
     131           0 :   FD_SCRATCH_ALLOC_INIT( l, scratch );
     132           0 :   fd_metric_ctx_t * ctx = FD_SCRATCH_ALLOC_APPEND( l, alignof( fd_metric_ctx_t ), sizeof( fd_metric_ctx_t ) );
     133             : 
     134           0 :   populate_sock_filter_policy_metric( out_cnt, out, (uint)fd_log_private_logfile_fd(), (uint)fd_http_server_fd( ctx->metrics_server ) );
     135           0 :   return sock_filter_policy_metric_instr_cnt;
     136           0 : }
     137             : 
     138             : static ulong
     139             : populate_allowed_fds( fd_topo_t const *      topo,
     140             :                       fd_topo_tile_t const * tile,
     141             :                       ulong                  out_fds_cnt,
     142           0 :                       int *                  out_fds ) {
     143           0 :   void * scratch = fd_topo_obj_laddr( topo, tile->tile_obj_id );
     144           0 :   FD_SCRATCH_ALLOC_INIT( l, scratch );
     145           0 :   fd_metric_ctx_t * ctx = FD_SCRATCH_ALLOC_APPEND( l, alignof( fd_metric_ctx_t ), sizeof( fd_metric_ctx_t ) );
     146             : 
     147           0 :   if( FD_UNLIKELY( out_fds_cnt<3UL ) ) FD_LOG_ERR(( "out_fds_cnt %lu", out_fds_cnt ));
     148             : 
     149           0 :   ulong out_cnt = 0;
     150           0 :   out_fds[ out_cnt++ ] = 2; /* stderr */
     151           0 :   if( FD_LIKELY( -1!=fd_log_private_logfile_fd() ) )
     152           0 :     out_fds[ out_cnt++ ] = fd_log_private_logfile_fd(); /* logfile */
     153           0 :   out_fds[ out_cnt++ ] = fd_http_server_fd( ctx->metrics_server ); /* metrics listen socket */
     154           0 :   return out_cnt;
     155           0 : }
     156             : 
     157           0 : #define STEM_BURST (1UL)
     158           0 : #define STEM_LAZY ((long)10e6) /* 10ms */
     159             : 
     160           0 : #define STEM_CALLBACK_CONTEXT_TYPE  fd_metric_ctx_t
     161           0 : #define STEM_CALLBACK_CONTEXT_ALIGN alignof(fd_metric_ctx_t)
     162             : 
     163           0 : #define STEM_CALLBACK_BEFORE_CREDIT before_credit
     164             : 
     165             : #include "../../../../disco/stem/fd_stem.c"
     166             : 
     167             : fd_topo_run_tile_t fd_tile_metric = {
     168             :   .name                     = "metric",
     169             :   .rlimit_file_cnt          = FD_HTTP_SERVER_METRICS_MAX_CONNS+5UL, /* pipefd, socket, stderr, logfile, and one spare for new accept() connections */
     170             :   .populate_allowed_seccomp = populate_allowed_seccomp,
     171             :   .populate_allowed_fds     = populate_allowed_fds,
     172             :   .scratch_align            = scratch_align,
     173             :   .scratch_footprint        = scratch_footprint,
     174             :   .privileged_init          = privileged_init,
     175             :   .unprivileged_init        = unprivileged_init,
     176             :   .run                      = stem_run,
     177             : };

Generated by: LCOV version 1.14