[SHACK-188] telemetry cleanup tasks #134
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fe38dbe to
b24385b
Compare
tyler-ball
previously approved these changes
May 16, 2018
robbkidd
reviewed
May 16, 2018
| run_timestamp: run_timestamp, | ||
| host_platform: host_platform, | ||
| event_data: data | ||
| } |
| begin | ||
| File.read(ChefCLI::Config.telemetry_installation_identifier_file).chomp | ||
| rescue | ||
| ChefCLI::Log.info "could not read #{ChefCLI::Config.telemetry_installation_identifier_file} - using default id" |
There was a problem hiding this comment.
Is this sort of user output something that should be defined in the i18n data?
There was a problem hiding this comment.
No, just a log entry. The user need not know or care about this issue.
| if ChefCLI::Telemeter.enabled? | ||
| # dev mode telemetry gets sent to a different location | ||
| if ChefCLI::Config.telemetry.dev && !ENV.has_key?("CHEF_TELEMETRY_ENDPOINT") | ||
| ENV["CHEF_TELEMETRY_ENDPOINT"] = "https://telemetry-acceptance.chef.io" |
There was a problem hiding this comment.
What do you think about an or-equals here instead of the longer if && statement?
| it "configures the environment to submit to the Acceptance telemetry endpoint" do | ||
| subject.run | ||
| expect(ENV["CHEF_TELEMETRY_ENDPOINT"]).to eq "https://telemetry-acceptance.chef.io" | ||
| end |
There was a problem hiding this comment.
Also should test the case for when the env var is set and doesn't get overriden:
Maybe:
it "uses an endpoint the user has set in the environment" do
allow(ENV).to receive(:[]).with("CHEF_TELEMETRY_ENDPOINT").and_return("http://localhost:5432")
subject.run
expect(ENV["CHEF_TELEMETRY_ENDPOINT"]).to eq "http://localhost:5432"
end3761cb6 to
4c8603e
Compare
* when telemetry.dev is true, use the acceptance endpoint for telemetry * when telemetry is disabled, just clean up the session files and don't send. Even though the telemetry gem would not actually submit them when disabled, seeing workstation logs stating that we're sending telemetry files when it's disabled could be easily misunderstood. Signed-off-by: Marc A. Paradise <marc.paradise@gmail.com>
Since we're now using a different endpoint to submit to when in dev mode, we don't need to capture telemetry_mode = dev|prod in the telemetry data. Signed-off-by: Marc A. Paradise <marc.paradise@gmail.com>
Signed-off-by: Marc A. Paradise <marc.paradise@gmail.com>
Capture the version of chef-cli in the telemetry session data, so that we can be sure we're sending the right version to telemetry This prevents the following scenario: * customer runs command under version 1.0.1 * customer upgrades * customer runs command under version 1.0.2 * telemetry submits previous 1.0.1 session as version 1.0.2 Signed-off-by: Marc A. Paradise <marc.paradise@gmail.com>
Every event will now include a unique installation_id, which is a GUID we generate at the same time as other first-run tasks. We store it in CHefCLI::Config.telemetry_installation_identiifer_file -> .chef-workstation/installation_id. Signed-off-by: Marc A. Paradise <marc.paradise@gmail.com>
…sent Signed-off-by: Marc A. Paradise <marc.paradise@gmail.com>
4c8603e to
af340d8
Compare
|
Updated with review comment fixes |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Several cleanup tasks:
Telemeter::enabled?Individual commit messages have some more details.