mirror of
https://github.com/hassio-addons/repository-beta.git
synced 2025-05-04 19:11:30 +00:00
🎉 Release of add-on Prometheus 1.0.0-beta.0
This commit is contained in:
parent
d6680c48b8
commit
969bdcf5ea
7 changed files with 232 additions and 0 deletions
25
README.md
25
README.md
|
@ -446,6 +446,20 @@ Manage your Docker environment with ease
|
||||||
|
|
||||||
[:books: Portainer add-on documentation][addon-doc-portainer]
|
[:books: Portainer add-on documentation][addon-doc-portainer]
|
||||||
|
|
||||||
|
### ✓ [Prometheus][addon-prometheus]
|
||||||
|
|
||||||
|
![Latest Version][prometheus-version-shield]
|
||||||
|
![Supports armhf Architecture][prometheus-armhf-shield]
|
||||||
|
![Supports armv7 Architecture][prometheus-armv7-shield]
|
||||||
|
![Supports aarch64 Architecture][prometheus-aarch64-shield]
|
||||||
|
![Supports amd64 Architecture][prometheus-amd64-shield]
|
||||||
|
![Supports i386 Architecture][prometheus-i386-shield]
|
||||||
|
![Docker Pulls][prometheus-pulls-shield]
|
||||||
|
|
||||||
|
Cloud native metrics
|
||||||
|
|
||||||
|
[:books: Prometheus add-on documentation][addon-doc-prometheus]
|
||||||
|
|
||||||
### ✓ [SQLite Web][addon-sqlite-web]
|
### ✓ [SQLite Web][addon-sqlite-web]
|
||||||
|
|
||||||
![Latest Version][sqlite-web-version-shield]
|
![Latest Version][sqlite-web-version-shield]
|
||||||
|
@ -728,6 +742,7 @@ on the correct GitHub repository matching the add-on.
|
||||||
- [Open an issue for the add-on: Node-RED][node-red-issue]
|
- [Open an issue for the add-on: Node-RED][node-red-issue]
|
||||||
- [Open an issue for the add-on: Plex Media Server][plex-issue]
|
- [Open an issue for the add-on: Plex Media Server][plex-issue]
|
||||||
- [Open an issue for the add-on: Portainer][portainer-issue]
|
- [Open an issue for the add-on: Portainer][portainer-issue]
|
||||||
|
- [Open an issue for the add-on: Prometheus][prometheus-issue]
|
||||||
- [Open an issue for the add-on: SQLite Web][sqlite-web-issue]
|
- [Open an issue for the add-on: SQLite Web][sqlite-web-issue]
|
||||||
- [Open an issue for the add-on: SSH & Web Terminal][ssh-issue]
|
- [Open an issue for the add-on: SSH & Web Terminal][ssh-issue]
|
||||||
- [Open an issue for the add-on: Spotify Connect][spotify-issue]
|
- [Open an issue for the add-on: Spotify Connect][spotify-issue]
|
||||||
|
@ -1081,6 +1096,16 @@ SOFTWARE.
|
||||||
[portainer-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg
|
[portainer-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg
|
||||||
[portainer-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg
|
[portainer-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg
|
||||||
[portainer-i386-shield]: https://img.shields.io/badge/i386-no-red.svg
|
[portainer-i386-shield]: https://img.shields.io/badge/i386-no-red.svg
|
||||||
|
[addon-prometheus]: https://github.com/hassio-addons/addon-prometheus/tree/v1.0.0-beta.0
|
||||||
|
[addon-doc-prometheus]: https://github.com/hassio-addons/addon-prometheus/blob/v1.0.0-beta.0/README.md
|
||||||
|
[prometheus-issue]: https://github.com/hassio-addons/addon-prometheus/issues
|
||||||
|
[prometheus-version-shield]: https://img.shields.io/badge/version-v1.0.0-beta.0-blue.svg
|
||||||
|
[prometheus-pulls-shield]: https://img.shields.io/docker/pulls/hassioaddons/prometheus-amd64.svg
|
||||||
|
[prometheus-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
|
||||||
|
[prometheus-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
|
||||||
|
[prometheus-armhf-shield]: https://img.shields.io/badge/armhf-no-red.svg
|
||||||
|
[prometheus-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg
|
||||||
|
[prometheus-i386-shield]: https://img.shields.io/badge/i386-no-red.svg
|
||||||
[addon-sqlite-web]: https://github.com/hassio-addons/addon-sqlite-web/tree/v2.2.2
|
[addon-sqlite-web]: https://github.com/hassio-addons/addon-sqlite-web/tree/v2.2.2
|
||||||
[addon-doc-sqlite-web]: https://github.com/hassio-addons/addon-sqlite-web/blob/v2.2.2/README.md
|
[addon-doc-sqlite-web]: https://github.com/hassio-addons/addon-sqlite-web/blob/v2.2.2/README.md
|
||||||
[sqlite-web-issue]: https://github.com/hassio-addons/addon-sqlite-web/issues
|
[sqlite-web-issue]: https://github.com/hassio-addons/addon-sqlite-web/issues
|
||||||
|
|
1
prometheus/CHANGELOG.md
Normal file
1
prometheus/CHANGELOG.md
Normal file
|
@ -0,0 +1 @@
|
||||||
|
initial beta release
|
133
prometheus/DOCS.md
Normal file
133
prometheus/DOCS.md
Normal file
|
@ -0,0 +1,133 @@
|
||||||
|
# Home Assistant Community Add-on: Prometheus
|
||||||
|
|
||||||
|
....
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
The installation of this add-on is pretty straightforward and not different in
|
||||||
|
comparison to installing any other Home Assistant add-on.
|
||||||
|
|
||||||
|
1. Search for the "Prometheus" add-on in the Supervisor add-on store.
|
||||||
|
1. Install the "Prometheus" add-on.
|
||||||
|
1. Start the "Prometheus" add-on.
|
||||||
|
1. Check the logs of the "Prometheus" to see if everything went well.
|
||||||
|
1. Open the Web UI.
|
||||||
|
|
||||||
|
**Note**: The addon supports both Ingress and direct access, this is the default
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
There are no configuration options for the addon.
|
||||||
|
|
||||||
|
To add additional scrape targets you need to create a file per target in /share/prometheus/targets.
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
job_name: 'octoprint'
|
||||||
|
scrape_interval: 5s
|
||||||
|
metrics_path: '/plugin/prometheus_exporter/metrics'
|
||||||
|
params:
|
||||||
|
apikey: ['VERYSECRETAPIKEY']
|
||||||
|
static_configs:
|
||||||
|
- targets: ['octoprint.example.org:5000']
|
||||||
|
```
|
||||||
|
|
||||||
|
**Note**: _This is just an example, don't copy and paste it! Create your own!_
|
||||||
|
|
||||||
|
The job names `home-assistant` and `prometheus` are already defined by default.
|
||||||
|
For the `homeassistant` target you must add add the following to
|
||||||
|
the Home Assistant configuration:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
prometheus:
|
||||||
|
```
|
||||||
|
|
||||||
|
Rules can be created under `/share/prometheus/rules/`
|
||||||
|
|
||||||
|
The addon will reload the configuration if a valid configuration is available.
|
||||||
|
If not it will log errors in the addon log
|
||||||
|
|
||||||
|
## Grafana
|
||||||
|
|
||||||
|
Grafana can use prometheus as a datasource, to configure this go to grafana
|
||||||
|
and add a datasource.
|
||||||
|
The hostname to connect to is depending on the release you installed.
|
||||||
|
For stable this is `http://a0d7b954-prometheus:9090`
|
||||||
|
|
||||||
|
## Known issues and limitations
|
||||||
|
|
||||||
|
- Job name must be unique, but this has to be enforced by the user.
|
||||||
|
- no alert manager yet
|
||||||
|
|
||||||
|
## Changelog & Releases
|
||||||
|
|
||||||
|
This repository keeps a change log using [GitHub's releases][releases]
|
||||||
|
functionality. The format of the log is based on
|
||||||
|
[Keep a Changelog][keepchangelog].
|
||||||
|
|
||||||
|
Releases are based on [Semantic Versioning][semver], and use the format
|
||||||
|
of ``MAJOR.MINOR.PATCH``. In a nutshell, the version will be incremented
|
||||||
|
based on the following:
|
||||||
|
|
||||||
|
- ``MAJOR``: Incompatible or major changes.
|
||||||
|
- ``MINOR``: Backwards-compatible new features and enhancements.
|
||||||
|
- ``PATCH``: Backwards-compatible bugfixes and package updates.
|
||||||
|
|
||||||
|
## Support
|
||||||
|
|
||||||
|
Got questions?
|
||||||
|
|
||||||
|
You have several options to get them answered:
|
||||||
|
|
||||||
|
- The [Home Assistant Community Add-ons Discord chat server][discord] for add-on
|
||||||
|
support and feature requests.
|
||||||
|
- The [Home Assistant Discord chat server][discord-ha] for general Home
|
||||||
|
Assistant discussions and questions.
|
||||||
|
- The Home Assistant [Community Forum][forum].
|
||||||
|
- Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit]
|
||||||
|
|
||||||
|
You could also [open an issue here][issue] GitHub.
|
||||||
|
|
||||||
|
## Authors & contributors
|
||||||
|
|
||||||
|
The original setup of this repository is by [Robbert Müller][mjrider].
|
||||||
|
|
||||||
|
For a full list of all authors and contributors,
|
||||||
|
check [the contributor's page][contributors].
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2020-2020 Robbert Müller
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
|
|
||||||
|
[contributors]: https://github.com/hassio-addons/addon-Prometheus/graphs/contributors
|
||||||
|
[discord-ha]: https://discord.gg/c5DvZ4e
|
||||||
|
[discord]: https://discord.me/hassioaddons
|
||||||
|
[forum]: https://example.net
|
||||||
|
[mjrider]: https://github.com/mjrider
|
||||||
|
[issue]: https://github.com/hassio-addons/addon-prometheus/issues
|
||||||
|
[keepchangelog]: http://keepachangelog.com/en/1.0.0/
|
||||||
|
[reddit]: https://reddit.com/r/homeassistant
|
||||||
|
[releases]: https://github.com/hassio-addons/addon-prometheus/releases
|
||||||
|
[semver]: http://semver.org/spec/v2.0.0.htm
|
39
prometheus/README.md
Normal file
39
prometheus/README.md
Normal file
|
@ -0,0 +1,39 @@
|
||||||
|
# Home Assistant Community Add-on: Prometheus
|
||||||
|
|
||||||
|
[![Release][release-shield]][release] ![Project Stage][project-stage-shield] ![Project Maintenance][maintenance-shield]
|
||||||
|
|
||||||
|
[![Discord][discord-shield]][discord] [![Community Forum][forum-shield]][forum]
|
||||||
|
|
||||||
|
The open platform for beautiful analytics and monitoring.
|
||||||
|
|
||||||
|
## About
|
||||||
|
|
||||||
|
...
|
||||||
|
|
||||||
|
![Prometheus in the Home Assistant Frontend][screenshot]
|
||||||
|
|
||||||
|
## WARNING! THIS IS A BETA VERSION!
|
||||||
|
|
||||||
|
This Home Assistant Add-ons repository contains beta releases of add-ons.
|
||||||
|
|
||||||
|
- They might stop working at any time.
|
||||||
|
- They could have a negative impact on your system.
|
||||||
|
|
||||||
|
This repository was created for:
|
||||||
|
|
||||||
|
- Anybody willing to test.
|
||||||
|
- Anybody interested in trying out upcoming add-ons or add-on features.
|
||||||
|
|
||||||
|
If you are more interested in stable releases of our add-ons:
|
||||||
|
|
||||||
|
<https://github.com/hassio-addons/repository>
|
||||||
|
|
||||||
|
[discord-shield]: https://img.shields.io/discord/478094546522079232.svg
|
||||||
|
[discord]: https://discord.me/hassioaddons
|
||||||
|
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg
|
||||||
|
[forum]: https://example.org
|
||||||
|
[maintenance-shield]: https://img.shields.io/maintenance/yes/2020.svg
|
||||||
|
[project-stage-shield]: https://img.shields.io/badge/project%20stage-Development-yellowgreen.svg
|
||||||
|
[release-shield]: https://img.shields.io/badge/version-v1.0.0-beta.0-blue.svg
|
||||||
|
[release]: https://github.com/hassio-addons/addon-prometheus/tree/v1.0.0-beta.0
|
||||||
|
[screenshot]: https://github.com/hassio-addons/addon-prometheus/raw/master/images/screenshot.png
|
34
prometheus/config.json
Normal file
34
prometheus/config.json
Normal file
|
@ -0,0 +1,34 @@
|
||||||
|
{
|
||||||
|
"name": "Prometheus",
|
||||||
|
"version": "1.0.0-beta.0",
|
||||||
|
"slug": "prometheus",
|
||||||
|
"description": "Cloud native metrics",
|
||||||
|
"url": "https://github.com/hassio-addons/addon-prometheus",
|
||||||
|
"startup": "services",
|
||||||
|
"ingress": true,
|
||||||
|
"ingress_port": 9090,
|
||||||
|
"ingress_entry": "graph",
|
||||||
|
"panel_icon": "mdi:chart-timeline",
|
||||||
|
"panel_title": "Prometheus",
|
||||||
|
"arch": [
|
||||||
|
"aarch64",
|
||||||
|
"amd64",
|
||||||
|
"armv7"
|
||||||
|
],
|
||||||
|
"boot": "auto",
|
||||||
|
"hassio_api": true,
|
||||||
|
"homeassistant_api": true,
|
||||||
|
"hassio_role": "default",
|
||||||
|
"map": [
|
||||||
|
"share:rw"
|
||||||
|
],
|
||||||
|
"options": {},
|
||||||
|
"ports": {
|
||||||
|
"9090/tcp": null
|
||||||
|
},
|
||||||
|
"ports_description": {
|
||||||
|
"9090/tcp": "Not required for Ingress"
|
||||||
|
},
|
||||||
|
"schema": {},
|
||||||
|
"image": "hassioaddons/prometheus-{arch}"
|
||||||
|
}
|
BIN
prometheus/icon.png
Normal file
BIN
prometheus/icon.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 15 KiB |
BIN
prometheus/logo.png
Normal file
BIN
prometheus/logo.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 15 KiB |
Loading…
Add table
Add a link
Reference in a new issue