diff --git a/README.md b/README.md index e098cf5..7c17422 100644 --- a/README.md +++ b/README.md @@ -1,61 +1,2 @@ -# prometheus-android-exporter - -[![CircleCI](https://dl.circleci.com/status-badge/img/gh/birdthedeveloper/prometheus-android-exporter/tree/master.svg?style=svg&circle-token=6a31d132a46fd4e7cf04dd49ef390f1776e38cfc)](https://dl.circleci.com/status-badge/redirect/gh/birdthedeveloper/prometheus-android-exporter/tree/master) - -Prometheus exporter for android phones. Can traverse NAT by leveraging PushProx proxy. Not intended -to run as ROOT. Exposes various hardware sensor metrics. - -# Repository contents -- Folder ./client contains Jetpack Compose android Prometheus exporter written in kotlin. -- Folder ./server contains ansible playbook for simple deployment of prometheus monitoring stack - on a virtual private server, that is deployment of prometheus database itself, grafana - monitoring dashboard and pushprox, a prometheus proxy used to traverse NAT while still following - the pull model. -- Folder ./local contains simple docker-compose.yaml to spin up prometheus database on localhost - quickly. - -# Not public -143.42.59.63:9090 - prometheus - -# Client - -## To format code in android studio -``` -CTRL + SHIFT + ALT + L -``` - -## File configuration -Client application is configurable via a configuration file. -Place such file on your android device at a following path: -``` -data/user/0/com.birdthedeveloper.prometheus.android.exporter/files/ -``` -The name of such configuration file can be either `config.yaml` or `config.yml` - -Configurable fields are described in `./config_file_structure.yaml`, all -fields are optional. - -### ADB port forwarding -ADB port forwarding is usefull when running the client application -on android emulator and prometheus database on the host -ADB port forwarding allows to map specific host's port to emulator's port -Syntax is as follows (for port 8080) -``` -$ adb forward tcp:8080 tcp:8080 -``` - -# Server - -## TL;DR -``` -cd ./server - -# edit ansible_inventory - -# To apply ansible playbook -$ ansible-playbook ansible_playbook.yaml - -# To only apply changed configuration -$ ansible-playbook ansible_playbook.yaml --tags config -``` - +# Prometheus Android Exporter +Please note that this is a work in progress. diff --git a/README.md.wip b/README.md.wip new file mode 100644 index 0000000..e098cf5 --- /dev/null +++ b/README.md.wip @@ -0,0 +1,61 @@ +# prometheus-android-exporter + +[![CircleCI](https://dl.circleci.com/status-badge/img/gh/birdthedeveloper/prometheus-android-exporter/tree/master.svg?style=svg&circle-token=6a31d132a46fd4e7cf04dd49ef390f1776e38cfc)](https://dl.circleci.com/status-badge/redirect/gh/birdthedeveloper/prometheus-android-exporter/tree/master) + +Prometheus exporter for android phones. Can traverse NAT by leveraging PushProx proxy. Not intended +to run as ROOT. Exposes various hardware sensor metrics. + +# Repository contents +- Folder ./client contains Jetpack Compose android Prometheus exporter written in kotlin. +- Folder ./server contains ansible playbook for simple deployment of prometheus monitoring stack + on a virtual private server, that is deployment of prometheus database itself, grafana + monitoring dashboard and pushprox, a prometheus proxy used to traverse NAT while still following + the pull model. +- Folder ./local contains simple docker-compose.yaml to spin up prometheus database on localhost + quickly. + +# Not public +143.42.59.63:9090 - prometheus + +# Client + +## To format code in android studio +``` +CTRL + SHIFT + ALT + L +``` + +## File configuration +Client application is configurable via a configuration file. +Place such file on your android device at a following path: +``` +data/user/0/com.birdthedeveloper.prometheus.android.exporter/files/ +``` +The name of such configuration file can be either `config.yaml` or `config.yml` + +Configurable fields are described in `./config_file_structure.yaml`, all +fields are optional. + +### ADB port forwarding +ADB port forwarding is usefull when running the client application +on android emulator and prometheus database on the host +ADB port forwarding allows to map specific host's port to emulator's port +Syntax is as follows (for port 8080) +``` +$ adb forward tcp:8080 tcp:8080 +``` + +# Server + +## TL;DR +``` +cd ./server + +# edit ansible_inventory + +# To apply ansible playbook +$ ansible-playbook ansible_playbook.yaml + +# To only apply changed configuration +$ ansible-playbook ansible_playbook.yaml --tags config +``` +