-
Notifications
You must be signed in to change notification settings - Fork 2.4k
/
interface.go
73 lines (61 loc) · 2.24 KB
/
interface.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
// Copyright (c) 2019 The Jaeger Authors.
//
// 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.
package shared
import (
"github.com/hashicorp/go-plugin"
"github.com/jaegertracing/jaeger/storage/dependencystore"
"github.com/jaegertracing/jaeger/storage/spanstore"
)
// StoragePluginIdentifier is the identifier that is shared by plugin and host.
const StoragePluginIdentifier = "storage_plugin"
// Handshake is a common handshake that is shared by plugin and host.
var Handshake = plugin.HandshakeConfig{
MagicCookieKey: "STORAGE_PLUGIN",
MagicCookieValue: "jaeger",
}
// PluginMap is the map of plugins we can dispense.
var PluginMap = map[string]plugin.Plugin{
StoragePluginIdentifier: &StorageGRPCPlugin{},
}
// StoragePlugin is the interface we're exposing as a plugin.
type StoragePlugin interface {
SpanReader() spanstore.Reader
SpanWriter() spanstore.Writer
DependencyReader() dependencystore.Reader
}
// ArchiveStoragePlugin is the interface we're exposing as a plugin.
type ArchiveStoragePlugin interface {
ArchiveSpanReader() spanstore.Reader
ArchiveSpanWriter() spanstore.Writer
}
// StreamingSpanWriterPlugin is the interface we're exposing as a plugin.
type StreamingSpanWriterPlugin interface {
StreamingSpanWriter() spanstore.Writer
}
// PluginCapabilities allow expose plugin its capabilities.
type PluginCapabilities interface {
Capabilities() (*Capabilities, error)
}
// Capabilities contains information about plugin capabilities
type Capabilities struct {
ArchiveSpanReader bool
ArchiveSpanWriter bool
StreamingSpanWriter bool
}
// PluginServices defines services plugin can expose
type PluginServices struct {
Store StoragePlugin
ArchiveStore ArchiveStoragePlugin
StreamingSpanWriter StreamingSpanWriterPlugin
}