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
|
// Copyright (C) 2019-2023 Algorand, Inc.
// This file is part of go-algorand
//
// go-algorand is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// go-algorand is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with go-algorand. If not, see <https://www.gnu.org/licenses/>.
package logging
import (
"crypto/sha256"
"encoding/base64"
"encoding/json"
"fmt"
"os"
"strings"
"github.com/sirupsen/logrus"
"github.com/algorand/go-algorand/config"
"github.com/algorand/go-algorand/util/uuid"
)
// TelemetryConfigFilename default file name for telemetry config "logging.config"
var TelemetryConfigFilename = "logging.config"
var defaultTelemetryUsername = "telemetry-v9"
var defaultTelemetryPassword = "oq%$FA1TOJ!yYeMEcJ7D688eEOE#MGCu"
const hostnameLength = 255
// TelemetryOverride Determines whether an override value is set and what it's value is.
// The first return value is whether an override variable is found, if it is, the second is the override value.
func TelemetryOverride(env string, telemetryConfig *TelemetryConfig) bool {
env = strings.ToLower(env)
if env == "1" || env == "true" {
telemetryConfig.Enable = true
}
if env == "0" || env == "false" {
telemetryConfig.Enable = false
}
return telemetryConfig.Enable
}
// createTelemetryConfig creates a new TelemetryConfig structure with a generated GUID and the appropriate Telemetry endpoint.
// Note: This should only be used/persisted when initially creating 'TelemetryConfigFilename'. Because the methods are called
//
// from various tools and goal commands and affect the future default settings for telemetry, we need to inject
// a "dev" branch check.
func createTelemetryConfig() TelemetryConfig {
enable := false
return TelemetryConfig{
Enable: enable,
GUID: uuid.New(),
URI: "",
MinLogLevel: logrus.WarnLevel,
ReportHistoryLevel: logrus.WarnLevel,
// These credentials are here intentionally. Not a bug.
UserName: defaultTelemetryUsername,
Password: defaultTelemetryPassword,
}
}
// LoadTelemetryConfig loads the TelemetryConfig from the config file
func LoadTelemetryConfig(configPath string) (TelemetryConfig, error) {
return loadTelemetryConfig(configPath)
}
// Save saves the TelemetryConfig to the config file
func (cfg TelemetryConfig) Save(configPath string) error {
f, err := os.Create(configPath)
if err != nil {
return err
}
defer f.Close()
var marshaledConfig MarshalingTelemetryConfig
marshaledConfig.TelemetryConfig = cfg
marshaledConfig.TelemetryConfig.FilePath = ""
marshaledConfig.MinLogLevel = uint32(cfg.MinLogLevel)
marshaledConfig.ReportHistoryLevel = uint32(cfg.ReportHistoryLevel)
// If the configuration contains both default username and password for the telemetry
// server then we just want to substitute a blank string
if marshaledConfig.TelemetryConfig.UserName == defaultTelemetryUsername &&
marshaledConfig.TelemetryConfig.Password == defaultTelemetryPassword {
marshaledConfig.TelemetryConfig.UserName = ""
marshaledConfig.TelemetryConfig.Password = ""
}
enc := json.NewEncoder(f)
err = enc.Encode(marshaledConfig)
return err
}
// getHostGUID returns the Host GUID for telemetry (GUID:Name -- :Name is optional if blank)
func (cfg TelemetryConfig) getHostGUID() string {
ret := cfg.GUID
if cfg.Enable && len(cfg.Name) > 0 {
ret += ":" + cfg.Name
}
return ret
}
// getInstanceName allows us to distinguish between multiple instances running on the same node.
func (cfg TelemetryConfig) getInstanceName() string {
p := config.GetCurrentVersion().DataDirectory
hash := sha256.New()
hash.Write([]byte(cfg.GUID))
hash.Write([]byte(p))
pathHash := sha256.Sum256(hash.Sum(nil))
pathHashStr := base64.StdEncoding.EncodeToString(pathHash[:])
// NOTE: We used to report HASH:DataDir but DataDir is Personally Identifiable Information (PII)
// So we're removing it entirely to avoid GDPR issues.
return fmt.Sprintf("%s", pathHashStr[:16])
}
// SanitizeTelemetryString applies sanitization rules and returns the sanitized string.
func SanitizeTelemetryString(input string, maxParts int) string {
// Truncate to a reasonable size, allowing some undefined separator.
maxReasonableSize := maxParts*hostnameLength + maxParts - 1
if len(input) > maxReasonableSize {
input = input[:maxReasonableSize]
}
return input
}
// Returns err if os.Open fails or if config is mal-formed
func loadTelemetryConfig(path string) (TelemetryConfig, error) {
f, err := os.Open(path)
if err != nil {
return createTelemetryConfig(), err
}
defer f.Close()
var cfg TelemetryConfig
var marshaledConfig MarshalingTelemetryConfig
marshaledConfig.TelemetryConfig = createTelemetryConfig()
dec := json.NewDecoder(f)
err = dec.Decode(&marshaledConfig)
cfg = marshaledConfig.TelemetryConfig
cfg.MinLogLevel = logrus.Level(marshaledConfig.MinLogLevel)
cfg.ReportHistoryLevel = logrus.Level(marshaledConfig.ReportHistoryLevel)
cfg.FilePath = path
if cfg.UserName == "" && cfg.Password == "" {
cfg.UserName = defaultTelemetryUsername
cfg.Password = defaultTelemetryPassword
}
// Sanitize user-defined name.
if len(cfg.Name) > 0 {
cfg.Name = SanitizeTelemetryString(cfg.Name, 1)
}
return cfg, err
}
|
