Munin VS docs.rs

I rediscovered Munin. To my surprise it is written entirely in Perl. I remember Munin from years ago... it still seems healty and maintained and lies ready on your Deb-Repositories. So I followed the Easy Install Guide... which really is easy, but fails to mention that you need to install your own HTTP-Server to serve the HTML-reports.

A bit of background, which may make understanding my choices in this lib easier: Munin is a resource monitoring tool using rrdtool, usually run in a Server/Client Setup. The client accepts plugins which are just executables in a directory. Usually written in a scripting language, but it actually doesn't matter. Data is fetched every 5 minutes, plugins are first run with a config argument to spit out a munin graph config, followed by a run without arguments to present data. To support higher resolutions than just "every 5 minutes", graph config can contain config to tell munin one collects it every second. Then the fetching part needs to run as a daemon, writing a cache somewhere which gets output when munin wants the data.

Munin plugins and management script for monitoring various Pi-hole® statistics.

When you do not have enough power you would get errors because looking up the plots would simply fail. Sounds more that there is one disk which is slower. I had one 2TB external usb which was really slow and the latency of lookups was through the roof. Are you on linux ? Then install munin-monitoring.org it shows latency of the disks out of the box.

what os ? on linux install https://munin-monitoring.org/ it will give you disk latency information.

I'd say give Munin a try.

Munin plugins for monitoring Pi-hole®. Transforms a server into a powerful monitoring platform, as simple as one, two, three, ...four.

Working in combination with CodeWhisperer in your IDE, you can send whole code sections to Amazon Q and ask for an explanation of what the selected code does. To show how this works, we open up the file.rs file cloned from this GitHub repository. This is part of an open source project to host documentation of crates for the Rust Programming Language, which is a language we are not familiar with.

Looks like a great initiative – I wish there was a reliable TS/JS equivalent of https://docs.rs (even considering rustdoc's deficiencies[1]).

I went through this exercise recently and so far my experience with trying to produce documentation from a somewhat convoluted TS codebase[2] has been disappointing. I would claim it's a consequence of the library's public (user-facing) API substantially differing from how the actual implementation is structured.

Typedoc produces bad results for that codebase so sphinx-js, which I wanted to use, doesn't have much to work with. I ultimately documented things by hand, for now, the way the API is meant to be used by the user.

Compare:

https://ts-results-es.readthedocs.io/en/latest/reference/api...

vs

https://tsdocs.dev/docs/ts-results-es/4.1.0-alpha.1/index.ht...

Rust Search Extension adds a section on docs.rs menubar which lists the features of a crate in a nice and easy to access format.

📝 Note: At the time of writing this post, I couldn't really locate the init function docs.rs documentation. It didn't seem easily accessible through any of the current HAL implementation documentation. Nevertheless, I reached the signature of the function through the source here.

Rust Crates are a Game-Changer 🎮:The ease of releasing a crate with `cargo publish` and the convenience of rolling out new versions amazed me. The auto-generated docs on Docs.rs. is an amazing tool, especially with docstring formatting. Doc tests serve as a two-fold tool for documenting the code and ensuring it's up-to-date.

I've found I manually type out certain subsets of URLs where possible[0], maybe that's subconsciously associated with my impression that Google Search results have gotten worse and worse over the years.

[0] https://en.wiktionary.org/wiki/ and https://docs.rs/ come to mind.

docs.rs also downloads you crate automatically to generate docs and I would guess lib.rs does something similar

There are also a few key sites you'll want to keep in your back pocket at all times: - The Standard Library Documentation has complete documentation for every std library function in Rust - crates.io is a repository for all third-party packages, and docs.rs has human-readable documentation for the overwhelming majority of them - The Rust Cookbook has some code examples for common tasks you may need to perform - Make sure you are using clippy, which is available through Rustup and can be run with cargo clippy as a replacement to cargo check, it adds additional lints for your Rust code and is very helpful for teaching many of the best practices

OTOH, source-code-generated-docs normalize how code docs are, like the rust docs.rs paradigm, so it sort of forces or encourages package creators/maintainers to write docs.