Merge remote-tracking branch 'origin/release/6.4' into main

Author: portertech

CHANGELOG.md

@@ -6,7 +6,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic
 Versioning](http://semver.org/spec/v2.0.0.html).
 
-## Unreleased
+## [6.4.1] - 2021-08-24
 
 ### Added
 - Added `ignore-already-initialized` configuration flag to the sensu-backend
@@ -48,6 +48,12 @@ the etcd response header is nil.
 - Agent events API now accepts metrics event.
 - Fixed rare cases where the agent could fail to delete temporary files when
 downloading assets.
+- Forwards compatibility with newer Sensu backends has been improved. Users can
+now create resources with fields that are unknown to Sensu.
+
+### Changed
+- API and agent services now log at warn level when the start up, not at info.
+- Backend now reports when it is ready to process events at warn level.
 
 ## [6.4.0] - 2021-06-23
 

backend/agentd/agentd.go

@@ -204,7 +204,7 @@ func New(c Config, opts ...Option) (*Agentd, error) {
 
 // Start Agentd.
 func (a *Agentd) Start() error {
-	logger.Info("starting agentd on address: ", a.httpServer.Addr)
+	logger.Warn("starting agentd on address: ", a.httpServer.Addr)
 	ln, err := net.Listen("tcp", a.httpServer.Addr)
 	if err != nil {
 		return fmt.Errorf("failed to start agentd: %s", err)

backend/apid/apid.go

@@ -13,7 +13,7 @@ import (
 
 	"github.com/gorilla/mux"
 	"github.com/prometheus/client_golang/prometheus/promhttp"
-	"go.etcd.io/etcd/client/v3"
+	clientv3 "go.etcd.io/etcd/client/v3"
 
 	"github.com/sensu/sensu-go/backend/apid/actions"
 	"github.com/sensu/sensu-go/backend/apid/graphql"
@@ -269,7 +269,7 @@ func notFoundHandler(w http.ResponseWriter, req *http.Request) {
 
 // Start APId.
 func (a *APId) Start() error {
-	logger.Info("starting apid on address: ", a.HTTPServer.Addr)
+	logger.Warn("starting apid on address: ", a.HTTPServer.Addr)
 	ln, err := net.Listen("tcp", a.HTTPServer.Addr)
 	if err != nil {
 		return fmt.Errorf("failed to start apid: %s", err)

backend/apid/graphql/mutations.go

@@ -43,7 +43,6 @@ func (r *mutationsImpl) PutWrapped(p schema.MutationPutWrappedFieldResolverParam
 
 	// decode given
 	dec := json.NewDecoder(strings.NewReader(raw))
-	dec.DisallowUnknownFields()
 	if err = dec.Decode(&ret); err != nil {
 		return map[string]interface{}{
 			"errors": wrapInputErrors("raw", err),

backend/backend.go

@@ -14,7 +14,7 @@ import (
 	"github.com/prometheus/client_golang/prometheus"
 	"github.com/spf13/viper"
 	"go.etcd.io/etcd/client/pkg/v3/transport"
-	"go.etcd.io/etcd/client/v3"
+	clientv3 "go.etcd.io/etcd/client/v3"
 	"golang.org/x/time/rate"
 	"google.golang.org/grpc"
 
@@ -523,6 +523,8 @@ func (b *Backend) runOnce() error {
 	defer errCancel()
 	eg.Go(errCtx)
 
+	logger.Warn("backend is running and ready to accept events")
+
 	select {
 	case err := <-eg.Err():
 		logger.WithError(err).Error("backend stopped working and is restarting")

cli/resource/parse.go

@@ -51,7 +51,8 @@ func Parse(in io.Reader) ([]*types.Wrapper, error) {
 			}
 		}
 		dec := json.NewDecoder(bytes.NewReader(jsonBytes))
-		dec.DisallowUnknownFields()
+		dec.DisallowUnknownFields() // this will only warn about top-level keys like spec, api_version
+		warnDec := json.NewDecoder(bytes.NewReader(jsonBytes))
 		errCount := 0
 		for dec.More() {
 			var w types.Wrapper
@@ -68,6 +69,9 @@ func Parse(in io.Reader) ([]*types.Wrapper, error) {
 				continue
 			}
 
+			// Warn if there are unknown fields
+			stripWrapperAndMaybeWarn(warnDec, &w, count)
+
 			resources = append(resources, &w)
 			count++
 		}
@@ -79,6 +83,28 @@ func Parse(in io.Reader) ([]*types.Wrapper, error) {
 	return resources, err
 }
 
+// warn if there are any unknown fields in the resource. ignores errors because
+// they would be caught by the other decoder.
+func stripWrapperAndMaybeWarn(dec *json.Decoder, wrapper *types.Wrapper, count int) {
+	envelope := map[string]*json.RawMessage{}
+	if err := dec.Decode(&envelope); err != nil {
+		return
+	}
+	msg := envelope["spec"]
+	if msg == nil {
+		return
+	}
+	resource, err := types.ResolveRaw(wrapper.APIVersion, wrapper.Type)
+	if err != nil {
+		return
+	}
+	dec = json.NewDecoder(bytes.NewReader(*msg))
+	dec.DisallowUnknownFields()
+	if err := dec.Decode(&resource); err != nil {
+		describeError(count, fmt.Errorf("warning: %s", err))
+	}
+}
+
 // splitResources scans the content of the reader and splits the resources.
 // The resources should be separated by a line containing only "---".
 // An error will be returned if the data from the reader cannot be read.

types/wrapper.go

@@ -167,7 +167,6 @@ func (w *Wrapper) UnmarshalJSON(b []byte) error {
 		return fmt.Errorf("no spec provided")
 	}
 	dec := json.NewDecoder(bytes.NewReader(*wrapper.Value))
-	dec.DisallowUnknownFields()
 	if err := dec.Decode(&resource); err != nil {
 		return err
 	}