Added basic plugin system to customize telemetry. #86
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rgrandl
reviewed
Nov 3, 2023
internal/impl/babysitter.go
Outdated
| return fmt.Errorf("Babysitter.Serve: listen on port %d: %w", prometheusPort, err) | ||
| group, ctx := errgroup.WithContext(b.ctx) | ||
|
|
||
| if b.opts.HandleMetrics == nil { |
There was a problem hiding this comment.
Logs: we print them with pretty printer if there is no custom way to manipulate them
Traces: we don't do anything if no custom way to manipulate them
Metrics: if no custom way to manipulate them, we export them to an http server that we will be running (in prometheus format)
Could we:
- Create an examples or plugins directory under weaver-kube and add the jaeger example?
- Also add an example for metrics integration with Prometheus in the same directory? The http server code that is here can go there. I think we shouldn't do anything by default (same as for traces).
There was a problem hiding this comment.
Changed to not export metrics by default. I'll add examples in a future PR!
| "github.com/ServiceWeaver/weaver-kube/internal/impl" | ||
| "github.com/ServiceWeaver/weaver/runtime/tool" | ||
| ) | ||
|
|
There was a problem hiding this comment.
can we add a comment here?
mwhittaker
force-pushed
the
whats_up_docker
branch
from
024f4ad
to
4027b71
Compare
This PR introduces a very basic plugin system that allows developers to
customize how `weaver-kube` manages logs, metrics, and traces. For
example, consider the following `foo/main.go`:
```
// This is file foo/main.go.
package main
import ...
func main() {
plugins := tool.Plugins{
HandleLogEntry: func(context.Context, *protos.LogEntry) error {
...
},
HandleTraceSpans: func(context.Context, []trace.ReadOnlySpan) error {
...
},
HandleMetrics: func(context.Context, []*metrics.MetricSnapshot) error {
...
},
}
tool.Run("foo", plugins)
}
```
We can build this file into an executable `foo` that behaves the same as
`weaver-kube`, but uses the provided plugins:
```shell
$ foo --help
Deploy and manage Service Weaver programs.
Usage:
foo <command> ...
Available Commands:
deploy Deploy a Service Weaver app
help Print help for a sub-command
version Show foo version
Flags:
-h, --help Print this help message.
Use "foo help <command>" for more information about a command.
```
See https://github.com/mwhittaker/jeagar for a complete example.
In the long term, we'll replace this basic plugin mechanism with
something more general. This PR allows customers to onboard to Service
Weaver in the short term.
mwhittaker
commented
Nov 6, 2023
| "github.com/ServiceWeaver/weaver-kube/internal/impl" | ||
| "github.com/ServiceWeaver/weaver/runtime/tool" | ||
| ) | ||
|
|
internal/impl/babysitter.go
Outdated
| return fmt.Errorf("Babysitter.Serve: listen on port %d: %w", prometheusPort, err) | ||
| group, ctx := errgroup.WithContext(b.ctx) | ||
|
|
||
| if b.opts.HandleMetrics == nil { |
There was a problem hiding this comment.
Changed to not export metrics by default. I'll add examples in a future PR!
rgrandl
approved these changes
Nov 6, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR introduces a very basic plugin system that allows developers to customize how
weaver-kubemanages logs, metrics, and traces. For example, consider the followingfoo/main.go:We can build this file into an executable
foothat behaves the same asweaver-kube, but uses the provided plugins:See https://github.com/mwhittaker/jeagar for a complete example.
In the long term, we'll replace this basic plugin mechanism with something more general. This PR allows customers to onboard to Service Weaver in the short term.