132 lines
5.1 KiB
Plaintext
132 lines
5.1 KiB
Plaintext
|
# Home Assistant Add-on: Promtail
|
||
|
|
|
||
|
|
[![GitHub Release][releases-shield]][releases]
|
||
|
|
![Project Stage][project-stage-shield]
|
||
|
|
[![License][license-shield]][license]
|
||
|
|
|
||
|
|
![Project Maintenance][maintenance-shield]
|
||
|
|
[![Community Forum][forum-shield]][forum]
|
||
|
|
|
||
|
|
[Promtail][promtail] is an agent which ships the contents of local logs to a private
|
||
|
|
[Loki][loki] instance or [Grafana Cloud][grafana-cloud]. It is usually deployed
|
||
|
|
to every machine that has applications needed to be monitored.
|
||
|
|
|
||
|
|
{% set repository = namespace(url='https%3A//github.com/mdegat01/hassio-addons', slug='39bd2704') %}
|
||
|
|
{% if channel == "edge" %}
|
||
|
|
{% set repository.url = repository.url + '-edge' %}
|
||
|
|
{% set repository.slug = '7eb274d5' %}
|
||
|
|
## WARNING! THIS IS AN EDGE REPOSITORY
|
||
|
|
|
||
|
|
This Add-ons repository contains edge builds of add-ons. Edge
|
||
|
|
builds of add-ons are based upon the latest development version.
|
||
|
|
|
||
|
|
- They may not work at all.
|
||
|
|
- 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.
|
||
|
|
- Developers.
|
||
|
|
|
||
|
|
If you are more interested in stable releases of these add-ons:
|
||
|
|
|
||
|
|
<https://github.com/mdegat01/hassio-addons>
|
||
|
|
|
||
|
|
{% elif channel == "beta" %}
|
||
|
|
{% set repository.url = repository.url + '-beta' %}
|
||
|
|
{% set repository.slug = 'e9a81774' %}
|
||
|
|
## WARNING! THIS IS A BETA REPOSITORY
|
||
|
|
|
||
|
|
This Add-ons repository contains beta builds of add-ons. Beta
|
||
|
|
builds of add-ons are based upon the latest release including pre-releases.
|
||
|
|
|
||
|
|
- 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 these add-ons:
|
||
|
|
|
||
|
|
<https://github.com/mdegat01/hassio-addons>
|
||
|
|
|
||
|
|
{% endif %}
|
||
|
|
## About
|
||
|
|
|
||
|
|
By default this addon version of Promtail will tail logs from the systemd
|
||
|
|
journal. This will include all logs from all addons, supervisor, home assistant,
|
||
|
|
docker, and the host system itself. In addition you can set it up to look for
|
||
|
|
local log files in `/share` or `/ssl` if you have a particular add-on that logs
|
||
|
|
to a file instead of to `stdout`.
|
||
|
|
|
||
|
|
## Support
|
||
|
|
|
||
|
|
Got questions?
|
||
|
|
|
||
|
|
You have several ways to get them answered:
|
||
|
|
|
||
|
|
- The Home Assistant [Community Forum][forum]. I am
|
||
|
|
[CentralCommand][forum-centralcommand] there.
|
||
|
|
- The Home Assistant [Discord Chat Server][discord-ha]. Use the #add-ons channel,
|
||
|
|
I am CentralCommand#0913 there.
|
||
|
|
|
||
|
|
You could also [open an issue here][issue] on GitHub.
|
||
|
|
|
||
|
|
## Authors & contributors
|
||
|
|
|
||
|
|
The original setup of this repository is by [Mike Degatano][mdegat01].
|
||
|
|
|
||
|
|
For a full list of all authors and contributors,
|
||
|
|
check [the contributor's page][contributors].
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
MIT License
|
||
|
|
|
||
|
|
Copyright (c) 2021-2022 Mike Degatano
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
{% if channel == "edge" %}
|
||
|
|
[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg
|
||
|
|
{% elif channel == "beta" %}
|
||
|
|
[project-stage-shield]: https://img.shields.io/badge/project%20stage-beta-orange.svg
|
||
|
|
{% else %}
|
||
|
|
[project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg
|
||
|
|
{% endif %}
|
||
|
|
[contributors]: https://github.com/mdegat01/addon-promtail/graphs/contributors
|
||
|
|
[discord-ha]: https://discord.gg/c5DvZ4e
|
||
|
|
[forum-centralcommand]: https://community.home-assistant.io/u/CentralCommand/?u=CentralCommand
|
||
|
|
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg
|
||
|
|
[forum]: https://community.home-assistant.io/t/home-assistant-add-on-promtail/293732?u=CentralCommand
|
||
|
|
[grafana-cloud]: https://grafana.com/products/cloud/
|
||
|
|
[loki]: https://grafana.com/oss/loki
|
||
|
|
[mdegat01]: https://github.com/mdegat01
|
||
|
|
[issue]: https://github.com/mdegat01/addon-promtail/issues
|
||
|
|
[license]: https://github.com/mdegat01/addon-promtail/blob/main/LICENSE
|
||
|
|
[license-shield]: https://img.shields.io/github/license/mdegat01/addon-promtail.svg
|
||
|
|
[maintenance-shield]: https://img.shields.io/maintenance/yes/2022.svg
|
||
|
|
[promtail]: https://grafana.com/docs/loki/latest/clients/promtail/
|
||
|
|
[releases-shield]: https://img.shields.io/github/release/mdegat01/addon-promtail.svg
|
||
|
|
[releases]: https://github.com/mdegat01/addon-promtail/releases
|