var documenterSearchIndex = {"docs":
[{"location":"#Prometheus.jl","page":"Prometheus.jl","title":"Prometheus.jl","text":"","category":"section"},{"location":"#Introduction","page":"Prometheus.jl","title":"Introduction","text":"","category":"section"},{"location":"","page":"Prometheus.jl","title":"Prometheus.jl","text":"This package is a Julia client for Prometheus. If you are not familiar with Prometheus it is recommended to browse the upstream documentation. The documentation here focuses on the Julia client.","category":"page"},{"location":"","page":"Prometheus.jl","title":"Prometheus.jl","text":"Two of the basic concepts of a Prometheus client are Registries and Collectors. Registries are collections of collectors, and the collectors are the units responsible to record and capture metrics. Client libraries implement a default registry which all collectors implicity register with, so for basic usage there is no need to interact with a registry (see Default collector registry).","category":"page"},{"location":"","page":"Prometheus.jl","title":"Prometheus.jl","text":"The third important concept is Exposition of the collected metrics. Typically metrics are exposed over a HTTP server, as in the Quickstart-example just below. See the section about Exposition for more details and examples on how metrics can be exposed.","category":"page"},{"location":"#Quickstart","page":"Prometheus.jl","title":"Quickstart","text":"","category":"section"},{"location":"","page":"Prometheus.jl","title":"Prometheus.jl","text":"Install Prometheus.jl and HTTP.jl using the package manager:\npkg> add Prometheus HTTP\nPaste the following code into a Julia REPL.\n# Load the packages\nusing Prometheus, HTTP\n\n# Create a Counter metric\nconst request_counter = Prometheus.Counter(\"request_count\", \"Number of handled requests\")\n\n# Start a HTTP server on localhost port 8000 to server the metrics\nserver = HTTP.listen!(8000) do http\n    Prometheus.inc(request_counter) # Increment the request counter\n    return Prometheus.expose(http)  # Expose the metrics\nend\nVisit http://localhost:8000 in your browser. You will see something like the following\n# HELP gc_alloc_bytes_total Total number of allocated bytes\n# TYPE gc_alloc_bytes_total counter\ngc_alloc_bytes_total 365578814\n\n[...]\n\n# HELP request_count Number of handled requests\n# TYPE request_count counter\nrequest_count 1\nThe output contains some default metrics related to the running process, as well as the request counter that we added ourselves. Every time you refresh, the counter will increment its value. close(server) will shutdown the server.","category":"page"},{"location":"#Collectors","page":"Prometheus.jl","title":"Collectors","text":"","category":"section"},{"location":"","page":"Prometheus.jl","title":"Prometheus.jl","text":"This section documents the collectors that are currently supported. This include the \"basic\" collectors (Counter, Gauge, Summary) as well as some custom collectors (GCCollector, ProcessCollector). There is also a section on how to implement your own collector, see Custom collectors.","category":"page"},{"location":"","page":"Prometheus.jl","title":"Prometheus.jl","text":"Upstream documentation:","category":"page"},{"location":"","page":"Prometheus.jl","title":"Prometheus.jl","text":"https://prometheus.io/docs/concepts/metric_types/\nhttps://prometheus.io/docs/instrumenting/writing_clientlibs/#metrics","category":"page"},{"location":"#Counter","page":"Prometheus.jl","title":"Counter","text":"","category":"section"},{"location":"","page":"Prometheus.jl","title":"Prometheus.jl","text":"Quoting the upstream documentation:","category":"page"},{"location":"","page":"Prometheus.jl","title":"Prometheus.jl","text":"A counter is a cumulative metric that represents a single monotonically increasing counter whose value can only increase or be reset to zero on restart. For example, you can use a counter to represent the number of requests served, tasks completed, or errors.Do not use a counter to expose a value that can decrease. For example, do not use a counter for the number of currently running processes; instead use a gauge.","category":"page"},{"location":"#Counter-API-reference","page":"Prometheus.jl","title":"Counter API reference","text":"","category":"section"},{"location":"","page":"Prometheus.jl","title":"Prometheus.jl","text":"Prometheus.Counter\nPrometheus.inc(::Prometheus.Counter, ::Any)","category":"page"},{"location":"#Prometheus.Counter","page":"Prometheus.jl","title":"Prometheus.Counter","text":"Prometheus.Counter(; name, help, registry=DEFAULT_REGISTRY)\n\nConstruct a Counter collector.\n\nRequired keyword arguments\n\nname :: String: the name of the counter metric.\nhelp :: String: the documentation for the counter metric.\n\nOptional keyword arguments\n\nregistry :: Prometheus.CollectorRegistry: the registry in which to register the collector. If not specified the default registry is used. Pass registry = nothing to skip registration.\n\n\n\n\n\n","category":"type"},{"location":"#Prometheus.inc-Tuple{Prometheus.Counter, Any}","page":"Prometheus.jl","title":"Prometheus.inc","text":"Prometheus.inc(c::Counter, v = 1)\n\nIncrement the value of the counter c with v. v must be non-negative, and defaults to v = 1.\n\n\n\n\n\n","category":"method"},{"location":"#Gauge","page":"Prometheus.jl","title":"Gauge","text":"","category":"section"},{"location":"","page":"Prometheus.jl","title":"Prometheus.jl","text":"Quoting the upstream documentation:","category":"page"},{"location":"","page":"Prometheus.jl","title":"Prometheus.jl","text":"A gauge is a metric that represents a single numerical value that can arbitrarily go up and down.Gauges are typically used for measured values like temperatures or current memory usage, but also \"counts\" that can go up and down, like the number of concurrent requests.","category":"page"},{"location":"#Gauge-API-reference","page":"Prometheus.jl","title":"Gauge API reference","text":"","category":"section"},{"location":"","page":"Prometheus.jl","title":"Prometheus.jl","text":"Prometheus.Gauge\nPrometheus.inc(::Prometheus.Gauge, ::Any)\nPrometheus.dec(::Prometheus.Gauge, ::Any)\nPrometheus.set(::Prometheus.Gauge, ::Any)\nPrometheus.set_to_current_time(::Prometheus.Gauge)","category":"page"},{"location":"#Prometheus.Gauge","page":"Prometheus.jl","title":"Prometheus.Gauge","text":"Prometheus.Gauge(; name, help, registry=DEFAULT_REGISTRY)\n\nConstruct a Gauge collector.\n\nRequired keyword arguments\n\nname :: String: the name of the gauge metric.\nhelp :: String: the documentation for the gauge metric.\n\nOptional keyword arguments\n\nregistry :: Prometheus.CollectorRegistry: the registry in which to register the collector. If not specified the default registry is used. Pass registry = nothing to skip registration.\n\n\n\n\n\n","category":"type"},{"location":"#Prometheus.inc-Tuple{Prometheus.Gauge, Any}","page":"Prometheus.jl","title":"Prometheus.inc","text":"Prometheus.inc(g::Gauge, v = 1)\n\nIncrement the value of the gauge g with v. v defaults to v = 1.\n\n\n\n\n\n","category":"method"},{"location":"#Prometheus.dec-Tuple{Prometheus.Gauge, Any}","page":"Prometheus.jl","title":"Prometheus.dec","text":"Prometheus.dec(g::Gauge, v = 1)\n\nDecrement the value of the gauge g with v. v defaults to v = 1.\n\n\n\n\n\n","category":"method"},{"location":"#Prometheus.set-Tuple{Prometheus.Gauge, Any}","page":"Prometheus.jl","title":"Prometheus.set","text":"Prometheus.set(g::Gauge, v)\n\nSet the value of the gauge to v.\n\n\n\n\n\n","category":"method"},{"location":"#Prometheus.set_to_current_time-Tuple{Prometheus.Gauge}","page":"Prometheus.jl","title":"Prometheus.set_to_current_time","text":"Prometheus.set_to_current_time(g::Gauge)\n\nSet the value of the gauge to the current unixtime in seconds.\n\n\n\n\n\n","category":"method"},{"location":"#Summary","page":"Prometheus.jl","title":"Summary","text":"","category":"section"},{"location":"","page":"Prometheus.jl","title":"Prometheus.jl","text":"Quoting the upstream documentation:","category":"page"},{"location":"","page":"Prometheus.jl","title":"Prometheus.jl","text":"Similar to a histogram, a summary samples observations (usually things like request durations and response sizes). While it also provides a total count of observations and a sum of all observed values, it calculates configurable quantiles over a sliding time window.","category":"page"},{"location":"#Summary-API-reference","page":"Prometheus.jl","title":"Summary API reference","text":"","category":"section"},{"location":"","page":"Prometheus.jl","title":"Prometheus.jl","text":"Prometheus.Summary\nPrometheus.observe(::Prometheus.Summary, ::Any)","category":"page"},{"location":"#Prometheus.Summary","page":"Prometheus.jl","title":"Prometheus.Summary","text":"Prometheus.Summary(; name, help, registry=DEFAULT_REGISTRY)\n\nConstruct a Summary collector.\n\nRequired keyword arguments\n\nname :: String: the name of the summary metric.\nhelp :: String: the documentation for the summary metric.\n\nOptional keyword arguments\n\nregistry :: Prometheus.CollectorRegistry: the registry in which to register the collector. If not specified the default registry is used. Pass registry = nothing to skip registration.\n\n\n\n\n\n","category":"type"},{"location":"#Prometheus.observe-Tuple{Prometheus.Summary, Any}","page":"Prometheus.jl","title":"Prometheus.observe","text":"Prometheus.observe(summary::Summary, v)\n\nAdd the observed value v to the summary. This increases the sum and count of the summary with v and 1, respectively.\n\n\n\n\n\n","category":"method"},{"location":"#GCCollector","page":"Prometheus.jl","title":"GCCollector","text":"","category":"section"},{"location":"","page":"Prometheus.jl","title":"Prometheus.jl","text":"A collector that exports metrics about allocations and garbage collection (for example number of allocations, number of bytes allocated, time spent in garbage collection, etc). These metrics have the gc_ prefix in their name.","category":"page"},{"location":"#ProcessCollector","page":"Prometheus.jl","title":"ProcessCollector","text":"","category":"section"},{"location":"","page":"Prometheus.jl","title":"Prometheus.jl","text":"A collector that exports metrics about a running process, for example CPU seconds and metrics about I/O operations. Metrics from this collector have the process_ prefix in their name. This collector is only available on Linux since it requires the /proc file system.","category":"page"},{"location":"#Custom-collectors","page":"Prometheus.jl","title":"Custom collectors","text":"","category":"section"},{"location":"","page":"Prometheus.jl","title":"Prometheus.jl","text":"RandomCollector","category":"page"},{"location":"#Labels","page":"Prometheus.jl","title":"Labels","text":"","category":"section"},{"location":"","page":"Prometheus.jl","title":"Prometheus.jl","text":"See https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels for details.","category":"page"},{"location":"","page":"Prometheus.jl","title":"Prometheus.jl","text":"All metrics can be labeled using the special Prometheus.Family collector. For example, a labeled Counter collector","category":"page"},{"location":"","page":"Prometheus.jl","title":"Prometheus.jl","text":"labelnames = [\"endpoint\", \"status_code\"]\ncounter_family = Prometheus.Family{Prometheus.Collector}(\n    \"http_requests\",\n    \"Number of processed requests\",\n    labelnames,\n)","category":"page"},{"location":"","page":"Prometheus.jl","title":"Prometheus.jl","text":"Supported methods:","category":"page"},{"location":"","page":"Prometheus.jl","title":"Prometheus.jl","text":"Prometheus.labels(family, [\"label 1\", \"label 2\"]): extract the child collector corresponding to the labels [\"label 1\", \"label 2\"].\nPrometheus.remove(family, [\"label 1\", \"label 2\"]): remove the child collector corresponding to the labels [\"label 1\", \"label 2\"].\nPrometheus.clear(family): clear all child collectors.","category":"page"},{"location":"#Registries","page":"Prometheus.jl","title":"Registries","text":"","category":"section"},{"location":"#Default-collector-registry","page":"Prometheus.jl","title":"Default collector registry","text":"","category":"section"},{"location":"#Exposition","page":"Prometheus.jl","title":"Exposition","text":"","category":"section"},{"location":"","page":"Prometheus.jl","title":"Prometheus.jl","text":"Prometheus support","category":"page"},{"location":"","page":"Prometheus.jl","title":"Prometheus.jl","text":"Prometheus.expose","category":"page"},{"location":"#Prometheus.expose","page":"Prometheus.jl","title":"Prometheus.expose","text":"Prometheus.expose(file::String, reg::CollectorRegistry = DEFAULT_REGISTRY)\n\nExport all metrics in reg by writing them to the file file.\n\n\n\n\n\nexpose(io::IO, reg::CollectorRegistry = DEFAULT_REGISTRY)\n\nExport all metrics in reg by writing them to the I/O stream io.\n\n\n\n\n\nexpose(http::HTTP.Stream, reg::CollectorRegistry = DEFAULT_REGISTRY; kwargs...)\n\nExport all metrics in reg by writing them to the HTTP stream http.\n\nThe caller is responsible for checking e.g. the HTTP method and URI target. For HEAD requests this method do not write a body, however.\n\n\n\n\n\n","category":"function"}]
}