{"id":16947633,"url":"https://github.com/x70b1/telegraf-edgeos","last_synced_at":"2025-03-17T08:37:07.658Z","repository":{"id":45710498,"uuid":"453701942","full_name":"x70b1/telegraf-edgeos","owner":"x70b1","description":"A lightweight Telegraf distribution customized for Ubiquiti's EdgeOS.","archived":false,"fork":false,"pushed_at":"2025-03-04T10:37:13.000Z","size":389,"stargazers_count":35,"open_issues_count":0,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-16T10:11:14.641Z","etag":null,"topics":["edgeos","edgerouter","influxdb","monitoring","prometheus","telegraf","ubiquiti"],"latest_commit_sha":null,"homepage":"","language":"Shell","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/x70b1.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2022-01-30T14:26:21.000Z","updated_at":"2025-03-04T10:37:09.000Z","dependencies_parsed_at":"2023-01-24T07:31:10.549Z","dependency_job_id":"891918dc-07cb-472d-9e64-e1016e4bdda1","html_url":"https://github.com/x70b1/telegraf-edgeos","commit_stats":null,"previous_names":[],"tags_count":32,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/x70b1%2Ftelegraf-edgeos","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/x70b1%2Ftelegraf-edgeos/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/x70b1%2Ftelegraf-edgeos/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/x70b1%2Ftelegraf-edgeos/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/x70b1","download_url":"https://codeload.github.com/x70b1/telegraf-edgeos/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244001626,"owners_count":20381803,"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":["edgeos","edgerouter","influxdb","monitoring","prometheus","telegraf","ubiquiti"],"created_at":"2024-10-13T21:47:48.025Z","updated_at":"2025-03-17T08:37:07.338Z","avatar_url":"https://github.com/x70b1.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"telegraf-edgeos.png\"\u003e\n\u003c/p\u003e\n\n# telegraf-edgeos\n\n[![Actions](https://github.com/x70b1/telegraf-edgeos/actions/workflows/cicd.yml/badge.svg)](https://github.com/x70b1/telegraf-edgeos/actions)\n[![Contributors](https://img.shields.io/github/contributors/x70b1/telegraf-edgeos.svg)](https://github.com/x70b1/telegraf-edgeos/graphs/contributors)\n[![License](https://img.shields.io/github/license/x70b1/telegraf-edgeos.svg)](https://github.com/x70b1/telegraf-edgeos/blob/master/LICENSE)\n[![Release](https://img.shields.io/github/v/release/x70b1/telegraf-edgeos?label=Release)](https://github.com/x70b1/telegraf-edgeos/releases)\n\nA lightweight [Telegraf](https://github.com/influxdata/telegraf) distribution customized for Ubiquiti's EdgeOS.\n\n\n## What is so cool here?\n\nThis Telegraf is crosscompiled for `mips` and `mipsel`.\nTo reduce the size only essential and basic networking related internal plugins are part of the packaged binary.\nThe result is a ~ 18 MB binary file instead of ~ 210 MB for a full featured Telegraf.\nSo it should fit on every EdgeRouter.\n\n\n## edgeos.sh\n\nTo collect metrics that are availiable on EdgeOS but not collected via an internal module the package contains an additional plugin.\nYou find it at `/usr/lib/telegraf/edgeos.sh`.\nIt works with different parameters:\n\n**--firmware** checks Ubnt's servers for EdgeOS updates and returns the result\n\n**--interfaces** returns more details about a network interface like description, up/down-status and negotiated speed\n\n**--power** prints power stats, like `show hardware power`\n\n**--temperature** prints temperature stats, like `show hardware temperature`\n\n\nExample:\n\n```\nedgeos_firmware running=\"v2.0.9-hotfix.2\",availiable=\"v2.0.9-hotfix.2\",upgrade=0,model=\"EdgeRouter 12\",serial=\"ABC123456\"\n\n...\n\nedgeos_interface,interface=eth4,type=ethernet alias=\"Server A\",state=0,speed=1000\nedgeos_interface,interface=eth2,type=ethernet alias=\"Server B\",state=1,speed=10\nedgeos_interface,interface=eth0,type=ethernet alias=\"Provider XYZ\",state=0,speed=1000\n\n...\n\nedgeos_power voltage=23.41\nedgeos_power current=0.37\nedgeos_power consumption=8.85\nedgeos_temperature,sensor=CPU temperature=66.75\nedgeos_temperature,sensor=Board\\ 1 temperature=58.25\nedgeos_temperature,sensor=Board\\ 2 temperature=49.75\nedgeos_temperature,sensor=PHY\\ 1 temperature=68.50\nedgeos_temperature,sensor=PHY\\ 2 temperature=57.50\n```\n\n\n## Supported Hardware\n\n|                       | Family                | Package               | Internal Plugins      | firmware              | interfaces            | power                 | temperature           |\n| --------------------- | --------------------- | --------------------- | :----:                | :----:                | :----:                | :----:                | :----:                |\n| `ER-X`                | E50                   | mipsel                | :heavy_check_mark:    | :heavy_check_mark:    | :heavy_check_mark:    | :x:                   | :x:                   |\n| `ER-X-SFP`            | E50                   | mipsel                | :heavy_check_mark:    | :heavy_check_mark:    | :heavy_check_mark:    | :x:                   | :x:                   |\n| `ER-4`                | E300                  | mips                  | :heavy_check_mark:    | :heavy_check_mark:    | :heavy_check_mark:    | :x:                   | :x:                   |\n| `ER-6P`               | E300                  | mips                  | :heavy_check_mark:    | :heavy_check_mark:    | :heavy_check_mark:    | :heavy_check_mark:    | :x:                   |\n| `ER‑8`                | E200                  | mips                  | :grey_question:       | :grey_question:       | :grey_question:       | :grey_question:       | :grey_question:       |\n| `ER-8-XG`             | E1000                 | mips                  | :grey_question:       | :grey_question:       | :grey_question:       | :grey_question:       | :grey_question:       |\n| `ER-10X`              | E50                   | mipsel                | :grey_question:       | :grey_question:       | :grey_question:       | :grey_question:       | :grey_question:       |\n| `ER-12`               | E300                  | mips                  | :heavy_check_mark:    | :heavy_check_mark:    | :heavy_check_mark:    | :heavy_check_mark:    | :heavy_check_mark:    |\n| `ER-12P`              | E300                  | mips                  | :grey_question:       | :grey_question:       | :grey_question:       | :grey_question:       | :grey_question:       |\n| `ERLite-3`            | E100                  | mips                  | :heavy_check_mark:    | :heavy_check_mark:    | :heavy_check_mark:    | :x:                   | :x:                   |\n| `ERPoe‑5`             | E100                  | mips                  | :grey_question:       | :grey_question:       | :grey_question:       | :grey_question:       | :grey_question:       |\n| `ERPro-8`             | E200                  | mips                  | :grey_question:       | :grey_question:       | :grey_question:       | :grey_question:       | :grey_question:       |\n| `EP-R6`               | E50                   | mipsel                | :grey_question:       | :grey_question:       | :grey_question:       | :grey_question:       | :grey_question:       |\n| `EP-R8`               | E200                  | mips                  | :grey_question:       | :grey_question:       | :grey_question:       | :grey_question:       | :grey_question:       |\n\n\n:heavy_check_mark: = Works for me!\n\n:x: = No hardware support for this feature :(\n\n:grey_question: = Unknown\n\nYour device is not listed with a green check mark? Please open an issue if you have tested Telegraf on an EdgeRouter and share your findings.\n\n\n## Setup\n\nTo keep the binary size small, we introduced `flavors`.\nThis means that only a specific output like `influxdb_v2` or `prometheus_client` is part of the built binary.\nIf you need a different output, create an issue.\n\nInstall the prebuild package with your needed flavor:\n\n```sh\ncurl -L -o telegraf.deb https://github.com/x70b1/telegraf-edgeos/releases/download/{RELEASE}/telegraf_{REALEASE}+{FLAVOR}_{ARCH}.deb\ndpkg -i telegraf.deb\n```\n\nYou can upgrade Telegraf with the same commands.\n\nAs you already know from InfluxData's distribution of Telegraf, the configuration is located at `/etc/telegraf/telegraf.conf` and `/etc/telegraf/telegraf.d`.\nThe [sample config](https://github.com/x70b1/telegraf-edgeos/blob/master/configs/telegraf.conf) is pre-installed. This needs to be modified for your own use case.\n\n\n## Dashboard\n\n[![Dashboard](grafana/grafana_edgerouter_banner.png)](#)\n\nI added a sample Grafana dashboard.\n\nIt comes without warranty.\nYou will have to customize it.\n\n* [grafana_edgerouter.json](grafana/grafana_edgerouter.json)\n* [grafana_edgerouter_fullscreen.png](grafana/grafana_edgerouter_fullscreen.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fx70b1%2Ftelegraf-edgeos","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fx70b1%2Ftelegraf-edgeos","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fx70b1%2Ftelegraf-edgeos/lists"}