Categorygithub.com/hashicorp/go-checkpoint
modulepackage
0.5.0
Repository: https://github.com/hashicorp/go-checkpoint.git
Documentation: pkg.go.dev

# README

Go Checkpoint Client

Checkpoint is an internal service at Hashicorp that we use to check version information, broadcast security bulletins, etc.

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 our software that includes it. You can view the source of this client to see that we're not sending any private information.

Each Hashicorp application has it's specific configuration option to disable checkpoint calls, but the CHECKPOINT_DISABLE makes the underlying checkpoint component itself disabled. For example in the case of packer:

CHECKPOINT_DISABLE=1 packer build 

Note: This repository is probably useless outside of internal HashiCorp use. It is open source for disclosure and because our 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.
Report sends telemetry information to checkpoint.
ReportRequest creates a request object for making a report.
Versions returns the version constrains for a given service and product.

# Structs

CheckAlert is a single alert message from a check request.
CheckParams are the parameters for configuring a check request.
CheckResponse is the response for a check request.
ReportParams are the parameters for configuring a telemetry report.
VersionsParams are the parameters for a versions request.
VersionsResponse is the response for a versions request.