{"id":13587104,"url":"https://github.com/svartalf/unbound-telemetry","last_synced_at":"2025-04-07T19:30:42.627Z","repository":{"id":37713867,"uuid":"233609072","full_name":"svartalf/unbound-telemetry","owner":"svartalf","description":"Prometheus exporter for Unbound DNS resolver","archived":true,"fork":false,"pushed_at":"2022-09-28T11:33:30.000Z","size":163,"stargazers_count":81,"open_issues_count":13,"forks_count":13,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-11-06T05:40:58.184Z","etag":null,"topics":["prometheus","prometheus-exporter","rust","telemetry","unbound","unbound-dns"],"latest_commit_sha":null,"homepage":"","language":"Rust","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/svartalf.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE-MIT","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"liberapay":"svartalf","patreon":"svartalf","custom":["https://svartalf.info/donate/","https://www.buymeacoffee.com/svartalf"]}},"created_at":"2020-01-13T14:03:22.000Z","updated_at":"2024-09-12T23:35:18.000Z","dependencies_parsed_at":"2023-01-17T16:01:49.006Z","dependency_job_id":null,"html_url":"https://github.com/svartalf/unbound-telemetry","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/svartalf%2Funbound-telemetry","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/svartalf%2Funbound-telemetry/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/svartalf%2Funbound-telemetry/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/svartalf%2Funbound-telemetry/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/svartalf","download_url":"https://codeload.github.com/svartalf/unbound-telemetry/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247716076,"owners_count":20984169,"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":["prometheus","prometheus-exporter","rust","telemetry","unbound","unbound-dns"],"created_at":"2024-08-01T15:06:01.472Z","updated_at":"2025-04-07T19:30:42.240Z","avatar_url":"https://github.com/svartalf.png","language":"Rust","funding_links":["https://liberapay.com/svartalf","https://patreon.com/svartalf","https://svartalf.info/donate/","https://www.buymeacoffee.com/svartalf"],"categories":["Rust"],"sub_categories":[],"readme":"# unbound-telemetry\n\n![Logo](.github/logo.png)\n\n[![Coverage Status](https://github.com/svartalf/unbound-telemetry/workflows/Continuous%20integration/badge.svg)](https://github.com/svartalf/prometheus-unbound-exporter/actions?workflow=Continuous+integration)\n![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)\n![Minimum rustc version](https://img.shields.io/badge/rustc-1.40+-green.svg)\n\n\u003e [Unbound DNS resolver](https://www.nlnetlabs.nl/projects/unbound/about/) metrics exporter for [Prometheus](https://prometheus.io)\n\n## Deprecation notice\n\nThis repo is archived and will not be maintained anymore. You can use the [`unbound_exporter`](https://github.com/letsencrypt/unbound_exporter) by Let's Encrypt instead.\n\n## Features\n\n * Communicates with `unbound` via TLS, UDS socket or shared memory\n * Compatible with [kumina/unbound_exporter](https://github.com/kumina/unbound_exporter); your dashboard should just work\n * Small binary size (~2 Mb after `strip`) and memory footprint (~10 Kb)\n * Takes ~10 ms to respond with gathered metrics\n * Blazing fast!\n\n## Platform support\n\nThis project is developed, manually and automatically tested with Linux.\n\nFollowing platforms are tested in the CI environment and expected to work:\n\n * Windows\n * macOS\n\nIt is expected that FreeBSD, NetBSD and OpenBSD will work too, but\nthere are no any manual or automatic checks for them exist.\n\nNote that communication via UDS socket or shared memory is not supported for Windows.\n\n## Installation\n\n### From sources\n\n1. [Rust](https://www.rust-lang.org/) language compiler version \u003e= 1.46 is required\n2. Clone the repository\n3. Run the following command\n    ```bash\n    $ cargo build --release\n    ```\n4. Get the compiled executable from the `./target/release/unbound-telemetry`\n\n## Usage\n\nHTTP interface is available at http://0.0.0.0:9167 by default and can be changed via CLI arguments.\n\n### TCP socket\n\nFirst of all, enable `remote-control` option in the [`unbound.conf`](https://nlnetlabs.nl/documentation/unbound/unbound.conf/),\nconfigure control interface address and TLS if needed.\n\nRun the following command to see possible flags and options:\n\n```bash\n$ unbound-telemetry tcp --help\n```\n\n### Unix domain socket\n\nSimilar to [TLS socket](#tls-socket), you need to enable `remote-control` option first.\n\nRun the following command to see possible flags and options:\n\n```bash\n$ unbound-telemetry uds --help\n```\n\n### Shared memory\n\nEnable `shm-enable` option in the [`unbound.conf`](https://nlnetlabs.nl/documentation/unbound/unbound.conf/)\nand run the following command:\n\n```bash\n$ unbound-telemetry shm --help\n```\n\n### Monitoring\n\n`/healthcheck` URL can be used for automated monitoring;\nin case when exporter is not able to access the `unbound` instance,\n`HTTP 500` error will be returned, response body will contain plain text error description.\n\n## Grafana\n\n[This Grafana dashboard](https://grafana.com/grafana/dashboards/11705) can be used\nto show all metrics provided by this exporter.\n\n## License\n\n`unbound-telemetry` is released under the MIT License.\n\n## Donations\n\nIf you appreciate my work and want to support me or this project, you can do it [here](https://svartalf.info/donate).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsvartalf%2Funbound-telemetry","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsvartalf%2Funbound-telemetry","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsvartalf%2Funbound-telemetry/lists"}