Add dmsghttp logserver route #1579
Conversation
… tp setup node configuration
pkg/skyenv/skyenv.go
Outdated
| @@ -108,7 +108,8 @@ const ( | |||
| RewardFile string = "reward.txt" | |||
|
|
|||
| // NodeInfo is the name of the survey file | |||
| NodeInfo string = "node-info.json" | |||
| NodeInfo string = "node-info.json" | |||
| SurveyName string = "node-info" // SurveyName ... | |||
There was a problem hiding this comment.
No need to define the HTTP path here. We dont need to change it frequently and can just hardcode it as its used exactly once.
There was a problem hiding this comment.
I've dropped the extra declaration SurveyName, but instead of directly hardcoding I've opted for this implementation:
//Derive the surveyName from visorconfig.NodeInfo by dropping the ".json" suffix
surveyName := strings.TrimSuffix(string(visorconfig.NodeInfo), ".json")
// This survey endpoint generates the survey as a response
authRoute.GET("/"+surveyName, func(c *gin.Context) {
| @@ -54,84 +54,3 @@ func (d *Duration) UnmarshalJSON(b []byte) error { | |||
| return errors.New("invalid duration") | |||
| } | |||
| } | |||
|
|
|||
| // VisorConfig is every field of the config | |||
| type VisorConfig struct { | |||
There was a problem hiding this comment.
This is the old visorconfig, right? Any reason we are deleting it? Because its not used anymore and we dont expect users to have to upgrade from that?
There was a problem hiding this comment.
that was something that I added there a long time ago that i think was used briefly but then not used
pkg/visor/logserver/api.go
Outdated
| rewardAddressBytes, err := os.ReadFile(localPath + "/" + visorconfig.RewardFile) //nolint | ||
| if err == nil { | ||
| //remove any newline from rewardAddress string | ||
| rewardAddress = strings.TrimSuffix(string(rewardAddressBytes), "\n") |
There was a problem hiding this comment.
Just use strings.TrimSpace please.
There was a problem hiding this comment.
changed on next commit
| // Print results. | ||
| s, err := json.MarshalIndent(survey, "", "\t") | ||
| if err != nil { | ||
| log.WithError(err).Error("Could not marshal system survey to json.") | ||
| } | ||
|
|
||
| c.Header("Content-Type", "application/json") | ||
| c.Writer.WriteHeader(http.StatusOK) | ||
|
|
||
| _, err = c.Writer.Write([]byte(s)) | ||
| if err != nil { | ||
| httputil.GetLogger(c.Request).WithError(err).Errorf("failed to write json response") | ||
| } |
There was a problem hiding this comment.
I think I mentioned this before, but you can literally just do:
c.JSON(http.StatusOK, gin.H{survey})
There was a problem hiding this comment.
I am intentionally using generic c.Writer.Write methods instead of gin's type-specific methods.
It makes it more interchangeable with standard library http server in case we ever decide to move away from gin.
…etching reward address directly if needed
|
The latest commit also adds an authenticated route for the reward.txt file ; just in case This will optionally allow for switching from downloading the full survey on every log & survey collection run to optionally just refreshing the reward.txt file ; the surveys can be re-downloaded less frequently in that instance. |
/node-infoas a route for the dmsghttp survey & transport logging serverthis route will generate the system survey and respond with it, rather than serving it as a static file.
It will also allow the survey to be collected even if the reward address does not exist
Mainly it is needed for collecting surveys from visors which are otherwise online and once generated a survey, but subsequently are not serving it
#1570
this will also allow for surveys to be collected from the survey whitelisted public keys for management of clusters in the instance the operator is not otherwise seeking rewards