Package metrics

{
  "names": [ $(name) ... ]
}

name - A list of custom metrics names to be used.
       Each name must have value update function assigned.

// You must call metrics.Setup() before calling diarkis.Start()
metrics.Setup("/absolute/path/to/my/config/JSON/file")

// You must call metrics.Setup() before calling diarkis.Start()
// You also must call metrics.Setup after calling mesh.Setup(...)
metrics.Setup("/absolute/path/to/my/config/JSON/file")

// Make sure the name used here is configured in the config JSON file: "names": [ "MyCustomMetrics" ]
customMetricsName := "MyCustomMetrics"

// You must call metrics.Setup() before calling diarkis.Start()
// You also must call metrics.Setup after calling mesh.Setup(...)
// The callback function assigned here will be invoked at every mesh package update
metrics.DefineMetricsValue(customMetricsName, func() int {

  // returned value will be your custom metrics value
  return customMetricsValue

})

Constants

GroupMeshVaultName used in group

const GroupMeshVaultName = "g"

GroupVaultName used in group

const GroupVaultName = "Groups"

MatchMakerCompleteCnt used in matching

const MatchMakerCompleteCnt = "mc"

MatchMakerCompleteName used in matching

const MatchMakerCompleteName = "MatchMaker_Complete"

MatchMakerEmptySearchCnt used in matching

const MatchMakerEmptySearchCnt = "me"

MatchMakerEmptySearchname used in matching

const MatchMakerEmptySearchName = "MatchMaker_Empty"

MatchMakerSearchCnt used in matching

const MatchMakerSearchCnt = "ms"

MatchMakerSearchName used in matching

const MatchMakerSearchName = "MatchMaker_Search"

const MatchMakerTicketAddCnt = "mta"

const MatchMakerTicketAddName = "MatchMaker_Ticket_Add"

const MatchMakerTicketCnt = "mt"

const MatchMakerTicketCompleteTimeAvg = "mtt"

const MatchMakerTicketCompleteTimeAvgName = "MatchMaker_Ticket_Complete_Time_Avg"

const MatchMakerTicketCompleteTimeMax = "mtx"

const MatchMakerTicketCompleteTimeMaxName = "MatchMaker_Ticket_Complete_Time_Max"

const MatchMakerTicketCompleteTimeMin = "mtn"

const MatchMakerTicketCompleteTimeMinName = "MatchMaker_Ticket_Complete_Time_Min"

const MatchMakerTicketName = "MatchMaker_Ticket"

const MatchMakerTicketSearchCnt = "mts"

const MatchMakerTicketSearchName = "MatchMaker_Ticket_Search"

MeshPktSampleIn used in mesh

const MeshPktSampleIn = "mi"

MeshPktSampleInName used in mesh

const MeshPktSampleInName = "Mesh_Packets_In"

MeshPktSampleOut used in mesh

const MeshPktSampleOut = "mo"

MeshPktSampleOutName used in mesh

const MeshPktSampleOutName = "Mesh_Packets_Out"

MeshPktSampleRetry used in mesh

const MeshPktSampleRetry = "mr"

MeshPktSampleRetryName used in mesh

const MeshPktSampleRetryName = "Mesh_Retry"

P2PAttemptCnt used in P2P

const P2PAttemptCnt = "pa"

P2PAttemptName used in P2P attempt count report

const P2PAttemptName = "P2P_Attempt"

P2PSuccess used in P2P success count report

const P2PSuccessCnt = "ps"

P2PSuccessName used in P2P success count report

const P2PSuccessName = "P2P_Success"

RoomMeshVaultName used in room

const RoomMeshVaultName = "r"

RoomVaultName used in room

const RoomVaultName = "Rooms"

TCPPktSampleIn used in tcp

const TCPPktSampleIn = "ti"

TCPPktSampleInName used in tcp

const TCPPktSampleInName = "TCP_Packets_In"

TCPPktSampleOut used in tcp

const TCPPktSampleOut = "to"

TCPPktSampleOutName used in tcp

const TCPPktSampleOutName = "TCP_Packets_Out"

UDPCmdSample used in udp

const UDPCmdSample = "um"

UDPCmdSampleName used in udp

const UDPCmdSampleName = "Commands_In"

