public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Plugins: Support for distributed tracing in backend plugins SDK (#63714)

Browse Source 
* Tracing: Pass OTLP address and propagation format to plugins

* Fix unit tests

* Fix indentation

* Fix plugin manager integration tests

* Goimports

* Pass plugin version to plugins

* Do not add GF_PLUGIN_VERSION if plugin version is not set, add tests

* Allow disabling plugins distributed tracing on a per-plugin basis

* Moved disabled plugins to tracing.opentelemetry config section

* Pre-allocate DisabledPlugins map to the correct size

* Moved disable tracing setting flags in plugin settings

* Renamed plugin env vars for tracing endpoint and propagation

* Fix plugin initializer tests

* Refactoring: Moved OpentelemetryCfg from pkg/infra to pkg/plugins

* Changed GetSection to Section in parseSettingsOpentelemetry

* Add tests for NewOpentelemetryCfg

* Fix test case names in TestNewOpentelemetryCfg

* OpenTelemetry: Remove redundant error checks
This commit is contained in:
Giuseppe Guerra
2023-03-30 23:31:14 +02:00
committed by GitHub
parent 55947cee8f
commit 09078b14e1
11 changed files with 327 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files
pkg/plugins/config/config.go
+11 -3
View File
@@ -1,6 +1,7 @@
package config
import (
"fmt"
"strings"
"github.com/grafana/grafana-azure-sdk-go/azsettings"
@@ -31,13 +32,15 @@ type Cfg struct {
LogDatasourceRequests bool
PluginsCDNURLTemplate string
Opentelemetry OpentelemetryCfg
}
func ProvideConfig(settingProvider setting.Provider, grafanaCfg *setting.Cfg) *Cfg {
func ProvideConfig(settingProvider setting.Provider, grafanaCfg *setting.Cfg) (*Cfg, error) {
return NewCfg(settingProvider, grafanaCfg)
}
func NewCfg(settingProvider setting.Provider, grafanaCfg *setting.Cfg) *Cfg {
func NewCfg(settingProvider setting.Provider, grafanaCfg *setting.Cfg) (*Cfg, error) {
logger := log.New("plugin.cfg")
aws := settingProvider.Section("aws")
@@ -53,6 +56,10 @@ func NewCfg(settingProvider setting.Provider, grafanaCfg *setting.Cfg) *Cfg {
allowedUnsigned = strings.Split(settingProvider.KeyValue("plugins", "allow_loading_unsigned_plugins").Value(), ",")
}
otelCfg, err := NewOpentelemetryCfg(grafanaCfg)
if err != nil {
return nil, fmt.Errorf("new opentelemetry cfg: %w", err)
}
return &Cfg{
log: logger,
PluginsPath: grafanaCfg.PluginsPath,
@@ -65,7 +72,8 @@ func NewCfg(settingProvider setting.Provider, grafanaCfg *setting.Cfg) *Cfg {
Azure: grafanaCfg.Azure,
LogDatasourceRequests: grafanaCfg.PluginLogBackendRequests,
PluginsCDNURLTemplate: grafanaCfg.PluginsCDNURLTemplate,
}
Opentelemetry: otelCfg,
}, nil
}
func extractPluginSettings(settingProvider setting.Provider) setting.PluginSettings {
pkg/plugins/config/tracing.go
+38
View File
@@ -0,0 +1,38 @@
package config
import (
"fmt"
"github.com/grafana/grafana/pkg/infra/tracing"
"github.com/grafana/grafana/pkg/setting"
)
const otlpExporter string = "otlp"
// OpentelemetryCfg contains the Opentelemetry address and propagation config values.
// This is used to export the Opentelemetry (OTLP) config without exposing the whole *setting.Cfg.
type OpentelemetryCfg struct {
Address string
Propagation string
}
// IsEnabled returns true if OTLP tracing is enabled (address set)
func (c OpentelemetryCfg) IsEnabled() bool {
return c.Address != ""
}
// NewOpentelemetryCfg creates a new OpentelemetryCfg based on the provided Grafana config.
// If Opentelemetry (OTLP) is disabled, a zero-value OpentelemetryCfg is returned.
func NewOpentelemetryCfg(grafanaCfg *setting.Cfg) (OpentelemetryCfg, error) {
ots, err := tracing.ParseSettingsOpentelemetry(grafanaCfg)
if err != nil {
return OpentelemetryCfg{}, fmt.Errorf("parse settings: %w", err)
}
if ots.Enabled != otlpExporter {
return OpentelemetryCfg{}, nil
}
return OpentelemetryCfg{
Address: ots.Address,
Propagation: ots.Propagation,
}, nil
}
pkg/plugins/config/tracing_test.go
+50
View File
@@ -0,0 +1,50 @@
package config
import (
"testing"
"github.com/grafana/grafana/pkg/setting"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func TestNewOpentelemetryCfg(t *testing.T) {
t.Run("empty", func(t *testing.T) {
cfg := setting.NewCfg()
otelCfg, err := NewOpentelemetryCfg(cfg)
require.NoError(t, err)
assert.False(t, otelCfg.IsEnabled(), "otel should be disabled")
assert.Empty(t, otelCfg.Address)
assert.Empty(t, otelCfg.Propagation)
})
t.Run("enabled", func(t *testing.T) {
for _, tc := range []struct {
name string
propagation string
}{
{"empty", ""},
{"jaeger", "jaeger"},
{"w3c", "w3c"},
{"multiple", "jaeger,w3c"},
} {
t.Run(tc.name, func(t *testing.T) {
const address = "127.0.0.1:4317"
cfg := setting.NewCfg()
otlpSect := cfg.Raw.Section("tracing.opentelemetry.otlp")
otlpSect.Key("address").SetValue(address)
if tc.propagation != "" {
otlpSect.Key("propagation").SetValue(tc.propagation)
}
otelCfg, err := NewOpentelemetryCfg(cfg)
require.NoError(t, err)
assert.True(t, otelCfg.IsEnabled(), "otel should be enabled")
assert.Equal(t, address, otelCfg.Address)
assert.Equal(t, tc.propagation, otelCfg.Propagation)
})
}
})
}
pkg/plugins/manager/loader/initializer/initializer.go
+19 -1
View File
@@ -51,6 +51,9 @@ func (i *Initializer) envVars(plugin *plugins.Plugin) []string {
hostEnv := []string{
fmt.Sprintf("GF_VERSION=%s", i.cfg.BuildVersion),
}
if plugin.Info.Version != "" {
hostEnv = append(hostEnv, fmt.Sprintf("GF_PLUGIN_VERSION=%s", plugin.Info.Version))
}
if i.license != nil {
hostEnv = append(
@@ -64,7 +67,22 @@ func (i *Initializer) envVars(plugin *plugins.Plugin) []string {
hostEnv = append(hostEnv, i.awsEnvVars()...)
hostEnv = append(hostEnv, azsettings.WriteToEnvStr(i.cfg.Azure)...)
return getPluginSettings(plugin.ID, i.cfg).asEnvVar("GF_PLUGIN", hostEnv)
// Tracing
pluginTracingEnabled := true
if v, exists := i.cfg.PluginSettings[plugin.ID]["tracing"]; exists {
pluginTracingEnabled = v != "false"
}
if i.cfg.Opentelemetry.IsEnabled() && pluginTracingEnabled {
hostEnv = append(
hostEnv,
fmt.Sprintf("GF_INSTANCE_OTLP_ADDRESS=%s", i.cfg.Opentelemetry.Address),
fmt.Sprintf("GF_INSTANCE_OTLP_PROPAGATION=%s", i.cfg.Opentelemetry.Propagation),
)
}
ev := getPluginSettings(plugin.ID, i.cfg).asEnvVar("GF_PLUGIN", hostEnv)
return ev
}
func (i *Initializer) awsEnvVars() []string {
pkg/plugins/manager/loader/initializer/initializer_test.go
+158
View File
@@ -2,9 +2,12 @@ package initializer
import (
"context"
"strings"
"testing"
"github.com/grafana/grafana/pkg/setting"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/grafana/grafana/pkg/plugins"
"github.com/grafana/grafana/pkg/plugins/backendplugin"
@@ -129,6 +132,53 @@ func TestInitializer_Initialize(t *testing.T) {
}
func TestInitializer_envVars(t *testing.T) {
t.Run("version", func(t *testing.T) {
for _, tc := range []struct {
name string
setup func(p *plugins.Plugin)
exp func(t *testing.T, i *Initializer, p *plugins.Plugin)
}{
{
name: "not provided",
setup: func(p *plugins.Plugin) {
p.Info = plugins.Info{}
},
exp: func(t *testing.T, i *Initializer, p *plugins.Plugin) {
for _, k := range i.envVars(p) {
if strings.HasPrefix("GF_PLUGIN_VERSION=", k) {
require.Fail(t, "found unexpected env var GF_PLUGIN_VERSION")
}
}
},
},
{
name: "provided",
setup: func(p *plugins.Plugin) {
p.Info = plugins.Info{Version: "0.1"}
},
exp: func(t *testing.T, i *Initializer, p *plugins.Plugin) {
require.Contains(t, i.envVars(p), "GF_PLUGIN_VERSION=0.1")
},
},
} {
t.Run(tc.name, func(t *testing.T) {
p := &plugins.Plugin{
JSONData: plugins.JSONData{
ID: "test",
Info: plugins.Info{Version: "0.1"},
},
}
tc.setup(p)
i := &Initializer{
cfg: &config.Cfg{},
log: log.NewTestLogger(),
backendProvider: &fakeBackendProvider{plugin: p},
}
tc.exp(t, i, p)
})
}
})
t.Run("backend datasource with license", func(t *testing.T) {
p := &plugins.Plugin{
JSONData: plugins.JSONData{
@@ -169,6 +219,114 @@ func TestInitializer_envVars(t *testing.T) {
})
}
func TestInitializer_tracingEnvironmentVariables(t *testing.T) {
const pluginID = "plugin_id"
p := &plugins.Plugin{
JSONData: plugins.JSONData{ID: pluginID},
}
defaultOtelCfg := config.OpentelemetryCfg{
Address: "127.0.0.1:4317",
Propagation: "",
}
expDefaultOtlp := func(t *testing.T, envVars []string) {
found := map[string]bool{
"address": false,
"version": false,
"propagation": false,
}
setFound := func(v string) {
require.False(t, found[v], "duplicate env var found")
found[v] = true
}
for _, v := range envVars {
switch v {
case "GF_VERSION=":
setFound("version")
case "GF_INSTANCE_OTLP_ADDRESS=127.0.0.1:4317":
setFound("address")
case "GF_INSTANCE_OTLP_PROPAGATION=":
setFound("propagation")
}
}
for k, f := range found {
require.Truef(t, f, "%q env var not found", k)
}
}
expNoTracing := func(t *testing.T, envVars []string) {
for _, v := range envVars {
assert.False(t, strings.HasPrefix(v, "GF_TRACING"), "should not have tracing env var")
}
}
for _, tc := range []struct {
name string
cfg *config.Cfg
exp func(t *testing.T, envVars []string)
}{
{
name: "disabled",
cfg: &config.Cfg{
Opentelemetry: config.OpentelemetryCfg{},
},
exp: expNoTracing,
},
{
name: "otlp no propagation",
cfg: &config.Cfg{
Opentelemetry: defaultOtelCfg,
},
exp: expDefaultOtlp,
},
{
name: "otlp propagation",
cfg: &config.Cfg{
Opentelemetry: config.OpentelemetryCfg{
Address: "127.0.0.1:4317",
Propagation: "w3c",
},
},
exp: func(t *testing.T, envVars []string) {
assert.Len(t, envVars, 3)
assert.Equal(t, "GF_VERSION=", envVars[0])
assert.Equal(t, "GF_INSTANCE_OTLP_ADDRESS=127.0.0.1:4317", envVars[1])
assert.Equal(t, "GF_INSTANCE_OTLP_PROPAGATION=w3c", envVars[2])
},
},
{
name: "disabled on plugin",
cfg: &config.Cfg{
Opentelemetry: defaultOtelCfg,
PluginSettings: setting.PluginSettings{
pluginID: map[string]string{"tracing": "false"},
},
},
exp: expNoTracing,
},
{
name: "not disabled on plugin with other plugin settings",
cfg: &config.Cfg{
Opentelemetry: defaultOtelCfg,
PluginSettings: map[string]map[string]string{
pluginID: {"some_other_option": "true"},
},
},
exp: expDefaultOtlp,
},
} {
t.Run(tc.name, func(t *testing.T) {
i := &Initializer{
cfg: tc.cfg,
log: log.NewTestLogger(),
}
envVars := i.envVars(p)
tc.exp(t, envVars)
})
}
}
func TestInitializer_getAWSEnvironmentVariables(t *testing.T) {
}
pkg/plugins/manager/manager_integration_test.go
+2 -1
View File
@@ -111,7 +111,8 @@ func TestIntegrationPluginManager(t *testing.T) {
coreRegistry := coreplugin.ProvideCoreRegistry(am, cw, cm, es, grap, idb, lk, otsdb, pr, tmpo, td, pg, my, ms, graf, phlare, parca)
pCfg := config.ProvideConfig(setting.ProvideProvider(cfg), cfg)
pCfg, err := config.ProvideConfig(setting.ProvideProvider(cfg), cfg)
require.NoError(t, err)
reg := registry.ProvideService()
cdn := pluginscdn.ProvideService(pCfg)