stats.go

// mgo - MongoDB driver for Go
//
// Copyright (c) 2010-2012 - Gustavo Niemeyer <gustavo@niemeyer.net>
//
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this
//    list of conditions and the following disclaimer.
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation
//    and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
// ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
// ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package mgo

import (
	"sync"
	"time"
)

var stats *Stats
var statsMutex sync.Mutex

// SetStats enable database state monitoring
func SetStats(enabled bool) {
	statsMutex.Lock()
	if enabled {
		if stats == nil {
			stats = &Stats{}
		}
	} else {
		stats = nil
	}
	statsMutex.Unlock()
}

// GetStats return the current database state
func GetStats() (snapshot Stats) {
	statsMutex.Lock()
	snapshot = *stats
	statsMutex.Unlock()
	return
}

// ResetStats reset Stats to the previous database state
func ResetStats() {
	statsMutex.Lock()
	debug("Resetting stats")
	old := stats
	stats = &Stats{}
	// These are absolute values:
	stats.Clusters = old.Clusters
	stats.SocketsInUse = old.SocketsInUse
	stats.SocketsAlive = old.SocketsAlive
	stats.SocketRefs = old.SocketRefs
	statsMutex.Unlock()
	return
}

// Stats holds info on the database state
//
// Relevant documentation:
//
//    https://docs.mongodb.com/manual/reference/command/serverStatus/
//
// TODO outdated fields ?
type Stats struct {
	Clusters            int
	MasterConns         int
	SlaveConns          int
	SentOps             int
	ReceivedOps         int
	ReceivedDocs        int
	ShrunkConns         int
	FailedConns         int
	SocketsAlive        int
	SocketsInUse        int
	SocketRefs          int
	TimesSocketAcquired int
	TimesWaitedForPool  int
	TotalPoolWaitTime   time.Duration
	PoolTimeouts        int

	PoolShrinkers int
	Pingers       int

	ServerCreates    int
	ServerCloses     int
	ServerCloseIdles int

	SocketCreates    int
	SocketCloses     int
	SocketCloseIdles int
}

func (stats *Stats) cluster(delta int) {
	if stats != nil {
		statsMutex.Lock()
		stats.Clusters += delta
		statsMutex.Unlock()
	}
}

func (stats *Stats) conn(delta int, master bool) {
	if stats != nil {
		statsMutex.Lock()
		if master {
			stats.MasterConns += delta
		} else {
			stats.SlaveConns += delta
		}
		statsMutex.Unlock()
	}
}

func (stats *Stats) sentOps(delta int) {
	if stats != nil {
		statsMutex.Lock()
		stats.SentOps += delta
		statsMutex.Unlock()
	}
}

func (stats *Stats) receivedOps(delta int) {
	if stats != nil {
		statsMutex.Lock()
		stats.ReceivedOps += delta
		statsMutex.Unlock()
	}
}

func (stats *Stats) receivedDocs(delta int) {
	if stats != nil {
		statsMutex.Lock()
		stats.ReceivedDocs += delta
		statsMutex.Unlock()
	}
}

func (stats *Stats) socketsInUse(delta int) {
	if stats != nil {
		statsMutex.Lock()
		stats.SocketsInUse += delta
		statsMutex.Unlock()
	}
}

func (stats *Stats) socketsAlive(delta int) {
	if stats != nil {
		statsMutex.Lock()
		stats.SocketsAlive += delta
		statsMutex.Unlock()
	}
}

func (stats *Stats) socketRefs(delta int) {
	if stats != nil {
		statsMutex.Lock()
		stats.SocketRefs += delta
		statsMutex.Unlock()
	}
}

func (stats *Stats) shrunkConn(delta int) {
	if stats != nil {
		statsMutex.Lock()
		stats.ShrunkConns += delta
		statsMutex.Unlock()
	}
}

func (stats *Stats) failedConn(delta int) {
	if stats != nil {
		statsMutex.Lock()
		stats.FailedConns += delta
		statsMutex.Unlock()
	}
}

func (stats *Stats) noticeSocketAcquisition(waitTime time.Duration) {
	if stats != nil {
		statsMutex.Lock()
		stats.TimesSocketAcquired++
		stats.TotalPoolWaitTime += waitTime
		if waitTime > 0 {
			stats.TimesWaitedForPool++
		}
		statsMutex.Unlock()
	}
}

func (stats *Stats) noticePoolTimeout(waitTime time.Duration) {
	if stats != nil {
		statsMutex.Lock()
		stats.TimesWaitedForPool++
		stats.PoolTimeouts++
		stats.TotalPoolWaitTime += waitTime
		statsMutex.Unlock()
	}
}

func (stats *Stats) ServerCreated() {
	if stats == nil {
		return
	}
	statsMutex.Lock()
	stats.ServerCreates += 1
	statsMutex.Unlock()
}

func (stats *Stats) ServerClosed() {
	if stats == nil {
		return
	}
	statsMutex.Lock()
	stats.ServerCloses += 1
	statsMutex.Unlock()
}

func (stats *Stats) ServerClosedIdle() {
	if stats == nil {
		return
	}
	statsMutex.Lock()
	stats.ServerCloseIdles += 1
	statsMutex.Unlock()
}

func (stats *Stats) SocketCreated() {
	if stats == nil {
		return
	}
	statsMutex.Lock()
	stats.SocketCreates += 1
	statsMutex.Unlock()
}

func (stats *Stats) SocketClosed() {
	if stats == nil {
		return
	}
	statsMutex.Lock()
	stats.SocketCloses += 1
	statsMutex.Unlock()
}

func (stats *Stats) SocketClosedIdle() {
	if stats == nil {
		return
	}
	statsMutex.Lock()
	stats.SocketCloseIdles += 1
	statsMutex.Unlock()
}

func (stats *Stats) PingerCreated() {
	stats.pinger(1)
}

func (stats *Stats) PingerExited() {
	stats.pinger(-1)
}

func (stats *Stats) pinger(delta int) {
	if stats == nil {
		return
	}
	statsMutex.Lock()
	stats.Pingers += delta
	statsMutex.Unlock()
}

func (stats *Stats) PoolShrinkerCreated() {
	stats.poolshrinker(1)
}

func (stats *Stats) PoolShrinkerExited() {
	stats.poolshrinker(-1)
}

func (stats *Stats) poolshrinker(delta int) {
	if stats == nil {
		return
	}
	statsMutex.Lock()
	stats.PoolShrinkers += delta
	statsMutex.Unlock()
}