https://github.com/smdn/smdn.net.muninnode
.NET implementation of Munin-Node and Munin-Plugin.
https://github.com/smdn/smdn.net.muninnode
dotnet dotnet-library munin munin-node munin-plugin nuget-package
Last synced: 4 months ago
JSON representation
.NET implementation of Munin-Node and Munin-Plugin.
- Host: GitHub
- URL: https://github.com/smdn/smdn.net.muninnode
- Owner: smdn
- License: mit
- Created: 2021-08-01T06:17:39.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-03T14:13:27.000Z (7 months ago)
- Last Synced: 2024-11-28T12:51:50.390Z (6 months ago)
- Topics: dotnet, dotnet-library, munin, munin-node, munin-plugin, nuget-package
- Language: C#
- Homepage:
- Size: 347 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://github.com/smdn/Smdn.Net.MuninNode/blob/main/LICENSE.txt)
[](https://github.com/smdn/Smdn.Net.MuninNode/issues)
[](https://github.com/smdn/Smdn.Net.MuninNode/actions/workflows/test.yml)
[](https://github.com/smdn/Smdn.Net.MuninNode/actions/workflows/codeql-analysis.yml)
[](https://www.nuget.org/packages/Smdn.Net.MuninNode/)
# Smdn.Net.MuninNode
Smdn.Net.MuninNode is a .NET implementation of [Munin-Node](https://guide.munin-monitoring.org/en/latest/node/index.html) and [Munin-Plugin](https://guide.munin-monitoring.org/en/latest/plugin/index.html).
This library provides Munin-Node implementation for .NET, which enables to you to create custom Munin-Node using the .NET languages and libraries.
This library also provides abstraction APIs for implementing Munin-Plugin. By using Munin-Plugin APIs in combination with the Munin-Node implementation, you can implement the function of collecting various kind of telemetry data using Munin, with .NET.
This library has two major namespaces. In the [Smdn.Net.MuninNode](./src/Smdn.Net.MuninNode/Smdn.Net.MuninNode/) namespace, there is a `NodeBase` class, which provides abstract Munin-Node implementation. For most purposes, the `LocalNode` class can be used, such as creating a Munin-Node that runs on the same host as the Munin server.
In the [Smdn.Net.MuninPlugin](./src/Smdn.Net.MuninNode/Smdn.Net.MuninPlugin/) namespace, there is a `IPlugin` interfaces, which represents the functionality that should be implemented as Munin-Plugin. By properly implementing `IPlugin` and its relevant interfaces, you can compose the Munin-Plugin which aggregates telemetry data using .NET.
## Usage
To use the released packge, add `` to the project file.
```xml
```
Then write the your code. See [examples](examples/) to use APIs.
### Munin configurations (`munin.conf`)
If you want `munin-update` to gather the telemetry data from the Munin-Node you have created and started, you have to add entry defines your node to configuration file `/etc/munin/munin.conf`. The following is an example:
```conf
[your-node.localdomain]
address 127.0.0.1 # address of your node
port 44693 # port number that your node uses
use_node_name yes # let Munin to use the node name advertised by your node (optional)
```
Multiple instances can also be started by defining multiple nodes with different port numbers if you want.
For more information about node definitions, please refer to the [Munin documentation for munin.conf](https://guide.munin-monitoring.org/en/latest/reference/munin.conf.html).
### Testing node
To test the node you have created, run the node first, and connect to the node.
The following is an example of testing a node using the `telnet` command. Here, the port number should be the one your node is using.
```
$ telnet 127.0.0.1 9876
Trying 127.0.0.1...
Connected to localhost.
Escape character is '^]'.
# munin node at your-node.localhost
list <-- type 'list' to list field names
uptime sensor1 sensor2
fetch uptime <-- type 'fetch ' to fetch
the value of the specified field
uptime.value 123.4567
quit <-- type 'quit' to close connection
Connection closed by foreign host.
```
# For contributers
Contributions are appreciated!
If there's a feature you would like to add or a bug you would like to fix, please read [Contribution guidelines](./CONTRIBUTING.md) and create an Issue or Pull Request.
IssueやPull Requestを送る際は、[Contribution guidelines](./CONTRIBUTING.md)をご覧頂ください。 可能なら英語が望ましいですが、日本語で構いません。
# PseudoMuninNode
[PseudoMuninNode](https://github.com/smdn/PseudoMuninNode), the C++ implementation for ESP32 (Arduino IDE) is also available.