Browse Source

create ReadMe

main
forest 1 month ago
commit
4915e77f6e
2 changed files with 28 additions and 0 deletions
  1. +28
    -0
      ReadMe.md
  2. BIN
      mascot-calling.png

+ 28
- 0
ReadMe.md View File

@ -0,0 +1,28 @@
## greenhouse-telemetry
![Pitney the Pineapple is dailing someone on thier celly phone!](mascot-calling.png)
### how it works
This application is a simple HTTP reverse proxy that acts as a gateway of sorts in front of [Grafana Loki](https://grafana.com/oss/loki/).
It has a couple reasons to exist:
1. It collects metadata (mostly source IP address) and adds it to the messages that get stored in Loki
2. It reduces the publically accessible surface area of Loki to make it easier for me to secure.
3. It performs additional indexing on telemetry events that come in.
- for example, if I get a `jesse-n-james@silph.co` `account_registration` event from `1.2.3.4` and then later I get a `installer_started` event from `1.2.3.4`, the `installer_started` event won't have an email address -- this app will be responsible for decorating that `installer_started` event with the `jesse-n-james@silph.co` email address.
### rationale
During the alpha test phase, we're collecting telemetry from all of the greenhouse applications and installation scripts. I have added this functionality to assist with discovery/debugging of issues in the system.
If you wish to participate in the alpha test release phase, you cannot opt out of this telemetry; debugging/verifying the operation of the system is the whole point of the alpha test.
The telemetry data is only transmitted to / stored on my personal server. I can't prove anything, but you have my word that I will keep this data close to my chest and delete it as soon as I don't need it any more.
When greenhouse enters beta and eventual 1.0 release phases, the telemetry will be further anonymized, relaxed, or even completely removed, to minimize the amount of personally identifiable information that I have to collect as a part of the operation of the service.

BIN
mascot-calling.png View File

Before After
Width: 256  |  Height: 256  |  Size: 22 KiB

Loading…
Cancel
Save