snapshot of https://github.com/mattermost/mattermost.git (master, 2026-09-16; blobs > 131072B omitted)

server/einterfaces/metrics.go

@@ -0,0 +1,153 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package einterfaces
+
+import (
+	"database/sql"
+
+	"github.com/mattermost/mattermost/server/public/model"
+	"github.com/mattermost/mattermost/server/public/shared/mlog"
+)
+
+type MetricsInterface interface {
+	Register()
+	RegisterDBCollector(db *sql.DB, name string)
+	UnregisterDBCollector(db *sql.DB, name string)
+
+	IncrementPostCreate()
+	IncrementWebhookPost()
+	IncrementPostSentEmail()
+	IncrementPostSentPush()
+	IncrementPostBroadcast()
+	IncrementPostFileAttachment(count int)
+
+	IncrementHTTPRequest()
+	IncrementHTTPError()
+
+	IncrementClusterRequest()
+	ObserveClusterRequestDuration(elapsed float64)
+	IncrementClusterEventType(eventType model.ClusterEvent)
+	ObserveClusterReliableFallbackLength(event model.ClusterEvent, length int)
+
+	IncrementLogin()
+	IncrementLoginFail()
+
+	IncrementEtagHitCounter(route string)
+	IncrementEtagMissCounter(route string)
+
+	IncrementMemCacheHitCounter(cacheName string)
+	IncrementMemCacheMissCounter(cacheName string)
+	IncrementMemCacheInvalidationCounter(cacheName string)
+	IncrementMemCacheMissCounterSession()
+	IncrementMemCacheHitCounterSession()
+	IncrementMemCacheInvalidationCounterSession()
+
+	IncrementWebsocketEvent(eventType model.WebsocketEventType)
+	IncrementWebSocketBroadcast(eventType model.WebsocketEventType)
+	IncrementWebSocketBroadcastBufferSize(hub string, amount float64)
+	DecrementWebSocketBroadcastBufferSize(hub string, amount float64)
+	IncrementWebSocketBroadcastUsersRegistered(hub string, amount float64)
+	DecrementWebSocketBroadcastUsersRegistered(hub string, amount float64)
+	IncrementWebsocketReconnectEventWithDisconnectErrCode(eventType string, disconnectErrCode string)
+
+	IncrementHTTPWebSockets(originClient string)
+	DecrementHTTPWebSockets(originClient string)
+
+	AddMemCacheHitCounter(cacheName string, amount float64)
+	AddMemCacheMissCounter(cacheName string, amount float64)
+
+	IncrementPostsSearchCounter()
+	ObservePostsSearchDuration(elapsed float64)
+	IncrementFilesSearchCounter()
+	ObserveFilesSearchDuration(elapsed float64)
+	ObserveStoreMethodDuration(method, success string, elapsed float64)
+	ObserveAPIEndpointDuration(endpoint, method, statusCode, originClient, pageLoadContext string, elapsed float64)
+	ObserveRedisEndpointDuration(cacheName, operation string, elapsed float64)
+	IncrementPostIndexCounter()
+	IncrementFileIndexCounter()
+	IncrementUserIndexCounter()
+	IncrementChannelIndexCounter()
+
+	ObservePluginHookDuration(pluginID, hookName string, success bool, elapsed float64)
+	ObservePluginMultiHookIterationDuration(pluginID string, elapsed float64)
+	ObservePluginMultiHookDuration(elapsed float64)
+	ObservePluginAPIDuration(pluginID, apiName string, success bool, elapsed float64)
+
+	ObserveEnabledUsers(users int64)
+	GetLoggerMetricsCollector() mlog.MetricsCollector
+
+	IncrementRemoteClusterMsgSentCounter(remoteID string)
+	IncrementRemoteClusterMsgReceivedCounter(remoteID string)
+	IncrementRemoteClusterMsgErrorsCounter(remoteID string, timeout bool)
+	ObserveRemoteClusterPingDuration(remoteID string, elapsed float64)
+	ObserveRemoteClusterClockSkew(remoteID string, skew float64)
+	IncrementRemoteClusterConnStateChangeCounter(remoteID string, online bool)
+
+	IncrementSharedChannelsSyncCounter(remoteID string)
+	ObserveSharedChannelsTaskInQueueDuration(elapsed float64)
+	ObserveSharedChannelsQueueSize(size int64)
+	ObserveSharedChannelsSyncCollectionDuration(remoteID string, elapsed float64)
+	ObserveSharedChannelsSyncSendDuration(remoteID string, elapsed float64)
+	ObserveSharedChannelsSyncCollectionStepDuration(remoteID string, step string, elapsed float64)
+	ObserveSharedChannelsSyncSendStepDuration(remoteID string, step string, elapsed float64)
+
+	IncrementJobActive(jobType string)
+	DecrementJobActive(jobType string)
+
+	SetReplicaLagAbsolute(node string, value float64)
+	SetReplicaLagTime(node string, value float64)
+
+	IncrementNotificationCounter(notificationType model.NotificationType, platform string)
+	IncrementNotificationAckCounter(notificationType model.NotificationType, platform string)
+	IncrementNotificationSuccessCounter(notificationType model.NotificationType, platform string)
+	IncrementNotificationErrorCounter(notificationType model.NotificationType, errorReason model.NotificationReason, platform string)
+	IncrementNotificationNotSentCounter(notificationType model.NotificationType, notSentReason model.NotificationReason, platform string)
+	IncrementNotificationUnsupportedCounter(notificationType model.NotificationType, notSentReason model.NotificationReason, platform string)
+
+	ObserveClientTimeToFirstByte(platform, agent, userID string, elapsed float64)
+	ObserveClientTimeToLastByte(platform, agent, userID string, elapsed float64)
+	ObserveClientTimeToDomInteractive(platform, agent, userID string, elapsed float64)
+	ObserveClientSplashScreenEnd(platform, agent, pageType, userID string, elapsed float64)
+	ObserveClientFirstContentfulPaint(platform, agent, userID string, elapsed float64)
+	ObserveClientLargestContentfulPaint(platform, agent, region, userID string, elapsed float64)
+	ObserveClientInteractionToNextPaint(platform, agent, interaction, userID string, elapsed float64)
+	ObserveClientCumulativeLayoutShift(platform, agent, userID string, elapsed float64)
+	IncrementClientLongTasks(platform, agent, userID string, inc float64)
+	ObserveClientPageLoadDuration(platform, agent, userID string, elapsed float64)
+	ObserveClientChannelSwitchDuration(platform, agent, fresh, userID string, elapsed float64)
+	ObserveClientTeamSwitchDuration(platform, agent, fresh, userID string, elapsed float64)
+	ObserveClientRHSLoadDuration(platform, agent, userID string, elapsed float64)
+	ObserveGlobalThreadsLoadDuration(platform, agent, userID string, elapsed float64)
+	ObserveMobileClientLoadDuration(platform string, elapsed float64)
+	ObserveMobileClientChannelSwitchDuration(platform string, elapsed float64)
+	ObserveMobileClientTeamSwitchDuration(platform string, elapsed float64)
+	ObserveMobileClientNetworkRequestsAverageSpeed(platform, agent, networkRequestGroup string, speed float64)
+	ObserveMobileClientNetworkRequestsEffectiveLatency(platform, agent, networkRequestGroup string, latency float64)
+	ObserveMobileClientNetworkRequestsElapsedTime(platform, agent, networkRequestGroup string, elapsedTime float64)
+	ObserveMobileClientNetworkRequestsLatency(platform, agent, networkRequestGroup string, latency float64)
+	ObserveMobileClientNetworkRequestsTotalCompressedSize(platform, agent, networkRequestGroup string, size float64)
+	ObserveMobileClientNetworkRequestsTotalParallelRequests(platform, agent, networkRequestGroup string, count float64)
+	ObserveMobileClientNetworkRequestsTotalRequests(platform, agent, networkRequestGroup string, count float64)
+	ObserveMobileClientNetworkRequestsTotalSequentialRequests(platform, agent, networkRequestGroup string, count float64)
+	ObserveMobileClientNetworkRequestsTotalSize(platform, agent, networkRequestGroup string, size float64)
+	ClearMobileClientSessionMetadata()
+	ObserveMobileClientSessionMetadata(version string, platform string, value float64, notificationDisabled string)
+	ObserveDesktopCpuUsage(platform, version, process string, usage float64)
+	ObserveDesktopMemoryUsage(platform, version, process string, usage float64)
+	ObservePluginWebappPerf(platform, agent, pluginID, pluginMetricLabel string, elapsed float64)
+
+	ObserveAccessControlSearchQueryDuration(value float64)
+	ObserveAccessControlExpressionCompileDuration(value float64)
+	ObserveAccessControlEvaluateDuration(value float64)
+	IncrementAccessControlCacheInvalidation()
+
+	// Auto-translation metrics
+	ObserveAutoTranslateTranslateDuration(objectType string, elapsed float64)
+	ObserveAutoTranslateLinguaDetectionDuration(elapsed float64)
+	ObserveAutoTranslateProviderCallDuration(provider, result string, elapsed float64)
+	SetAutoTranslateQueueDepth(depth float64)
+	ObserveAutoTranslateWorkerTaskDuration(elapsed float64)
+	AddAutoTranslateRecoveryStuckFound(count float64)
+	IncrementAutoTranslateNormHash(result string)
+}