[MM-53968] Includes mattermost-plugin-api into the mono repo (#24235)
Include https://github.com/mattermost/mattermost-plugin-api into the mono repo Co-authored-by: Jesse Hallam <jesse.hallam@gmail.com> Co-authored-by: Michael Kochell <mjkochell@gmail.com> Co-authored-by: Alejandro García Montoro <alejandro.garciamontoro@gmail.com> Co-authored-by: Ben Schumacher <ben.schumacher@mattermost.com> Co-authored-by: Alex Dovenmuehle <alex.dovenmuehle@mattermost.com> Co-authored-by: Michael Kochell <6913320+mickmister@users.noreply.github.com> Co-authored-by: Christopher Poile <cpoile@gmail.com> Co-authored-by: İlker Göktuğ Öztürk <ilkergoktugozturk@gmail.com> Co-authored-by: Shota Gvinepadze <wineson@gmail.com> Co-authored-by: Ali Farooq <ali.farooq0@pm.me> Co-authored-by: Maria A Nunez <maria.nunez@mattermost.com> Co-authored-by: Daniel Espino García <larkox@gmail.com> Co-authored-by: Christopher Speller <crspeller@gmail.com> Co-authored-by: Alex Dovenmuehle <adovenmuehle@gmail.com> Co-authored-by: Szymon Gibała <szymongib@gmail.com> Co-authored-by: Lev <1187448+levb@users.noreply.github.com> Co-authored-by: Jason Frerich <jason.frerich@mattermost.com> Co-authored-by: Agniva De Sarker <agnivade@yahoo.co.in> Co-authored-by: Artur M. Wolff <artur.m.wolff@gmail.com> Co-authored-by: Madhav Hugar <16546715+madhavhugar@users.noreply.github.com> Co-authored-by: Joe <security.joe@pm.me> Co-authored-by: Ibrahim Serdar Acikgoz <serdaracikgoz86@gmail.com> Co-authored-by: José Peso <trilopin@users.noreply.github.com>
Этот коммит содержится в:
Ben Schumacher
коммит произвёл
GitHub
GitHub
родитель
bc11b29807
Коммит
3ee5432664
179
server/public/pluginapi/experimental/telemetry/tracker.go
Обычный файл
179
server/public/pluginapi/experimental/telemetry/tracker.go
Обычный файл
@@ -0,0 +1,179 @@
|
||||
package telemetry
|
||||
|
||||
import (
|
||||
"os"
|
||||
"sync"
|
||||
|
||||
"github.com/pkg/errors"
|
||||
|
||||
"github.com/mattermost/mattermost/server/public/model"
|
||||
"github.com/mattermost/mattermost/server/public/pluginapi/experimental/bot/logger"
|
||||
)
|
||||
|
||||
type TrackerConfig struct {
|
||||
EnabledTracking bool
|
||||
EnabledLogging bool
|
||||
}
|
||||
|
||||
// NewTrackerConfig returns a new trackerConfig from the current values of the model.Config.
|
||||
func NewTrackerConfig(config *model.Config) TrackerConfig {
|
||||
var enabledTracking, enabledLogging bool
|
||||
if config == nil {
|
||||
return TrackerConfig{}
|
||||
}
|
||||
|
||||
if enableDiagnostics := config.LogSettings.EnableDiagnostics; enableDiagnostics != nil {
|
||||
enabledTracking = *enableDiagnostics
|
||||
}
|
||||
|
||||
if enableDeveloper := config.ServiceSettings.EnableDeveloper; enableDeveloper != nil {
|
||||
enabledLogging = *enableDeveloper
|
||||
}
|
||||
|
||||
return TrackerConfig{
|
||||
EnabledTracking: enabledTracking,
|
||||
EnabledLogging: enabledLogging,
|
||||
}
|
||||
}
|
||||
|
||||
// Tracker defines a telemetry tracker
|
||||
type Tracker interface {
|
||||
// TrackEvent registers an event through the configured telemetry client
|
||||
TrackEvent(event string, properties map[string]interface{}) error
|
||||
// TrackUserEvent registers an event through the configured telemetry client associated to a user
|
||||
TrackUserEvent(event string, userID string, properties map[string]interface{}) error
|
||||
// Reload Config re-evaluates tracker config to determine if tracking behavior should change
|
||||
ReloadConfig(config TrackerConfig)
|
||||
}
|
||||
|
||||
// Client defines a telemetry client
|
||||
type Client interface {
|
||||
// Enqueue adds a tracker event (Track) to be registered
|
||||
Enqueue(t Track) error
|
||||
// Close closes the client connection, flushing any event left on the queue
|
||||
Close() error
|
||||
}
|
||||
|
||||
// Track defines an event ready for the client to process
|
||||
type Track struct {
|
||||
UserID string
|
||||
Event string
|
||||
Properties map[string]interface{}
|
||||
InstallationID string
|
||||
}
|
||||
|
||||
type tracker struct {
|
||||
client Client
|
||||
diagnosticID string
|
||||
serverVersion string
|
||||
pluginID string
|
||||
pluginVersion string
|
||||
telemetryShortName string
|
||||
configLock sync.RWMutex
|
||||
config TrackerConfig
|
||||
logger logger.Logger
|
||||
}
|
||||
|
||||
// NewTracker creates a default Tracker
|
||||
// - c Client: A telemetry client. If nil, the tracker will not track any event.
|
||||
// - diagnosticID: Server unique ID used for telemetry.
|
||||
// - severVersion: Mattermost server version.
|
||||
// - pluginID: The plugin ID.
|
||||
// - pluginVersion: The plugin version.
|
||||
// - telemetryShortName: Short name for the plugin to use in telemetry. Used to avoid dot separated names like `com.company.pluginName`.
|
||||
// If a empty string is provided, it will use the pluginID.
|
||||
// - config: Whether the system has enabled sending telemetry data. If false, the tracker will not track any event.
|
||||
// - l Logger: A logger to debug event tracking and some important changes (it won't log if nil is passed as logger).
|
||||
func NewTracker(
|
||||
c Client,
|
||||
diagnosticID,
|
||||
serverVersion,
|
||||
pluginID,
|
||||
pluginVersion,
|
||||
telemetryShortName string,
|
||||
config TrackerConfig,
|
||||
l logger.Logger,
|
||||
) Tracker {
|
||||
if telemetryShortName == "" {
|
||||
telemetryShortName = pluginID
|
||||
}
|
||||
return &tracker{
|
||||
telemetryShortName: telemetryShortName,
|
||||
client: c,
|
||||
diagnosticID: diagnosticID,
|
||||
serverVersion: serverVersion,
|
||||
pluginID: pluginID,
|
||||
pluginVersion: pluginVersion,
|
||||
logger: l,
|
||||
config: config,
|
||||
}
|
||||
}
|
||||
|
||||
func (t *tracker) ReloadConfig(config TrackerConfig) {
|
||||
t.configLock.Lock()
|
||||
defer t.configLock.Unlock()
|
||||
|
||||
if config.EnabledTracking != t.config.EnabledTracking {
|
||||
if config.EnabledTracking {
|
||||
t.debugf("Enabling plugin telemetry")
|
||||
} else {
|
||||
t.debugf("Disabling plugin telemetry")
|
||||
}
|
||||
}
|
||||
|
||||
t.config.EnabledTracking = config.EnabledTracking
|
||||
t.config.EnabledLogging = config.EnabledLogging
|
||||
}
|
||||
|
||||
// Note that config lock is handled by the caller.
|
||||
func (t *tracker) debugf(message string, args ...interface{}) {
|
||||
if t.logger == nil || !t.config.EnabledLogging {
|
||||
return
|
||||
}
|
||||
t.logger.Debugf(message, args...)
|
||||
}
|
||||
|
||||
func (t *tracker) TrackEvent(event string, properties map[string]interface{}) error {
|
||||
t.configLock.RLock()
|
||||
defer t.configLock.RUnlock()
|
||||
|
||||
event = t.telemetryShortName + "_" + event
|
||||
if !t.config.EnabledTracking || t.client == nil {
|
||||
t.debugf("Plugin telemetry event `%s` tracked, but not sent due to configuration", event)
|
||||
return nil
|
||||
}
|
||||
|
||||
if properties == nil {
|
||||
properties = map[string]interface{}{}
|
||||
}
|
||||
properties["PluginID"] = t.pluginID
|
||||
properties["PluginVersion"] = t.pluginVersion
|
||||
properties["ServerVersion"] = t.serverVersion
|
||||
|
||||
// if we are part of a cloud installation, add it's ID to the tracked event's context.
|
||||
installationID := os.Getenv("MM_CLOUD_INSTALLATION_ID")
|
||||
|
||||
err := t.client.Enqueue(Track{
|
||||
// We consider the server the "user" on the telemetry system. Any reference to the actual user is passed by properties.
|
||||
UserID: t.diagnosticID,
|
||||
Event: event,
|
||||
Properties: properties,
|
||||
InstallationID: installationID,
|
||||
})
|
||||
|
||||
if err != nil {
|
||||
return errors.Wrap(err, "cannot enqueue the track")
|
||||
}
|
||||
t.debugf("Tracked plugin telemetry event `%s`", event)
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func (t *tracker) TrackUserEvent(event, userID string, properties map[string]interface{}) error {
|
||||
if properties == nil {
|
||||
properties = map[string]interface{}{}
|
||||
}
|
||||
|
||||
properties["UserActualID"] = userID
|
||||
return t.TrackEvent(event, properties)
|
||||
}
|
||||
Ссылка в новой задаче
Block a user