forked from intelsdi-x/snap
-
Notifications
You must be signed in to change notification settings - Fork 0
/
plugin_manager.go
526 lines (453 loc) · 14 KB
/
plugin_manager.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
/*
http://www.apache.org/licenses/LICENSE-2.0.txt
Copyright 2015 Intel Corporation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
// PluginManger manages loading, unloading, and swapping
// of plugins
package control
import (
"errors"
"fmt"
"os"
"path/filepath"
"strconv"
"strings"
"sync"
"time"
log "github.com/Sirupsen/logrus"
"github.com/intelsdi-x/gomit"
"github.com/intelsdi-x/pulse/control/plugin"
"github.com/intelsdi-x/pulse/control/plugin/client"
"github.com/intelsdi-x/pulse/control/plugin/cpolicy"
"github.com/intelsdi-x/pulse/core"
"github.com/intelsdi-x/pulse/core/perror"
)
const (
// loadedPlugin States
DetectedState pluginState = "detected"
LoadingState pluginState = "loading"
LoadedState pluginState = "loaded"
UnloadedState pluginState = "unloaded"
)
var (
ErrPluginNotFound = errors.New("plugin not found")
ErrPluginAlreadyLoaded = errors.New("plugin is already loaded")
ErrPluginNotInLoadedState = errors.New("Plugin must be in a LoadedState")
pmLogger = log.WithField("_module", "control-plugin-mgr")
)
type pluginState string
type loadedPlugins struct {
*sync.RWMutex
table map[string]*loadedPlugin
}
func newLoadedPlugins() *loadedPlugins {
return &loadedPlugins{
RWMutex: &sync.RWMutex{},
table: make(map[string]*loadedPlugin),
}
}
// add adds a loadedPlugin pointer to the table
func (l *loadedPlugins) add(lp *loadedPlugin) perror.PulseError {
l.Lock()
defer l.Unlock()
if _, exists := l.table[lp.Key()]; exists {
return perror.New(ErrPluginAlreadyLoaded, map[string]interface{}{
"plugin-name": lp.Meta.Name,
"plugin-version": lp.Meta.Version,
"plugin-type": lp.Type.String(),
})
}
l.table[lp.Key()] = lp
return nil
}
// get retrieves a plugin from the table
func (l *loadedPlugins) get(key string) (*loadedPlugin, error) {
l.RLock()
defer l.RUnlock()
lp, ok := l.table[key]
if !ok {
tnv := strings.Split(key, ":")
if len(tnv) != 3 {
return nil, ErrBadKey
}
v, err := strconv.Atoi(tnv[2])
if err != nil {
return nil, ErrBadKey
}
if v < 1 {
pmLogger.Info("finding latest plugin")
return l.findLatest(tnv[0], tnv[1])
}
return nil, ErrPluginNotFound
}
return lp, nil
}
func (l *loadedPlugins) remove(key string) {
l.Lock()
delete(l.table, key)
l.Unlock()
}
func (l *loadedPlugins) findLatest(typeName, name string) (*loadedPlugin, error) {
l.RLock()
defer l.RUnlock()
// quick check to see if there exists a plugin with the name/version we're looking for.
// if not we just return ErrNotFound before we check versions.
var latest *loadedPlugin
for _, lp := range l.table {
if lp.TypeName() == typeName && lp.Name() == name {
latest = lp
break
}
}
if latest != nil {
for _, lp := range l.table {
if lp.TypeName() == typeName && lp.Name() == name && lp.Version() > latest.Version() {
latest = lp
}
}
return latest, nil
}
return nil, ErrPluginNotFound
}
// the struct representing a plugin that is loaded into Pulse
type loadedPlugin struct {
Meta plugin.PluginMeta
Path string
Type plugin.PluginType
Signed bool
SignatureFile string
State pluginState
Token string
LoadedTime time.Time
ConfigPolicy *cpolicy.ConfigPolicy
}
// returns plugin name
// implements the CatalogedPlugin interface
func (lp *loadedPlugin) Name() string {
return lp.Meta.Name
}
func (lp *loadedPlugin) PluginPath() string {
return lp.Path
}
func (l *loadedPlugin) Key() string {
return fmt.Sprintf("%s:%s:%d", l.TypeName(), l.Name(), l.Version())
}
// returns plugin version
// implements the CatalogedPlugin interface
func (lp *loadedPlugin) Version() int {
return lp.Meta.Version
}
// returns plugin type as a string
// implements the CatalogedPlugin interface
func (lp *loadedPlugin) TypeName() string {
return lp.Type.String()
}
// returns current plugin state
// implements the CatalogedPlugin interface
func (lp *loadedPlugin) Status() string {
return string(lp.State)
}
// returns plugin signing as a bool
// implements the CatalogedPlugin interface
func (lp *loadedPlugin) IsSigned() bool {
return lp.Signed
}
// returns a unix timestamp of the LoadTime of a plugin
// implements the CatalogedPlugin interface
func (lp *loadedPlugin) LoadedTimestamp() *time.Time {
return &lp.LoadedTime
}
// the struct representing the object responsible for
// loading and unloading plugins
type pluginManager struct {
metricCatalog catalogsMetrics
loadedPlugins *loadedPlugins
logPath string
pluginConfig *pluginConfig
}
func newPluginManager(opts ...pluginManagerOpt) *pluginManager {
p := &pluginManager{
loadedPlugins: newLoadedPlugins(),
logPath: "/tmp",
pluginConfig: newPluginConfig(),
}
for _, opt := range opts {
opt(p)
}
return p
}
type pluginManagerOpt func(*pluginManager)
func OptSetPluginConfig(cf *pluginConfig) pluginManagerOpt {
return func(p *pluginManager) {
p.pluginConfig = cf
}
}
func (p *pluginManager) SetPluginConfig(cf *pluginConfig) {
p.pluginConfig = cf
}
func (p *pluginManager) SetMetricCatalog(mc catalogsMetrics) {
p.metricCatalog = mc
}
// Load is the method for loading a plugin and
// saving plugin into the LoadedPlugins array
func (p *pluginManager) LoadPlugin(path string, emitter gomit.Emitter) (*loadedPlugin, perror.PulseError) {
lPlugin := new(loadedPlugin)
lPlugin.Path = path
lPlugin.State = DetectedState
pmLogger.WithFields(log.Fields{
"_block": "load-plugin",
"path": filepath.Base(lPlugin.Path),
}).Info("plugin load called")
ePlugin, err := plugin.NewExecutablePlugin(p.GenerateArgs(lPlugin.Path), lPlugin.Path)
if err != nil {
pmLogger.WithFields(log.Fields{
"_block": "load-plugin",
"error": err.Error(),
}).Error("load plugin error while creating executable plugin")
return nil, perror.New(err)
}
err = ePlugin.Start()
if err != nil {
pmLogger.WithFields(log.Fields{
"_block": "load-plugin",
"error": err.Error(),
}).Error("load plugin error while starting plugin")
return nil, perror.New(err)
}
var resp *plugin.Response
resp, err = ePlugin.WaitForResponse(time.Second * 3)
if err != nil {
pmLogger.WithFields(log.Fields{
"_block": "load-plugin",
"error": err.Error(),
}).Error("load plugin error while waiting for response from plugin")
return nil, perror.New(err)
}
ap, err := newAvailablePlugin(resp, emitter, ePlugin)
if err != nil {
pmLogger.WithFields(log.Fields{
"_block": "load-plugin",
"error": err.Error(),
}).Error("load plugin error while creating available plugin")
return nil, perror.New(err)
}
if resp.Meta.Unsecure {
err = ap.client.Ping()
} else {
err = ap.client.SetKey()
}
if err != nil {
pmLogger.WithFields(log.Fields{
"_block": "load-plugin",
"error": err.Error(),
}).Error("load plugin error while pinging the plugin")
return nil, perror.New(err)
}
// Get the ConfigPolicy and add it to the loaded plugin
c, ok := ap.client.(plugin.Plugin)
if !ok {
return nil, perror.New(errors.New("missing GetConfigPolicy function"))
}
cp, err := c.GetConfigPolicy()
if err != nil {
pmLogger.WithFields(log.Fields{
"_block": "load-plugin",
"plugin-type": "collector",
"error": err.Error(),
"plugin-name": ap.Name(),
"plugin-version": ap.Version(),
"plugin-id": ap.ID(),
}).Error("error in getting config policy")
return nil, perror.New(err)
}
lPlugin.ConfigPolicy = cp
if resp.Type == plugin.CollectorPluginType {
colClient := ap.client.(client.PluginCollectorClient)
cfg := plugin.PluginConfigType{
ConfigDataNode: p.pluginConfig.getPluginConfigDataNode(core.PluginType(resp.Type), resp.Meta.Name, resp.Meta.Version),
}
metricTypes, err := colClient.GetMetricTypes(cfg)
if err != nil {
pmLogger.WithFields(log.Fields{
"_block": "load-plugin",
"plugin-type": "collector",
"error": err.Error(),
}).Error("error in getting metric types")
return nil, perror.New(err)
}
// The plugin cache client will be integrated here later
// Add metric types to metric catalog
for _, nmt := range metricTypes {
// If the version is 0 default it to the plugin version
// This honors the plugins explicit version but falls back
// to the plugin version as default
if nmt.Version() < 1 {
// Since we have to override version we convert to a internal struct
nmt = &metricType{
namespace: nmt.Namespace(),
version: resp.Meta.Version,
lastAdvertisedTime: nmt.LastAdvertisedTime(),
config: nmt.Config(),
data: nmt.Data(),
}
}
// We quit and throw an error on bad metric versions (<1)
// the is a safety catch otherwise the catalog will be corrupted
if nmt.Version() < 1 {
err := errors.New("Bad metric version from plugin")
pmLogger.WithFields(log.Fields{
"_block": "load-plugin",
"plugin-name": resp.Meta.Name,
"plugin-version": resp.Meta.Version,
"plugin-type": resp.Meta.Type.String(),
"plugin-path": filepath.Base(lPlugin.Path),
"metric-namespace": nmt.Namespace(),
"metric-version": nmt.Version(),
"error": err.Error(),
}).Error("received metric with bad version")
return nil, perror.New(err)
}
p.metricCatalog.AddLoadedMetricType(lPlugin, nmt)
}
}
err = ePlugin.Kill()
if err != nil {
pmLogger.WithFields(log.Fields{
"_block": "load-plugin",
"error": err.Error(),
}).Error("load plugin error while killing plugin executable plugin")
return nil, perror.New(err)
}
if resp.State != plugin.PluginSuccess {
e := fmt.Errorf("Plugin loading did not succeed: %s\n", resp.ErrorMessage)
pmLogger.WithFields(log.Fields{
"_block": "load-plugin",
"error": e,
"plugin response": resp.ErrorMessage,
}).Error("load plugin error")
return nil, perror.New(e)
}
lPlugin.Meta = resp.Meta
lPlugin.Type = resp.Type
lPlugin.Token = resp.Token
lPlugin.LoadedTime = time.Now()
lPlugin.State = LoadedState
aErr := p.loadedPlugins.add(lPlugin)
if aErr != nil {
pmLogger.WithFields(log.Fields{
"_block": "load-plugin",
"error": aErr,
}).Error("load plugin error while adding loaded plugin to load plugins collection")
return nil, aErr
}
return lPlugin, nil
}
// unloads a plugin from the LoadedPlugins table
func (p *pluginManager) UnloadPlugin(pl core.Plugin) (*loadedPlugin, perror.PulseError) {
plugin, err := p.loadedPlugins.get(fmt.Sprintf("%s:%s:%d", pl.TypeName(), pl.Name(), pl.Version()))
if err != nil {
pe := perror.New(ErrPluginNotFound, map[string]interface{}{
"plugin-name": pl.Name(),
"plugin-version": pl.Version(),
"plugin-type": pl.TypeName(),
})
return nil, pe
}
if plugin.State != LoadedState {
pe := perror.New(ErrPluginNotInLoadedState, map[string]interface{}{
"plugin-name": plugin.Name(),
"plugin-version": plugin.Version(),
"plugin-type": pl.TypeName(),
})
return nil, pe
}
// If the plugin was loaded from os.TempDir() clean up
if strings.Contains(plugin.Path, os.TempDir()) {
pmLogger.WithFields(log.Fields{
"plugin-type": plugin.TypeName(),
"plugin-name": plugin.Name(),
"plugin-version": plugin.Version(),
"plugin-path": plugin.Path,
}).Debugf("Removing plugin")
if err := os.RemoveAll(filepath.Dir(plugin.Path)); err != nil {
pmLogger.WithFields(log.Fields{
"plugin-type": plugin.TypeName(),
"plugin-name": plugin.Name(),
"plugin-version": plugin.Version(),
"plugin-path": plugin.Path,
}).Error(err)
pe := perror.New(err)
pe.SetFields(map[string]interface{}{
"plugin-type": plugin.TypeName(),
"plugin-name": plugin.Name(),
"plugin-version": plugin.Version(),
"plugin-path": plugin.Path,
})
return nil, pe
}
if plugin.SignatureFile != "" {
pmLogger.WithFields(log.Fields{
"plugin-type": plugin.TypeName(),
"plugin-name": plugin.Name(),
"plugin-version": plugin.Version(),
"plugin-signature-file": plugin.SignatureFile,
}).Debugf("Removing plugin signature file")
if err := os.RemoveAll(filepath.Dir(plugin.SignatureFile)); err != nil {
pmLogger.WithFields(log.Fields{
"plugin-type": plugin.TypeName(),
"plugin-name": plugin.Name(),
"plugin-version": plugin.Version(),
"plugin-signature-file": plugin.SignatureFile,
}).Error(err)
pe := perror.New(err)
pe.SetFields(map[string]interface{}{
"plugin-type": plugin.TypeName(),
"plugin-name": plugin.Name(),
"plugin-version": plugin.Version(),
"plugin-signature-file": plugin.SignatureFile,
})
return nil, pe
}
}
}
p.loadedPlugins.remove(plugin.Key())
// Remove any metrics from the catalog if this was a collector
if plugin.TypeName() == "collector" {
p.metricCatalog.RmUnloadedPluginMetrics(plugin)
}
return plugin, nil
}
func (p *pluginManager) GenerateArgs(pluginPath string) plugin.Arg {
pluginLog := filepath.Join(p.logPath, filepath.Base(pluginPath)) + ".log"
return plugin.NewArg(pluginLog)
}
func (p *pluginManager) teardown() {
for _, lp := range p.loadedPlugins.table {
_, err := p.UnloadPlugin(lp)
if err != nil {
runnerLog.WithFields(log.Fields{
"plugin-type": lp.TypeName(),
"plugin-name": lp.Name(),
"plugin-version": lp.Version(),
"plugin-path": lp.Path,
}).Warn("error removing plugin in teardown:", err)
}
}
}
func (p *pluginManager) get(key string) (*loadedPlugin, error) {
return p.loadedPlugins.get(key)
}
func (p *pluginManager) all() map[string]*loadedPlugin {
p.loadedPlugins.RLock()
defer p.loadedPlugins.RUnlock()
return p.loadedPlugins.table
}