UDPPktSampleIn used in udp

const UDPPktSampleIn = "ui"

UDPPktSampleInName used in udp

const UDPPktSampleInName = "UDP_Packets_In"

UDPPktSampleOut used in udp

const UDPPktSampleOut = "uo"

UDPPktSampleOutName used in udp

const UDPPktSampleOutName = "UDP_Packets_Out"

UDPRetrySample used in udp

const UDPRetrySample = "ur"

UDPRetrySampleName used in udp

const UDPRetrySampleName = "RUDP_Retries"

UDPSendSample used in udp

const UDPSendSample = "us"

UDPSendSampleName used in udp

const UDPSendSampleName = "Commands_Out"

UDPSplitSampleIn used in udp

const UDPSplitSampleIn = "si"

UDPSplitSampleInName used in udp

const UDPSplitSampleInName = "RUDP_Split_In"

UDPSplitSampleOut used in udp

const UDPSplitSampleOut = "so"

UDPSplitSampleOutName used in udp

const UDPSplitSampleOutName = "RUDP_Split_Out"

MeshVaultName used in user

const UserMeshVaultName = "uc"

VaultName used in user

const UserVaultName = "Users"

WSPktSampleIn

const WSPktSampleIn = "wi"

WSPktSampleInName used in tcp

const WSPktSampleInName = "WS_Packets_In"

WSPktSampleOut

const WSPktSampleOut = "wo"

WSPktSampleOutName used in tcp

const WSPktSampleOutName = "WS_Packets_Out"

func DefineMetricsValue ¶

func DefineMetricsValue(name string, cb ValueUpdate) error

DefineMetricsValue defines the value update operation of the metrics name given.

[IMPORTANT] MUST invoke this function BEFORE calling diarkis.Start()
[IMPORTANT] MUST invoke this function AFTER calling mesh.Setup(...)

Error Cases

+------------------------------------------------+-----------------------------------------------------------------------------+
| Error                                          | Reason                                                                      |
+------------------------------------------------+-----------------------------------------------------------------------------+
| Setup must invoked at the start of the process | Invokding this function without calling Setup() is not allowed              |
| Must be invoked BEFORE the start of Diarkis    | Invokding this function after the start of Diarkis is not allowed           |
| Metrics name must be configured                | All metrics names must be configured in the configuration file              |
| Metrics value update function already assigned | Assigning multiple value update functions for a metrics name is not allowed |
+------------------------------------------------+-----------------------------------------------------------------------------+

The name must be configured in a configuration file.

func GetMetricsValues ¶

func GetMetricsValues(nodeType string) map[string][]*Item

GetMetricsValues [INTERNAL USE ONLY] returns all metrics values with the configured names and update functions

func PassMeshGetNodeAddressesByRole ¶

func PassMeshGetNodeAddressesByRole(cb func(string) []string)

PassMeshGetNodeAddressesByRole [INTERNAL USE ONLY]

func PassMeshGetNodeTypeByAddress ¶

func PassMeshGetNodeTypeByAddress(cb func(string) string)

PassMeshGetNodeTypeByAddress [INTERNAL USE ONLY]

func PassMeshGetNodeValue ¶

func PassMeshGetNodeValue(cb func(string, string) interface{})

PassMeshGetNodeValue [INTERNAL USE ONLY]

func PassMeshOnUpdate ¶

func PassMeshOnUpdate(cb func(func()))

PassMeshOnUpdate [INTERNAL USE ONLY]

func PassMeshSetNodeValue ¶

func PassMeshSetNodeValue(cb func(string, interface{}))

PassMeshSetNodeValue [INTERNAL USE ONLY]

func Setup ¶

func Setup(path string)

Setup must be invoked at the start of the process in order to use metrics.

[IMPORTANT] Must invoke this function BEFORE calling diarkis.Start()
[IMPORTANT] MUST invoke this function AFTER calling mesh.Setup(...)

type Item ¶

Item [INTERNAL USE ONLY] represents a metrics value

type Item struct {
    Addr  string
    Value interface{}
    Type  string
}

type ValueUpdate ¶

ValueUpdate is a function that updates the asasociated metrics value by using the returned value as its associated metrics value.

type ValueUpdate func() (value int)