fullstorydev / hauser

Service for moving your Fullstory export files to a data warehouse
MIT License
49 stars 23 forks source link

added details to GOOS / GOARCH and "Run it" instructions #52

Closed sam-fs closed 5 years ago

sam-fs commented 5 years ago

Added instructions for finding GOOS and GOARCH values.

Edited the "Run it" instructions so they will work when in a directory not on GOPATH.

sam-fs commented 5 years ago

Thanks for the quick feedback, Jess.

I struggled with how much detail to provide, and actually removed a sizable chunk of what I originally wrote, including that link to all possible values. :-) I wasn't sure it was ok to expand the content from simple instructions to more educational content, but I like the idea. Will make changes and resubmit.

On Fri, Apr 19, 2019 at 5:02 PM Jessica Greenfield notifications@github.com wrote:

@jameremo commented on this pull request.

A few small comments. Basically I think if we're going to go down the path of trying to educate people who don't know Go, we may have to add a bit more than what is in this first revision.

In README.md https://github.com/fullstorydev/hauser/pull/52#discussion_r277089116:

@@ -13,8 +13,11 @@ SQL recipes for Data Export analysis are in the [Data Export Cookbook](https://g

Quick Start

  • Make sure you have installed Go 1.9 or higher.
  • Build it (for EC2, for example): GOOS=linux GOARCH=amd64 go get github.com/fullstorydev/hauser http://github.com/fullstorydev/hauser
    • Type go version to find your GOOS and GOARCH values.
    • Example (macOS): go1.11.5 darwin/amd64 is GOOS=darwin GOARCH=amd64

I think there's really 2 uses cases to cover with respect to GOOS and GOARCH here:

  1. You're building it in order to to run/test it locally. In this case, you don't even need to set these two variables, as your Go installation will assume they should have values matching your system.
  2. You're cross-compiling it in order to deploy it to a VM or Docker container somewhere in the cloud, in which case the values you need to choose values that match your deployment target. This is what I think we originally wrote the docs for, since it says "for EC2, for example". In this case, maybe it's helpful to include a link to all the possible values https://golang.org/doc/install/source#environment for these two variables.

Is it fair to say the first case will be that of data scientists looking to "play" with our data exports? Someone like me who wants to set up a permanent ETL pipeline would likely be interested in the second case.

In README.md https://github.com/fullstorydev/hauser/pull/52#discussion_r277090881:

  • Copy the included example-config.toml file and customize it for your environment, including your FullStory API key, warehouse host, and credentials. AWS credentials (for S3) come from your local environment. - Run it: ./hauser -c <your updated config file> + Run it: $GOPATH/bin/hauser -c <your updated config file>

We may need to go deeper down the rabbit hole of people not knowing Go here; this change assumes that your GOPATH is set. If it's not set it has a default value https://golang.org/doc/code.html#GOPATH, so the go get command will succeed, but we'll still fail to run here. (as you can see I found all the official Go docs on this subject since we last talked!)

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/fullstorydev/hauser/pull/52#pullrequestreview-228823452, or mute the thread https://github.com/notifications/unsubscribe-auth/AK67X4B3M63MDYGX6FYHUNTPRIXOFANCNFSM4HHE63UA .

-- Thanks, Sam