ziti/controller/network/circuit_lifecycle.go

/*
	Copyright NetFoundry Inc.

	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

	https://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 network

import (
	"time"

	"github.com/openziti/ziti/v2/controller/event"
	"github.com/openziti/ziti/v2/controller/model"
	"github.com/openziti/ziti/v2/controller/xt"
	"github.com/pkg/errors"
)

func (network *Network) fillCircuitPath(e *event.CircuitEvent, path *model.Path) {
	if path == nil {
		return
	}
	for _, r := range path.Nodes {
		e.Path.Nodes = append(e.Path.Nodes, r.Id)
	}
	for _, l := range path.Links {
		e.Path.Links = append(e.Path.Links, l.Id)
	}
	e.Path.IngressId = path.IngressId
	e.Path.EgressId = path.EgressId
	e.Path.InitiatorLocalAddr = path.InitiatorLocalAddr
	e.Path.InitiatorRemoteAddr = path.InitiatorRemoteAddr
	e.Path.TerminatorLocalAddr = path.TerminatorLocalAddr
	e.Path.TerminatorRemoteAddr = path.TerminatorRemoteAddr
	e.LinkCount = len(path.Links)
}

func (network *Network) CircuitEvent(eventType event.CircuitEventType, circuit *model.Circuit, creationTimespan *time.Duration) {
	var cost *uint32
	var duration *time.Duration
	if eventType == event.CircuitCreated {
		c := circuit.Terminator.GetRouteCost()
		cost = &c
	} else {
		circuitDuration := time.Since(circuit.CreatedAt)
		duration = &circuitDuration
	}

	circuitEvent := &event.CircuitEvent{
		Namespace:        event.CircuitEventNS,
		Version:          event.CircuitEventsVersion,
		EventType:        eventType,
		EventSrcId:       network.GetAppId(),
		CircuitId:        circuit.Id,
		Timestamp:        time.Now(),
		ClientId:         circuit.ClientId,
		ServiceId:        circuit.ServiceId,
		TerminatorId:     circuit.Terminator.GetId(),
		InstanceId:       circuit.Terminator.GetInstanceId(),
		CreationTimespan: creationTimespan,
		Cost:             cost,
		Duration:         duration,
		Tags:             circuit.Tags,
	}

	network.fillCircuitPath(circuitEvent, circuit.Path)
	network.eventDispatcher.AcceptCircuitEvent(circuitEvent)
}

type CircuitFailureCause string

const (
	CircuitFailureInvalidService                   CircuitFailureCause = "INVALID_SERVICE"
	CircuitFailureIdGenerationError                CircuitFailureCause = "ID_GENERATION_ERR"
	CircuitFailureNoTerminators                    CircuitFailureCause = "NO_TERMINATORS"
	CircuitFailureNoOnlineTerminators              CircuitFailureCause = "NO_ONLINE_TERMINATORS"
	CircuitFailureNoPath                           CircuitFailureCause = "NO_PATH"
	CircuitFailurePathMissingLink                  CircuitFailureCause = "PATH_MISSING_LINK"
	CircuitFailureInvalidStrategy                  CircuitFailureCause = "INVALID_STRATEGY"
	CircuitFailureStrategyError                    CircuitFailureCause = "STRATEGY_ERR"
	CircuitFailureRouterResponseTimeout            CircuitFailureCause = "ROUTER_RESPONSE_TIMEOUT"
	CircuitFailureRouterErrGeneric                 CircuitFailureCause = "ROUTER_ERR_GENERIC"
	CircuitFailureRouterErrInvalidTerminator       CircuitFailureCause = "ROUTER_ERR_INVALID_TERMINATOR"
	CircuitFailureRouterErrMisconfiguredTerminator CircuitFailureCause = "ROUTER_ERR_MISCONFIGURED_TERMINATOR"
	CircuitFailureRouterErrDialTimedOut            CircuitFailureCause = "ROUTER_ERR_DIAL_TIMED_OUT"
	CircuitFailureRouterErrDialConnRefused         CircuitFailureCause = "ROUTER_ERR_CONN_REFUSED"
	CircuitFailureRouterErrRejectedByApp           CircuitFailureCause = "ROUTER_ERR_REJECTED_BY_APPLICATION"
	CircuitFailureRouterErrDnsResolutionFailed     CircuitFailureCause = "ROUTER_ERR_DNS_RESOLUTION_FAILED"
	CircuitFailureRouterErrPortNotAllowed          CircuitFailureCause = "ROUTER_ERR_PORT_NOT_ALLOWED"
	CircuitFailureRouterErrInvalidLinkDest         CircuitFailureCause = "ROUTER_ERR_INVALID_LINK_DESTINATION"
	CircuitFailureRouterErrResourcesNotAvailable   CircuitFailureCause = "ROUTER_ERR_RESOURCES_NOT_AVAILABLE"
)

type CircuitError interface {
	error
	Cause() CircuitFailureCause
}

type circuitError struct {
	error
	CircuitFailureCause
}

func (self *circuitError) Cause() CircuitFailureCause {
	return self.CircuitFailureCause
}

func (self *circuitError) Unwrap() error {
	return self.error
}

func newCircuitErrorf(cause CircuitFailureCause, t string, args ...any) CircuitError {
	return &circuitError{
		error:               errors.Errorf(t, args...),
		CircuitFailureCause: cause,
	}
}

func newCircuitErrWrap(cause CircuitFailureCause, err error) CircuitError {
	return &circuitError{
		error:               err,
		CircuitFailureCause: cause,
	}
}

func (network *Network) CircuitFailedEvent(
	circuitId string,
	params model.CreateCircuitParams,
	startTime time.Time,
	path *model.Path,
	t xt.CostedTerminator,
	cause CircuitFailureCause) {
	var failureCause *string
	if strCause := string(cause); strCause != "" {
		failureCause = &strCause
	}

	var cost *uint32
	if t != nil {
		c := t.GetRouteCost()
		cost = &c
	}

	var terminatorId string
	if t != nil {
		terminatorId = t.GetId()
	}

	instanceId, serviceId := parseInstanceIdAndService(params.GetServiceId())

	// get circuit tags
	tags := params.GetCircuitTags(t)

	elapsed := time.Since(startTime)
	circuitEvent := &event.CircuitEvent{
		Namespace:        event.CircuitEventNS,
		Version:          event.CircuitEventsVersion,
		EventType:        event.CircuitFailed,
		EventSrcId:       network.GetAppId(),
		CircuitId:        circuitId,
		Timestamp:        time.Now(),
		ClientId:         params.GetClientId().Token,
		ServiceId:        serviceId,
		TerminatorId:     terminatorId,
		InstanceId:       instanceId,
		CreationTimespan: &elapsed,
		Cost:             cost,
		FailureCause:     failureCause,
		Tags:             tags,
	}
	network.fillCircuitPath(circuitEvent, path)
	network.eventDispatcher.AcceptCircuitEvent(circuitEvent)
}