1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271
|
package segment
import (
"context"
"encoding/binary"
"errors"
"fmt"
"hash/fnv"
"io"
"net"
"net/http"
"os"
"path/filepath"
"sort"
"strings"
"time"
crcConfig "github.com/crc-org/crc/v2/pkg/crc/config"
"github.com/crc-org/crc/v2/pkg/crc/constants"
"github.com/crc-org/crc/v2/pkg/crc/logging"
"github.com/crc-org/crc/v2/pkg/crc/network/httpproxy"
"github.com/crc-org/crc/v2/pkg/crc/telemetry"
"github.com/crc-org/crc/v2/pkg/crc/version"
crcos "github.com/crc-org/crc/v2/pkg/os"
crcTerminal "github.com/crc-org/crc/v2/pkg/os/terminal"
"github.com/pborman/uuid"
"github.com/segmentio/analytics-go/v3"
"github.com/spf13/cast"
)
var WriteKey = "R7jGNYYO5gH0Nl5gDlMEuZ3gPlDJKQak" // test
type Client struct {
segmentClient analytics.Client
config *crcConfig.Config
userID string
identifyHash uint64
identifyHashPath string
}
func NewClient(config *crcConfig.Config, transport http.RoundTripper) (*Client, error) {
return newCustomClient(config, transport,
filepath.Join(constants.GetHomeDir(), ".redhat", "anonymousId"),
filepath.Join(constants.CrcBaseDir, "segmentIdentifyHash"),
analytics.DefaultEndpoint)
}
func newCustomClient(config *crcConfig.Config, transport http.RoundTripper, telemetryFilePath, identifyHashFilePath, segmentEndpoint string) (*Client, error) {
userID, err := getUserIdentity(telemetryFilePath)
if err != nil {
return nil, err
}
client, err := analytics.NewWithConfig(WriteKey, analytics.Config{
Endpoint: segmentEndpoint,
Logger: &loggingAdapter{},
DefaultContext: &analytics.Context{
IP: net.IPv4(0, 0, 0, 0),
},
Transport: transport,
})
if err != nil {
return nil, err
}
identifyHash, err := readIdentifyHash(identifyHashFilePath)
if err != nil {
return nil, err
}
return &Client{
segmentClient: client,
config: config,
userID: userID,
identifyHash: identifyHash,
identifyHashPath: identifyHashFilePath,
}, nil
}
func (c *Client) Close() error {
return c.segmentClient.Close()
}
func (c *Client) UploadAction(action, source, status string) error {
return c.upload(action, baseProperties(source).
Set("status", status))
}
func (c *Client) UploadCmd(ctx context.Context, action string, duration time.Duration, err error) error {
return c.upload(action, properties(ctx, err, duration))
}
func identifyHash(identify *analytics.Identify) (uint64, error) {
h := fnv.New64a()
_, err := io.WriteString(h, identify.UserId)
if err != nil {
logging.Warnf("Failed to calculate checksum for userID '%s'", identify.UserId)
return 0, err
}
// Make sure we hash the map fields always in the same order
traits := []string{}
for trait := range identify.Traits {
traits = append(traits, trait)
}
sort.Strings(traits)
for _, trait := range traits {
_, err := io.WriteString(h, trait)
if err != nil {
logging.Warnf("Failed to calculate checksum for '%s'", trait)
return 0, err
}
str, err := cast.ToStringE(identify.Traits[trait])
if err != nil {
logging.Warnf("Could not convert 'Traits[%s]' to string, extraneous 'identify' may be sent to segment", trait)
return 0, err
}
_, err = io.WriteString(h, str)
if err != nil {
logging.Warnf("Failed to calculate checksum for '%s'", str)
return 0, err
}
}
return h.Sum64(), nil
}
func readIdentifyHash(identifyHashPath string) (uint64, error) {
if identifyHashPath == "" {
return 0, nil
}
cachedHashBytes, err := os.ReadFile(identifyHashPath)
if err != nil {
if errors.Is(err, os.ErrNotExist) {
return 0, nil
}
return 0, err
}
if length := len(cachedHashBytes); length != 8 {
return 0, fmt.Errorf("Got %d bytes hash, expected 8", length)
}
return binary.LittleEndian.Uint64(cachedHashBytes), nil
}
func writeIdentifyHash(client *Client) error {
if client.identifyHashPath == "" {
return nil
}
hashBytes := make([]byte, 8)
binary.LittleEndian.PutUint64(hashBytes, client.identifyHash)
return os.WriteFile(client.identifyHashPath, hashBytes, 0600)
}
func (c *Client) identifyNew() *analytics.Identify {
return &analytics.Identify{
UserId: c.userID,
Traits: addConfigTraits(c.config, traits()),
}
}
func (c *Client) upload(action string, a analytics.Properties) error {
if c.config.Get(crcConfig.ConsentTelemetry).AsString() != "yes" {
return nil
}
// Add preset value as property for each event before uploading to segment
preset := crcConfig.GetPreset(c.config)
a = a.Set("preset", preset)
identify := c.identifyNew()
hash, err := identifyHash(identify)
if err != nil || hash != c.identifyHash {
logging.Debug("Sending 'identify' to segment")
if err := c.segmentClient.Enqueue(identify); err != nil {
return err
}
c.identifyHash = hash
if err := writeIdentifyHash(c); err != nil {
return fmt.Errorf("failed to write new identify hash to file: %w", err)
}
}
return c.segmentClient.Enqueue(analytics.Track{
UserId: c.userID,
Event: action,
Properties: a,
})
}
func baseProperties(source string) analytics.Properties {
return analytics.NewProperties().
Set("version", version.GetCRCVersion()).
Set("source", source)
}
func properties(ctx context.Context, err error, duration time.Duration) analytics.Properties {
properties := baseProperties("cli")
for k, v := range telemetry.GetContextProperties(ctx) {
properties = properties.Set(k, v)
}
properties = properties.
Set("success", err == nil).
Set("duration", duration.Milliseconds()).
Set("tty", crcTerminal.IsRunningInTerminal()).
Set("remote", crcos.RunningUsingSSH())
if err != nil {
properties = properties.Set("error", telemetry.SetError(err)).
Set("error-type", errorType(err))
}
return properties
}
func addConfigTraits(c *crcConfig.Config, in analytics.Traits) analytics.Traits {
return in.
Set("proxy", isProxyUsed()).
Set(crcConfig.NetworkMode, crcConfig.GetNetworkMode(c)).
Set(crcConfig.EnableClusterMonitoring, c.Get(crcConfig.EnableClusterMonitoring).AsBool()).
Set(crcConfig.ExperimentalFeatures, c.Get(crcConfig.ExperimentalFeatures).AsBool())
}
func isProxyUsed() bool {
proxyConfig, err := httpproxy.NewProxyConfig()
if err != nil {
return false
}
return proxyConfig.IsEnabled()
}
func getUserIdentity(telemetryFilePath string) (string, error) {
var id []byte
if err := os.MkdirAll(filepath.Dir(telemetryFilePath), 0750); err != nil {
return "", err
}
if _, err := os.Stat(telemetryFilePath); !os.IsNotExist(err) {
id, err = os.ReadFile(telemetryFilePath)
if err != nil {
return "", err
}
}
if uuid.Parse(strings.TrimSpace(string(id))) == nil {
id = []byte(uuid.NewRandom().String())
if err := os.WriteFile(telemetryFilePath, id, 0600); err != nil {
return "", err
}
}
return strings.TrimSpace(string(id)), nil
}
type loggingAdapter struct{}
func (l *loggingAdapter) Logf(format string, args ...interface{}) {
logging.Infof(format, args...)
}
func (l *loggingAdapter) Errorf(format string, args ...interface{}) {
logging.Debugf(format, args...)
}
func errorType(err error) string {
wrappedErr := errors.Unwrap(err)
if wrappedErr != nil {
return fmt.Sprintf("%T", wrappedErr)
}
return fmt.Sprintf("%T", err)
}
|