ntp/responder/checker/simplechecker.go

/*
Copyright (c) Facebook, Inc. and its affiliates.

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 checker implements checking mechanism of server aliveness.
It is used by server to determine if internal health if good and work can be continued
*/
package checker

import (
	"errors"
	"sync"

	log "github.com/sirupsen/logrus"
)

var (
	errSimpleCheckerWrongAmountListeners = errors.New("wrong amount of listeners is up")
	errSimpleCheckerWrongAmountWorkers   = errors.New("wrong amount of workers is up")
)

// SimpleChecker is an implementation of checker containing basic health info such as
// amount of workers and listeners
type SimpleChecker struct {
	// ExpectedListeners is number of listeners we expect to run
	ExpectedListeners int64
	realListeners     int64

	// ExpectedWorkers is number of workers we expect to run
	ExpectedWorkers int64
	realWorkers     int64

	sync.Mutex
}

// IncListeners thread-safely increases number of workers to monitor
func (s *SimpleChecker) IncListeners() {
	s.Lock()
	s.realListeners++
	s.Unlock()
}

// DecListeners thread-safely increases number of workers to monitor
func (s *SimpleChecker) DecListeners() {
	s.Lock()
	s.realListeners--
	s.Unlock()
}

// IncWorkers thread-safely increases number of workers to monitor
func (s *SimpleChecker) IncWorkers() {
	s.Lock()
	s.realWorkers++
	s.Unlock()
}

// DecWorkers thread-safely increases number of workers to monitor
func (s *SimpleChecker) DecWorkers() {
	s.Lock()
	s.realWorkers--
	s.Unlock()
}

// Check is a method which performs basic validations that responder is alive
func (s *SimpleChecker) Check() error {
	var err error
	err = s.checkListeners()
	if err != nil {
		return err
	}

	err = s.checkWorkers()
	if err != nil {
		return err
	}

	return nil
}

// CheckListeners if all ExpectedListeners are alive
func (s *SimpleChecker) checkListeners() error {
	s.Lock()
	defer s.Unlock()
	log.Debug("[Checker] checking listeners")
	if s.ExpectedListeners != s.realListeners {
		return errSimpleCheckerWrongAmountListeners
	}
	return nil
}

// CheckWorkers if all ExpectedListeners are alive
func (s *SimpleChecker) checkWorkers() error {
	s.Lock()
	defer s.Unlock()
	log.Debug("[Checker] checking workers")
	if s.ExpectedWorkers != s.realWorkers {
		return errSimpleCheckerWrongAmountWorkers
	}
	return nil
}