e3caa90c31
refact imports to github.xxx. update go.mod + go.sum * removed vendor/ folder * Added vendor/ submodule. Moved dependencies that need to be vendored into separate repository. - https://github.com/spdfg/elektron-vendor Added vendor/ as a submodule using the below command. - git submodule add https://github.com/spdfg/elektron-vendor vendor If wanting to use vendor, run the following commands after cloning elektron. 1. git submodule init 2. git submodule update * added instructions to clone vendor/ submodule. * updated module to spdfg. Refactored imports
442 lines
14 KiB
Go
442 lines
14 KiB
Go
// Copyright (C) 2018 spdfg
|
|
//
|
|
// This file is part of Elektron.
|
|
//
|
|
// Elektron is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// Elektron is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with Elektron. If not, see <http://www.gnu.org/licenses/>.
|
|
//
|
|
|
|
package schedulers
|
|
|
|
import (
|
|
"bytes"
|
|
"fmt"
|
|
"log"
|
|
"sync"
|
|
"time"
|
|
|
|
"github.com/golang/protobuf/proto"
|
|
mesos "github.com/mesos/mesos-go/api/v0/mesosproto"
|
|
"github.com/mesos/mesos-go/api/v0/mesosutil"
|
|
sched "github.com/mesos/mesos-go/api/v0/scheduler"
|
|
"github.com/spdfg/elektron/def"
|
|
elekLogDef "github.com/spdfg/elektron/logging/def"
|
|
"github.com/spdfg/elektron/utilities"
|
|
"github.com/spdfg/elektron/utilities/schedUtils"
|
|
)
|
|
|
|
type BaseScheduler struct {
|
|
ElectronScheduler
|
|
SchedPolicyContext
|
|
// Current scheduling policy used for resource offer consumption.
|
|
curSchedPolicy SchedPolicyState
|
|
|
|
tasksCreated int
|
|
tasksRunning int
|
|
tasks []def.Task
|
|
metrics map[string]def.Metric
|
|
Running map[string]map[string]bool
|
|
wattsAsAResource bool
|
|
classMapWatts bool
|
|
TasksRunningMutex sync.Mutex
|
|
HostNameToSlaveID map[string]string
|
|
totalResourceAvailabilityRecorded bool
|
|
|
|
// First set of PCP values are garbage values, signal to logger to start recording when we're
|
|
// about to schedule a new task
|
|
RecordPCP *bool
|
|
|
|
// This channel is closed when the program receives an interrupt,
|
|
// signalling that the program should shut down.
|
|
Shutdown chan struct{}
|
|
// This channel is closed after shutdown is closed, and only when all
|
|
// outstanding tasks have been cleaned up.
|
|
Done chan struct{}
|
|
|
|
// Controls when to shutdown pcp logging.
|
|
PCPLog chan struct{}
|
|
|
|
schedTrace *log.Logger
|
|
|
|
// Send the type of the message to be logged
|
|
logMsgType chan elekLogDef.LogMessageType
|
|
// Send the message to be logged
|
|
logMsg chan string
|
|
|
|
mutex sync.Mutex
|
|
|
|
// Whether switching of scheduling policies at runtime has been enabled
|
|
schedPolSwitchEnabled bool
|
|
// Name of the first scheduling policy to be deployed, if provided.
|
|
// This scheduling policy would be deployed first regardless of the distribution of tasks in the TaskQueue.
|
|
// Note: Scheduling policy switching needs to be enabled.
|
|
nameOfFstSchedPolToDeploy string
|
|
// Scheduling policy switching criteria.
|
|
schedPolSwitchCriteria string
|
|
|
|
// Size of window of tasks that can be scheduled in the next offer cycle.
|
|
// The window size can be adjusted to make the most use of every resource offer.
|
|
// By default, the schedWindowSize would correspond to the number of remaining tasks that haven't yet
|
|
// been scheduled.
|
|
schedWindowSize int
|
|
// Number of tasks in the window
|
|
numTasksInSchedWindow int
|
|
|
|
// Whether the scheduling window needs to be fixed.
|
|
toFixSchedWindow bool // If yes, then schedWindowSize is initialized and kept unchanged.
|
|
|
|
// Strategy to resize the schedulingWindow.
|
|
schedWindowResStrategy schedUtils.SchedWindowResizingStrategy
|
|
|
|
// Indicate whether the any resource offers from mesos have been received.
|
|
hasReceivedResourceOffers bool
|
|
}
|
|
|
|
func (s *BaseScheduler) init(opts ...SchedulerOptions) {
|
|
for _, opt := range opts {
|
|
// applying options
|
|
if err := opt(s); err != nil {
|
|
log.Fatal(err)
|
|
}
|
|
}
|
|
s.TasksRunningMutex.Lock()
|
|
s.Running = make(map[string]map[string]bool)
|
|
s.TasksRunningMutex.Unlock()
|
|
s.HostNameToSlaveID = make(map[string]string)
|
|
s.mutex = sync.Mutex{}
|
|
s.schedWindowResStrategy = schedUtils.SchedWindowResizingCritToStrategy["fillNextOfferCycle"]
|
|
// Initially no resource offers would have been received.
|
|
s.hasReceivedResourceOffers = false
|
|
}
|
|
|
|
func (s *BaseScheduler) SwitchSchedPol(newSchedPol SchedPolicyState) {
|
|
s.curSchedPolicy = newSchedPol
|
|
}
|
|
|
|
func (s *BaseScheduler) newTask(offer *mesos.Offer, task def.Task) *mesos.TaskInfo {
|
|
taskName := fmt.Sprintf("%s-%d", task.Name, *task.Instances)
|
|
s.tasksCreated++
|
|
|
|
if !*s.RecordPCP {
|
|
// Turn on elecLogDef
|
|
*s.RecordPCP = true
|
|
time.Sleep(1 * time.Second) // Make sure we're recording by the time the first task starts
|
|
}
|
|
|
|
resources := []*mesos.Resource{
|
|
mesosutil.NewScalarResource("cpus", task.CPU),
|
|
mesosutil.NewScalarResource("mem", task.RAM),
|
|
}
|
|
|
|
if s.wattsAsAResource {
|
|
if wattsToConsider, err := def.WattsToConsider(task, s.classMapWatts, offer); err == nil {
|
|
s.LogTaskWattsConsideration(task, *offer.Hostname, wattsToConsider)
|
|
resources = append(resources, mesosutil.NewScalarResource("watts", wattsToConsider))
|
|
} else {
|
|
// Error in determining wattsConsideration
|
|
s.LogElectronError(err)
|
|
}
|
|
}
|
|
|
|
return &mesos.TaskInfo{
|
|
Name: proto.String(taskName),
|
|
TaskId: &mesos.TaskID{
|
|
Value: proto.String("electron-" + taskName),
|
|
},
|
|
SlaveId: offer.SlaveId,
|
|
Resources: resources,
|
|
Command: &mesos.CommandInfo{
|
|
Value: proto.String(task.CMD),
|
|
},
|
|
Container: &mesos.ContainerInfo{
|
|
Type: mesos.ContainerInfo_DOCKER.Enum(),
|
|
Docker: &mesos.ContainerInfo_DockerInfo{
|
|
Image: proto.String(task.Image),
|
|
Network: mesos.ContainerInfo_DockerInfo_BRIDGE.Enum(), // Run everything isolated
|
|
},
|
|
},
|
|
}
|
|
}
|
|
|
|
func (s *BaseScheduler) OfferRescinded(_ sched.SchedulerDriver, offerID *mesos.OfferID) {
|
|
s.LogOfferRescinded(offerID)
|
|
}
|
|
func (s *BaseScheduler) SlaveLost(_ sched.SchedulerDriver, slaveID *mesos.SlaveID) {
|
|
s.LogSlaveLost(slaveID)
|
|
}
|
|
func (s *BaseScheduler) ExecutorLost(_ sched.SchedulerDriver, executorID *mesos.ExecutorID,
|
|
slaveID *mesos.SlaveID, status int) {
|
|
s.LogExecutorLost(executorID, slaveID)
|
|
}
|
|
|
|
func (s *BaseScheduler) Error(_ sched.SchedulerDriver, err string) {
|
|
s.LogMesosError(err)
|
|
}
|
|
|
|
func (s *BaseScheduler) FrameworkMessage(
|
|
driver sched.SchedulerDriver,
|
|
executorID *mesos.ExecutorID,
|
|
slaveID *mesos.SlaveID,
|
|
message string) {
|
|
s.LogFrameworkMessage(executorID, slaveID, message)
|
|
}
|
|
|
|
func (s *BaseScheduler) Registered(
|
|
_ sched.SchedulerDriver,
|
|
frameworkID *mesos.FrameworkID,
|
|
masterInfo *mesos.MasterInfo) {
|
|
s.LogFrameworkRegistered(frameworkID, masterInfo)
|
|
}
|
|
|
|
func (s *BaseScheduler) Reregistered(_ sched.SchedulerDriver, masterInfo *mesos.MasterInfo) {
|
|
s.LogFrameworkReregistered(masterInfo)
|
|
}
|
|
|
|
func (s *BaseScheduler) Disconnected(sched.SchedulerDriver) {
|
|
s.LogDisconnected()
|
|
}
|
|
|
|
func (s *BaseScheduler) ResourceOffers(driver sched.SchedulerDriver, offers []*mesos.Offer) {
|
|
// Recording the total amount of resources available across the cluster.
|
|
utilities.RecordTotalResourceAvailability(offers)
|
|
for _, offer := range offers {
|
|
if _, ok := s.HostNameToSlaveID[offer.GetHostname()]; !ok {
|
|
s.HostNameToSlaveID[offer.GetHostname()] = *offer.SlaveId.Value
|
|
}
|
|
}
|
|
// Switch just before consuming the resource offers.
|
|
s.curSchedPolicy.SwitchIfNecessary(s)
|
|
// s.Log(elecLogDef.GENERAL, fmt.Sprintf("SchedWindowSize[%d], #TasksInWindow[%d]",
|
|
// s.schedWindowSize, s.numTasksInSchedWindow))
|
|
s.curSchedPolicy.ConsumeOffers(s, driver, offers)
|
|
s.hasReceivedResourceOffers = true
|
|
}
|
|
|
|
func (s *BaseScheduler) StatusUpdate(driver sched.SchedulerDriver, status *mesos.TaskStatus) {
|
|
s.LogTaskStatusUpdate(status)
|
|
if *status.State == mesos.TaskState_TASK_RUNNING {
|
|
// If this is our first time running into this Agent
|
|
s.TasksRunningMutex.Lock()
|
|
if _, ok := s.Running[*status.SlaveId.Value]; !ok {
|
|
s.Running[*status.SlaveId.Value] = make(map[string]bool)
|
|
}
|
|
// Add task to list of tasks running on node
|
|
s.Running[*status.SlaveId.Value][*status.TaskId.Value] = true
|
|
s.tasksRunning++
|
|
s.TasksRunningMutex.Unlock()
|
|
} else if IsTerminal(status.State) {
|
|
// Update resource availability.
|
|
utilities.ResourceAvailabilityUpdate("ON_TASK_TERMINAL_STATE",
|
|
*status.TaskId, *status.SlaveId)
|
|
s.TasksRunningMutex.Lock()
|
|
delete(s.Running[*status.SlaveId.Value], *status.TaskId.Value)
|
|
s.tasksRunning--
|
|
s.TasksRunningMutex.Unlock()
|
|
if s.tasksRunning == 0 {
|
|
select {
|
|
case <-s.Shutdown:
|
|
close(s.Done)
|
|
default:
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
func (s *BaseScheduler) Log(lmt elekLogDef.LogMessageType, msg string) {
|
|
s.mutex.Lock()
|
|
s.logMsgType <- lmt
|
|
s.logMsg <- msg
|
|
s.mutex.Unlock()
|
|
}
|
|
|
|
func (s *BaseScheduler) LogTaskStarting(ts *def.Task, offer *mesos.Offer) {
|
|
lmt := elekLogDef.GENERAL
|
|
msgColor := elekLogDef.LogMessageColors[lmt]
|
|
var msg string
|
|
if ts == nil {
|
|
msg = msgColor.Sprintf("TASKS STARTING... host = [%s]", offer.GetHostname())
|
|
} else {
|
|
msg = msgColor.Sprintf("TASK STARTING... task = [%s], Instance = %d, host = [%s]",
|
|
ts.Name, *ts.Instances, offer.GetHostname())
|
|
}
|
|
s.Log(lmt, msg)
|
|
}
|
|
|
|
func (s *BaseScheduler) LogTaskWattsConsideration(ts def.Task, host string, wattsToConsider float64) {
|
|
lmt := elekLogDef.GENERAL
|
|
msgColor := elekLogDef.LogMessageColors[lmt]
|
|
msg := msgColor.Sprintf("Watts considered for task[%s] and host[%s] = %f Watts",
|
|
ts.Name, host, wattsToConsider)
|
|
s.Log(lmt, msg)
|
|
}
|
|
|
|
func (s *BaseScheduler) LogOffersReceived(offers []*mesos.Offer) {
|
|
lmt := elekLogDef.GENERAL
|
|
msgColor := elekLogDef.LogMessageColors[lmt]
|
|
msg := msgColor.Sprintf("Received %d resource offers", len(offers))
|
|
s.Log(lmt, msg)
|
|
}
|
|
|
|
func (s *BaseScheduler) LogNoPendingTasksDeclineOffers(offer *mesos.Offer) {
|
|
lmt := elekLogDef.WARNING
|
|
msgColor := elekLogDef.LogMessageColors[lmt]
|
|
msg := msgColor.Sprintf("DECLINING OFFER for host[%s]... "+
|
|
"No tasks left to schedule", offer.GetHostname())
|
|
s.Log(lmt, msg)
|
|
}
|
|
|
|
func (s *BaseScheduler) LogNumberOfRunningTasks() {
|
|
lmt := elekLogDef.GENERAL
|
|
msgColor := elekLogDef.LogMessageColors[lmt]
|
|
msg := msgColor.Sprintf("Number of tasks still Running = %d", s.tasksRunning)
|
|
s.Log(lmt, msg)
|
|
}
|
|
|
|
func (s *BaseScheduler) LogCoLocatedTasks(slaveID string) {
|
|
lmt := elekLogDef.GENERAL
|
|
msgColor := elekLogDef.LogMessageColors[lmt]
|
|
buffer := bytes.Buffer{}
|
|
buffer.WriteString(fmt.Sprintln("Colocated with:"))
|
|
s.TasksRunningMutex.Lock()
|
|
for taskName := range s.Running[slaveID] {
|
|
buffer.WriteString(fmt.Sprintln(taskName))
|
|
}
|
|
s.TasksRunningMutex.Unlock()
|
|
msg := msgColor.Sprintf(buffer.String())
|
|
s.Log(lmt, msg)
|
|
}
|
|
|
|
func (s *BaseScheduler) LogSchedTrace(taskToSchedule *mesos.TaskInfo, offer *mesos.Offer) {
|
|
msg := fmt.Sprint(offer.GetHostname() + ":" + taskToSchedule.GetTaskId().GetValue())
|
|
s.Log(elekLogDef.SCHED_TRACE, msg)
|
|
}
|
|
|
|
func (s *BaseScheduler) LogTerminateScheduler() {
|
|
lmt := elekLogDef.GENERAL
|
|
msgColor := elekLogDef.LogMessageColors[lmt]
|
|
msg := msgColor.Sprint("Done scheduling all tasks!")
|
|
s.Log(lmt, msg)
|
|
}
|
|
|
|
func (s *BaseScheduler) LogInsufficientResourcesDeclineOffer(offer *mesos.Offer,
|
|
offerResources ...interface{}) {
|
|
lmt := elekLogDef.WARNING
|
|
msgColor := elekLogDef.LogMessageColors[lmt]
|
|
buffer := bytes.Buffer{}
|
|
buffer.WriteString(fmt.Sprintln("DECLINING OFFER... Offer has insufficient resources to launch a task"))
|
|
buffer.WriteString(fmt.Sprintf("Offer Resources <CPU: %f, RAM: %f, Watts: %f>", offerResources...))
|
|
msg := msgColor.Sprint(buffer.String())
|
|
s.Log(lmt, msg)
|
|
}
|
|
|
|
func (s *BaseScheduler) LogOfferRescinded(offerID *mesos.OfferID) {
|
|
lmt := elekLogDef.ERROR
|
|
msgColor := elekLogDef.LogMessageColors[lmt]
|
|
msg := msgColor.Sprintf("OFFER RESCINDED: OfferID = %s", offerID)
|
|
s.Log(lmt, msg)
|
|
}
|
|
|
|
func (s *BaseScheduler) LogSlaveLost(slaveID *mesos.SlaveID) {
|
|
lmt := elekLogDef.ERROR
|
|
msgColor := elekLogDef.LogMessageColors[lmt]
|
|
msg := msgColor.Sprintf("SLAVE LOST: SlaveID = %s", slaveID)
|
|
s.Log(lmt, msg)
|
|
}
|
|
|
|
func (s *BaseScheduler) LogExecutorLost(executorID *mesos.ExecutorID, slaveID *mesos.SlaveID) {
|
|
lmt := elekLogDef.ERROR
|
|
msgColor := elekLogDef.LogMessageColors[lmt]
|
|
msg := msgColor.Sprintf("EXECUTOR LOST: ExecutorID = %s, SlaveID = %s", executorID, slaveID)
|
|
s.Log(lmt, msg)
|
|
}
|
|
|
|
func (s *BaseScheduler) LogFrameworkMessage(executorID *mesos.ExecutorID,
|
|
slaveID *mesos.SlaveID, message string) {
|
|
lmt := elekLogDef.GENERAL
|
|
msgColor := elekLogDef.LogMessageColors[lmt]
|
|
msg := msgColor.Sprintf("Received Framework message from executor [%s]: %s", executorID, message)
|
|
s.Log(lmt, msg)
|
|
}
|
|
|
|
func (s *BaseScheduler) LogMesosError(err string) {
|
|
lmt := elekLogDef.ERROR
|
|
msgColor := elekLogDef.LogMessageColors[lmt]
|
|
msg := msgColor.Sprintf("MESOS ERROR: %s", err)
|
|
s.Log(lmt, msg)
|
|
}
|
|
|
|
func (s *BaseScheduler) LogElectronError(err error) {
|
|
lmt := elekLogDef.ERROR
|
|
msgColor := elekLogDef.LogMessageColors[lmt]
|
|
msg := msgColor.Sprintf("ELECTRON ERROR: %v", err)
|
|
s.Log(lmt, msg)
|
|
}
|
|
|
|
func (s *BaseScheduler) LogFrameworkRegistered(frameworkID *mesos.FrameworkID,
|
|
masterInfo *mesos.MasterInfo) {
|
|
lmt := elekLogDef.SUCCESS
|
|
msgColor := elekLogDef.LogMessageColors[lmt]
|
|
msg := msgColor.Sprintf("FRAMEWORK REGISTERED! frameworkID = %s, master = %s",
|
|
frameworkID, masterInfo)
|
|
s.Log(lmt, msg)
|
|
}
|
|
|
|
func (s *BaseScheduler) LogFrameworkReregistered(masterInfo *mesos.MasterInfo) {
|
|
lmt := elekLogDef.GENERAL
|
|
msgColor := elekLogDef.LogMessageColors[lmt]
|
|
msg := msgColor.Sprintf("Framework re-registered with master %s", masterInfo)
|
|
s.Log(lmt, msg)
|
|
}
|
|
|
|
func (s *BaseScheduler) LogDisconnected() {
|
|
lmt := elekLogDef.WARNING
|
|
msgColor := elekLogDef.LogMessageColors[lmt]
|
|
msg := msgColor.Sprint("Framework disconnected with master")
|
|
s.Log(lmt, msg)
|
|
}
|
|
|
|
func (s *BaseScheduler) LogTaskStatusUpdate(status *mesos.TaskStatus) {
|
|
var lmt elekLogDef.LogMessageType
|
|
switch *status.State {
|
|
case mesos.TaskState_TASK_ERROR, mesos.TaskState_TASK_FAILED,
|
|
mesos.TaskState_TASK_KILLED, mesos.TaskState_TASK_LOST:
|
|
lmt = elekLogDef.ERROR
|
|
case mesos.TaskState_TASK_FINISHED:
|
|
lmt = elekLogDef.SUCCESS
|
|
default:
|
|
lmt = elekLogDef.GENERAL
|
|
}
|
|
msgColor := elekLogDef.LogMessageColors[lmt]
|
|
msg := elekLogDef.LogMessageColors[elekLogDef.GENERAL].Sprintf("Task Status received for task [%s] --> %s",
|
|
*status.TaskId.Value, msgColor.Sprint(NameFor(status.State)))
|
|
s.Log(lmt, msg)
|
|
}
|
|
|
|
func (s *BaseScheduler) LogSchedPolicySwitch(name string, nextPolicy SchedPolicyState) {
|
|
logSPS := func() {
|
|
s.Log(elekLogDef.SPS, name)
|
|
}
|
|
if s.hasReceivedResourceOffers && (s.curSchedPolicy != nextPolicy) {
|
|
logSPS()
|
|
} else if !s.hasReceivedResourceOffers {
|
|
logSPS()
|
|
}
|
|
// Logging the size of the scheduling window and the scheduling policy
|
|
// that is going to schedule the tasks in the scheduling window.
|
|
s.Log(elekLogDef.SCHED_WINDOW, fmt.Sprintf("%d %s", s.schedWindowSize, name))
|
|
}
|
|
|
|
func (s *BaseScheduler) LogClsfnAndTaskDistOverhead(overhead time.Duration) {
|
|
// Logging the overhead in microseconds.
|
|
s.Log(elekLogDef.CLSFN_TASKDIST_OVERHEAD, fmt.Sprintf("%f", float64(overhead.Nanoseconds())/1000.0))
|
|
}
|