package mirage-monitoring
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=8e0bec0ea98fd029684adef9269d05df1ffe22294d71e4eca35476871460a96e
sha512=7f80dd59fba8c7e1553fedb3534606b4fad1211c2883e34715c5129da8c08aef255f9eebd8956e6766cba674bdd6130bfcda8971552b2894f99d43caf762854f
Description
Reporting metrics to Influx, Telegraf. Dynamic adjusting log level and metrics sources, memprof profiling.
Published: 06 Mar 2023
README
Grafana MirageOS Unikernel monitoring
Using Influx, Telegraf, etc.
Best used on a private network interface for your unikernel.
Output metrics to influx / telegraf
The provided ip:port
in create
is used to send every interval
seconds gathered metrics to, using the Influx wire protocol.
Dynamic adjustments of Log level and Metrics reporting
The create
function has a listener_port argument (defaulting to 2323). On the customizable port TCP connections to the unikernel are possible. Each connection can transmit a command (as text) to adjust log level and enable or disable metrics sources:
The log level (prefix L
) is specified, the same as the command-line argument -l
:
L*:debug
all log sources are enabled on the debug level.Lmonitoring-experiments:error
the log source monitoring-experiments is set to the error level.L*:info,monitoring-experiments:debug
all log sources are enabled on the info level, and the log source monitoring-experiments is set to the debug level.
The metrics (prefix M
) sources can be enabled and disabled based on source name. First, if present, the all command is executed, then the tags, then specific sources:
M*:disable,memory:enable,net-solo5:enable
disables all metrics sources, and then enables memory and net-solo5.Mnet-solo5:disable
disables the net-solo5 metrics source.Mtag:http:enable
enables all metrics with the http tag.
The log levels for the log sources can be inspected:
l
reports the default log level and the log level for all log sources with a different log level.l*
reports the default log level and the log level for all log sources.lmonitoring-experiments,dns
reports the log level for monitoring-experiments and dns respectively.
Likewise, metrics status can be similarly inspected:
m
reports the default metrics status and the metrics status for all metrics sources with a different status.m*
reports the default metrics status, all enabled tags, and the metrics status of all metrics sources.mmemory,net-solo5
reports the metrics status for memory and net-solo5 respectively.
Memprof tracing
The create
function has a memtrace_port
argument (defualts to 4242). On this port, when a TCP client connects, OCaml memory profiling is started and dumped to the client. The sampling_rate
(defaults to 1e-4) is used. This uses the memprof-mirage package.
The output trace is best being viewed with memtrace_viewer.
Dependencies (11)
-
mirage-clock
>= "4.0.0"
-
memtrace-mirage
>= "0.2.1.2.2"
-
mirage-runtime
>= "4.3.0" & < "4.5.0"
-
tcpip
>= "7.0.0"
-
mirage-time
>= "2.0.0"
-
metrics-influx
>= "0.2.0"
-
metrics-lwt
>= "0.2.0"
-
metrics
>= "0.4.0"
-
logs
>= "0.6.3"
- dune
-
ocaml
>= "4.11.0"
Dev Dependencies
None
Used by
None
Conflicts (2)
-
mirage-xen
< "8.0.2"
-
mirage-solo5
< "0.9.2"