Categorygithub.com/weaveworks/go-checkpoint
modulepackage
0.0.0-20220223124739-fd9899e2b4f2
Repository: https://github.com/weaveworks/go-checkpoint.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
19
Dependents
16
Files
399 SLOC

# README

Go Checkpoint Client

Test status

Checkpoint is an internal service at Weaveworks to check version information, broadcast security bulletins, etc. This repository contains the client code for accessing that service. It is a fork of Hashicorp's Go Checkpoint Client and is embedded in several Weaveworks open source projects and proprietary software.

We understand that software making remote calls over the internet for any reason can be undesirable. Because of this, Checkpoint can be disabled in all of Weavework's software that includes it. You can view the source of this client to see that it is not sending any private information.

To disable checkpoint calls, set the CHECKPOINT_DISABLE environment variable, e.g.

export CHECKPOINT_DISABLE=1

Note: This repository is probably useless outside of internal Weaveworks use. It is open source for disclosure and because Weaveworks open source projects must be able to link to it.

# Functions

Check checks for alerts and new version information.
CheckInterval is used to check for a response on a given interval duration.
IsCheckDisabled returns true if checks are disabled.

# Structs

CheckAlert is a single alert message from a check request.
Checker is a state of a checker.
CheckParams are the parameters for configuring a check request.
CheckResponse is the response for a check request.
Flag is some extra information about a product we want to pass along.