/
watcher.go
54 lines (48 loc) · 1.89 KB
/
watcher.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
// Licensed to Elasticsearch B.V. under one or more contributor
// license agreements. See the NOTICE file distributed with
// this work for additional information regarding copyright
// ownership. Elasticsearch B.V. licenses this file to you 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 apmconfig // import "go.elastic.co/apm/v2/apmconfig"
import (
"context"
)
// Watcher provides an interface for watching config changes.
type Watcher interface {
// WatchConfig subscribes to changes to configuration for the agent,
// which must match the given ConfigSelector.
//
// If the watcher experiences an unexpected error fetching config,
// it will surface this in a Change with the Err field set.
//
// If the provided context is cancelled, or the watcher experiences
// a fatal condition, the returned channel will be closed.
WatchConfig(context.Context, WatchParams) <-chan Change
}
// WatchParams holds parameters for watching for config changes.
type WatchParams struct {
// Service holds the name and optionally environment name used
// for filtering the config to watch.
Service struct {
Name string
Environment string
}
}
// Change holds an agent configuration change: an error or the new config attributes.
type Change struct {
// Err holds an error that occurred while querying agent config.
Err error
// Attrs holds the agent's configuration. May be empty.
Attrs map[string]string
}