{"id":16990516,"url":"https://github.com/smdn/smdn.net.muninnode","last_synced_at":"2025-10-09T00:31:29.590Z","repository":{"id":43320581,"uuid":"391544319","full_name":"smdn/Smdn.Net.MuninNode","owner":"smdn","description":".NET implementation of Munin-Node and Munin-Plugin.","archived":false,"fork":false,"pushed_at":"2024-11-03T14:13:27.000Z","size":355,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-11-28T12:51:50.390Z","etag":null,"topics":["dotnet","dotnet-library","munin","munin-node","munin-plugin","nuget-package"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/smdn.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"smdn","custom":["https://www.amazon.jp/hz/wishlist/ls/1K0WOH22FCL6W?ref_=wl_share\u0026filter=all\u0026sort=priority"]}},"created_at":"2021-08-01T06:17:39.000Z","updated_at":"2024-11-03T14:13:31.000Z","dependencies_parsed_at":"2024-10-14T03:10:31.300Z","dependency_job_id":null,"html_url":"https://github.com/smdn/Smdn.Net.MuninNode","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smdn%2FSmdn.Net.MuninNode","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smdn%2FSmdn.Net.MuninNode/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smdn%2FSmdn.Net.MuninNode/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smdn%2FSmdn.Net.MuninNode/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/smdn","download_url":"https://codeload.github.com/smdn/Smdn.Net.MuninNode/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235775545,"owners_count":19043180,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dotnet","dotnet-library","munin","munin-node","munin-plugin","nuget-package"],"created_at":"2024-10-14T03:10:24.071Z","updated_at":"2025-10-09T00:31:29.585Z","avatar_url":"https://github.com/smdn.png","language":"C#","readme":"[![GitHub license](https://img.shields.io/github/license/smdn/Smdn.Net.MuninNode)](https://github.com/smdn/Smdn.Net.MuninNode/blob/main/LICENSE.txt)\n[![GitHub issues](https://img.shields.io/github/issues/smdn/Smdn.Net.MuninNode)](https://github.com/smdn/Smdn.Net.MuninNode/issues)\n[![tests/main](https://img.shields.io/github/actions/workflow/status/smdn/Smdn.Net.MuninNode/test.yml?branch=main\u0026label=tests%2Fmain)](https://github.com/smdn/Smdn.Net.MuninNode/actions/workflows/test.yml)\n[![CodeQL](https://github.com/smdn/Smdn.Net.MuninNode/actions/workflows/codeql-analysis.yml/badge.svg?branch=main)](https://github.com/smdn/Smdn.Net.MuninNode/actions/workflows/codeql-analysis.yml)\n[![NuGet Smdn.Net.MuninNode](https://img.shields.io/nuget/v/Smdn.Net.MuninNode.svg)](https://www.nuget.org/packages/Smdn.Net.MuninNode/)\n\n# Smdn.Net.MuninNode\n[![NuGet Smdn.Net.MuninNode](https://img.shields.io/nuget/v/Smdn.Net.MuninNode.svg)](https://www.nuget.org/packages/Smdn.Net.MuninNode/)\n\nSmdn.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).\n\nThis library provides Munin-Node implementation for .NET, which enables to you to create custom Munin-Node using the .NET languages and libraries.\n\nThis 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.\n\n### `Smdn.Net.MuninNode` namespace\nThis 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.\n\nYou can use the extension methods from [Smdn.Net.MuninNode.DependencyInjection](./src/Smdn.Net.MuninNode/Smdn.Net.MuninNode.DependencyInjection/) namespace to configure and register the Munin-Node to the `ServiceCollection`. This would support most purposes and use cases. See [this example](./examples/Smdn.Net.MuninNode/getting-started/) for detail.\n\n### `Smdn.Net.MuninPlugin` namespace\nIn 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.\n\n# Smdn.Net.MuninNode.Hosting\n[![NuGet Smdn.Net.MuninNode.Hosting](https://img.shields.io/nuget/v/Smdn.Net.MuninNode.Hosting.svg)](https://www.nuget.org/packages/Smdn.Net.MuninNode.Hosting/)\n\nThis library provides APIs to run Munin-Node as a background service integrated with .NET Generic Host.\n\nIf you want to integrate with .NET Generic Host, especially if you want to implement Munin-Node running as a **Windows Services** or **systemd unit**, you can use this extension library. See [this example](./examples/Smdn.Net.MuninNode.Hosting/getting-started/) for detail.\n\n# Usage\nTo use the released package, add `\u003cPackageReference\u003e` to the project file.\n\n```xml\n  \u003cItemGroup\u003e\n    \u003cPackageReference Include=\"Smdn.Net.MuninNode\" Version=\"2.*\" /\u003e\n    \u003c!-- Or --\u003e\n    \u003cPackageReference Include=\"Smdn.Net.MuninNode.Hosting\" Version=\"3.*\" /\u003e\n  \u003c/ItemGroup\u003e\n```\n\nThen write the your code. See [examples](examples/) to use APIs.\n\n### Configure Munin master (`munin.conf`)\nIf you want `munin-update` process 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:\n\n```conf\n[your-node.localdomain]\n    address 127.0.0.1 # address of your node\n    port 4949 # port number that your node uses\n    use_node_name yes # (optional) let Munin to use the node name advertised by your node\n```\n\nMultiple instances can also be started by defining multiple nodes with different port numbers if you want.\n\nFor 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).\n\n\n### Test the node\nTo test the node you have created, run the node first, and connect to the node.\n\nThe following is an example of testing a node using the `telnet` command. Here, the port number should be the one your node is using.\n\n```\n$ telnet 127.0.0.1 4949\nTrying 127.0.0.1...\nConnected to localhost.\nEscape character is '^]'.\n# munin node at your-node.localhost\nlist                                  \u003c-- type `list` to list plugin names\nuptime sensor1 sensor2\nfetch uptime                          \u003c-- type `fetch \u003cplugin-name\u003e` to fetch\n                                          the values of the specified plugin\nuptime.value 123.4567\nquit                                  \u003c-- type `quit` to close connection\nConnection closed by foreign host.\n```\n\n# For contributors\nContributions are appreciated!\n\nIf 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.\n\nIssueやPull Requestを送る際は、[Contribution guidelines](./CONTRIBUTING.md)をご覧頂ください。　可能なら英語が望ましいですが、日本語で構いません。\n\n# PseudoMuninNode\n[PseudoMuninNode](https://github.com/smdn/PseudoMuninNode), the C++ implementation for ESP32 (Arduino IDE) is also available.\n","funding_links":["https://github.com/sponsors/smdn","https://www.amazon.jp/hz/wishlist/ls/1K0WOH22FCL6W?ref_=wl_share\u0026filter=all\u0026sort=priority"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmdn%2Fsmdn.net.muninnode","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsmdn%2Fsmdn.net.muninnode","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmdn%2Fsmdn.net.muninnode/lists"}