mirror of
https://github.com/c-cube/tiny_httpd.git
synced 2026-03-16 02:09:54 -04:00
ba19880d75
* fix: use realpath to validate filesystem paths against traversal - add string_prefix helper to check path containment - compute root_canonical once per add_vfs_ call - use realpath only for filesystem (on_fs=true), keeping simple contains_dot_dot check for VFS - paths are already URL-decoded by Route.rest_of_path_urlencoded * fix: add header size limits to prevent memory exhaustion add optional limits to Headers.parse_: - max_headers: 100 (default) - max_header_size: 16KiB per header (default) - max_total_size: 256KiB total (default) returns 431 status code when limits exceeded per RFC 6585.
93 lines
2.4 KiB
OCaml
93 lines
2.4 KiB
OCaml
(** Expose metrics over HTTP in the prometheus format.
|
|
|
|
This sub-library [tiny_httpd.prometheus] provides definitions for counters,
|
|
gauges, and histogram, and endpoints to expose them for
|
|
{{:https://prometheus.io/} Prometheus} to scrape them.
|
|
|
|
@since 0.16 *)
|
|
|
|
type tags = (string * string) list
|
|
|
|
(** Registry for metrics. *)
|
|
module Registry : sig
|
|
type t
|
|
(** The registry contains a group of metrics *)
|
|
|
|
val create : unit -> t
|
|
|
|
val on_will_emit : t -> (unit -> unit) -> unit
|
|
(** [on_will_emit registry f] calls [f()] every time [emit buf registry] is
|
|
called (before the metrics start being emitted). This is useful to update
|
|
some metrics on demand. *)
|
|
|
|
val emit : Buffer.t -> t -> unit
|
|
(** Write metrics into the given buffer. The buffer will be cleared first
|
|
thing. *)
|
|
|
|
val emit_str : t -> string
|
|
end
|
|
|
|
val global : Registry.t
|
|
|
|
(** Counters *)
|
|
module Counter : sig
|
|
type t
|
|
(** A counter, monotonically increasing *)
|
|
|
|
val create : Registry.t -> ?tags:tags -> ?descr:string -> string -> t
|
|
val incr : t -> unit
|
|
val incr_by : t -> int -> unit
|
|
|
|
val incr_to : t -> int -> unit
|
|
(** Increment to the given number. If it's lower than the current value this
|
|
does nothing *)
|
|
end
|
|
|
|
(** Gauges *)
|
|
module Gauge : sig
|
|
type t
|
|
(** A gauge, taking arbitrary values *)
|
|
|
|
val create : Registry.t -> ?tags:tags -> ?descr:string -> string -> t
|
|
val set : t -> int -> unit
|
|
val incr : t -> unit
|
|
val incr_by : t -> int -> unit
|
|
val decr : t -> unit
|
|
val decr_by : t -> int -> unit
|
|
end
|
|
|
|
module Histogram : sig
|
|
type t
|
|
(** Histogram *)
|
|
|
|
val create :
|
|
Registry.t ->
|
|
?tags:tags ->
|
|
?descr:string ->
|
|
buckets:float list ->
|
|
string ->
|
|
t
|
|
|
|
val add : t -> float -> unit
|
|
end
|
|
|
|
val http_middleware : Registry.t -> Server.Middleware.t
|
|
(** Middleware to get basic metrics about HTTP requests *)
|
|
|
|
val add_route_to_server : Server.t -> Registry.t -> unit
|
|
(** Add a "/metrics" route to the server *)
|
|
|
|
val instrument_server : Server.t -> Registry.t -> unit
|
|
(** Add middleware and route *)
|
|
|
|
module GC_metrics : sig
|
|
type t
|
|
|
|
val create : Registry.t -> t
|
|
val update : t -> unit
|
|
|
|
val create_and_update_before_emit : Registry.t -> unit
|
|
(** [create_and_update_before_emit reg] creates new GC metrics, adds them to
|
|
the registry, and uses {!Registry.on_will_emit} to {!update} the metrics
|
|
every time the registry is polled. *)
|
|
end
|