processor.go

/*
Copyright 2020 The Knative Authors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package statforwarder

import (
	"sync"
	"time"

	gorillawebsocket "github.com/gorilla/websocket"
	"go.uber.org/zap"

	"knative.dev/pkg/logging/logkey"
	"knative.dev/pkg/websocket"
	asmetrics "knative.dev/serving/pkg/autoscaler/metrics"
)

// The timeout value for a Websocket connection to be established. If a connection via IP
// address can not be established within this value, we assume the Pods can not be
// accessed by IP address directly due to the network mesh.
const establishTimeout = 500 * time.Millisecond

type bucketProcessor interface {
	process(asmetrics.StatMessage) error

	// is returns whether the current processor *is* the specified holder.
	is(holder string) bool

	shutdown()
}

// localProcessor implements bucketProcessor for an owned bucket.
type localProcessor struct {
	logger *zap.SugaredLogger
	// The name of the bucket
	bkt    string
	holder string
	// `accept` is the function to process a StatMessage which doesn't need
	// to be forwarded.
	accept statProcessor
}

var _ bucketProcessor = (*localProcessor)(nil)

func (p *localProcessor) is(holder string) bool {
	return p.holder == holder
}

func (p *localProcessor) process(sm asmetrics.StatMessage) error {
	l := p.logger.With(zap.String(logkey.Key, sm.Key.String()))
	l.Debug("Accept stat as owner of bucket ", p.bkt)
	p.accept(sm)
	return nil
}

func (p *localProcessor) shutdown() {}

// remoteProcessor implements bucketProcessor for an unowned bucket.
type remoteProcessor struct {
	logger *zap.SugaredLogger
	// The name of the bucket
	bkt string
	// holder is the HolderIdentity of a Lease for a bucket.
	holder string

	// addrs contains the list of addresses for the remote to try in the order to try them.
	// The first address to establish a successful connection will be used until things reset
	// at which point the order is re-evaluated.
	addrs []string

	connLock sync.RWMutex
	// conn is the WebSocket connection to the holder pod.
	conn *websocket.ManagedConnection
}

var _ bucketProcessor = (*remoteProcessor)(nil)

func newForwardProcessor(logger *zap.SugaredLogger, bkt, holder string, addrs ...string) *remoteProcessor {
	return &remoteProcessor{
		logger: logger,
		bkt:    bkt,
		holder: holder,
		addrs:  addrs,
	}
}

func (p *remoteProcessor) is(holder string) bool {
	return p.holder == holder
}

func (p *remoteProcessor) getConn() *websocket.ManagedConnection {
	p.connLock.RLock()
	defer p.connLock.RUnlock()
	return p.conn
}

func (p *remoteProcessor) setConn(conn *websocket.ManagedConnection) {
	p.connLock.Lock()
	defer p.connLock.Unlock()
	p.conn = conn
}

func (p *remoteProcessor) process(sm asmetrics.StatMessage) error {
	l := p.logger.With(zap.String(logkey.Key, sm.Key.String()))

	l.Debugf("Forward stat of bucket %s to the holder %s", p.bkt, p.holder)
	wsms := asmetrics.ToWireStatMessages([]asmetrics.StatMessage{sm})
	b, err := wsms.Marshal()
	if err != nil {
		return err
	}

	c := p.getConn()
	if c == nil {
		for _, addr := range p.addrs {
			c, err = websocket.NewDurableSendingConnectionGuaranteed(addr, establishTimeout, p.logger)
			if err != nil {
				continue
			}
			p.setConn(c)
			break
		}
		if err != nil {
			return err
		}
	}

	return c.SendRaw(gorillawebsocket.BinaryMessage, b)
}

func (p *remoteProcessor) shutdown() {
	if c := p.getConn(); c != nil {
		c.Shutdown()
	}
}