[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
76
server/public/pluginapi/experimental/telemetry/doc.go
Обычный файл
76
server/public/pluginapi/experimental/telemetry/doc.go
Обычный файл
@@ -0,0 +1,76 @@
|
||||
// Package telemetry allows you to add telemetry to your plugins.
|
||||
// For Rudder, you can set the data plane URL and the write key on build time,
|
||||
// to allow having different keys for production and development.
|
||||
// If you are working on a Mattermost project, the data plane URL is already set.
|
||||
// In order to default to the development key we have to set an environment variable during build time.
|
||||
// Copy the following lines in build/custom.mk to setup that variable.
|
||||
//
|
||||
// ifndef MM_RUDDER_WRITE_KEY
|
||||
// MM_RUDDER_WRITE_KEY = 1d5bMvdrfWClLxgK1FvV3s4U1tg
|
||||
// endif
|
||||
//
|
||||
// To use this environment variable to set the key in the plugin,
|
||||
// you have to add this line after the previous ones.
|
||||
//
|
||||
// LDFLAGS += -X "github.com/mattermost/mattermost/server/public/pluginapi/experimental/telemetry.rudderWriteKey=$(MM_RUDDER_WRITE_KEY)"
|
||||
//
|
||||
// MM_RUDDER_WRITE_KEY environment variable must be set also during CI
|
||||
// to the production write key ("1dP7Oi78p0PK1brYLsfslgnbD1I").
|
||||
// If you want to use your own data plane URL, add also this line and
|
||||
// make sure the MM_RUDDER_DATAPLANE_URL environment variable is set.
|
||||
//
|
||||
// LDFLAGS += -X "github.com/mattermost/mattermost/server/public/pluginapi/experimental/telemetry.rudderDataPlaneURL=$(MM_RUDDER_DATAPLANE_URL)"
|
||||
//
|
||||
// In order to use telemetry you should:
|
||||
//
|
||||
// 1. Add the new fields to the plugin
|
||||
//
|
||||
// type Plugin struct {
|
||||
// plugin.MattermostPlugin
|
||||
// ...
|
||||
// telemetryClient telemetry.Client
|
||||
// tracker telemetry.Tracker
|
||||
// }
|
||||
//
|
||||
// 2. Start the telemetry client and tracker on plugin activate
|
||||
//
|
||||
// func (p *Plugin) OnActivate() error {
|
||||
// p.telemetryClient, err = telemetry.NewRudderClient()
|
||||
// if err != nil {
|
||||
// p.API.LogWarn("telemetry client not started", "error", err.Error())
|
||||
// }
|
||||
// ...
|
||||
// p.tracker = telemetry.NewTracker(
|
||||
// p.telemetryClient,
|
||||
// p.API.GetDiagnosticId(),
|
||||
// p.API.GetServerVersion(),
|
||||
// Manifest.Id,
|
||||
// Manifest.Version,
|
||||
// "plugin_short_namame",
|
||||
// telemetry.NewTrackerConfig(p.API.GetConfig()),
|
||||
// logger.New(p.API)
|
||||
// )
|
||||
// }
|
||||
//
|
||||
// 3. Trigger tracker changes when configuration changes
|
||||
//
|
||||
// func (p *Plugin) OnConfigurationChange() error {
|
||||
// ...
|
||||
// if p.tracker != nil {
|
||||
// p.tracker.ReloadConfig(telemetry.NewTrackerConfig(p.API.GetConfig()))
|
||||
// }
|
||||
// return nil
|
||||
// }
|
||||
//
|
||||
// 4. Close the client on plugin deactivate
|
||||
//
|
||||
// func (p *Plugin) OnDeactivate() error {
|
||||
// if p.telemetryClient != nil {
|
||||
// err := p.telemetryClient.Close()
|
||||
// if err != nil {
|
||||
// p.API.LogWarn("OnDeactivate: failed to close telemetryClient", "error", err.Error())
|
||||
// }
|
||||
// }
|
||||
// return nil
|
||||
// }
|
||||
package telemetry
|
||||
49
server/public/pluginapi/experimental/telemetry/rudder.go
Обычный файл
49
server/public/pluginapi/experimental/telemetry/rudder.go
Обычный файл
@@ -0,0 +1,49 @@
|
||||
package telemetry
|
||||
|
||||
import (
|
||||
rudder "github.com/rudderlabs/analytics-go"
|
||||
)
|
||||
|
||||
// rudderDataPlaneURL is set to the common Data Plane URL for all Mattermost Projects.
|
||||
// It can be set during build time. More info in the package documentation.
|
||||
var rudderDataPlaneURL = "https://pdat.matterlytics.com"
|
||||
|
||||
// rudderWriteKey is set during build time. More info in the package documentation.
|
||||
var rudderWriteKey string
|
||||
|
||||
// NewRudderClient creates a new telemetry client with Rudder using the default configuration.
|
||||
func NewRudderClient() (Client, error) {
|
||||
return NewRudderClientWithCredentials(rudderWriteKey, rudderDataPlaneURL)
|
||||
}
|
||||
|
||||
// NewRudderClientWithCredentials lets you create a Rudder client with your own credentials.
|
||||
func NewRudderClientWithCredentials(writeKey, dataPlaneURL string) (Client, error) {
|
||||
client, err := rudder.NewWithConfig(writeKey, dataPlaneURL, rudder.Config{})
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return &rudderWrapper{client: client}, nil
|
||||
}
|
||||
|
||||
type rudderWrapper struct {
|
||||
client rudder.Client
|
||||
}
|
||||
|
||||
func (r *rudderWrapper) Enqueue(t Track) error {
|
||||
var context *rudder.Context
|
||||
if t.InstallationID != "" {
|
||||
context = &rudder.Context{Traits: map[string]any{"installationId": t.InstallationID}}
|
||||
}
|
||||
|
||||
return r.client.Enqueue(rudder.Track{
|
||||
UserId: t.UserID,
|
||||
Event: t.Event,
|
||||
Context: context,
|
||||
Properties: t.Properties,
|
||||
})
|
||||
}
|
||||
|
||||
func (r *rudderWrapper) Close() error {
|
||||
return r.client.Close()
|
||||
}
|
||||
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