sqr
/
greenhouse-telemetry
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
🌱🏠☎️ A simple gateway in front of Grafana Loki, for collecting telemetry data for the greenhouse alpha test phase
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
10 Commits
1 Branch
0 Tags
74 KiB
 
 
 
Branch: main
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'main'
${ noResults }
forest f4d9aabfdc
small telemetry fixes 		3 years ago
.gitignore ignore dockerbuild folder 3 years ago
Dockerfile app appears to be working 3 years ago
ReadMe.md markdown list 3 years ago
build-docker.sh small telemetry fixes 3 years ago
go.mod first commit of passthrough telemetry 3 years ago
go.sum first commit of passthrough telemetry 3 years ago
main.go small telemetry fixes 3 years ago
mascot-calling.png create ReadMe 3 years ago

ReadMe.md

greenhouse-telemetry

Pitney the Pineapple is dailing someone on thier celly phone!

how it works

This application is a simple HTTP reverse proxy that acts as a gateway of sorts in front of Grafana 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.