[
https://issues.apache.org/jira/browse/BEAM-3355?focusedWorklogId=88247&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-88247
]
ASF GitHub Bot logged work on BEAM-3355:
----------------------------------------
Author: ASF GitHub Bot
Created on: 05/Apr/18 22:05
Start Date: 05/Apr/18 22:05
Worklog Time Spent: 10m
Work Description: wcn3 commented on a change in pull request #4311:
[BEAM-3355] Diagnostic interfaces
URL: https://github.com/apache/beam/pull/4311#discussion_r179614042
##########
File path: sdks/go/pkg/beam/core/util/hooks/hooks.go
##########
@@ -0,0 +1,184 @@
+// Licensed to the Apache Software Foundation (ASF) under one or more
+// contributor license agreements. See the NOTICE file distributed with
+// this work for additional information regarding copyright ownership.
+// The ASF 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.
+
+// Hooks allow runners to tailor execution of the worker to allow for
customization
+// of features used by the harness.
+//
+// Examples of customization:
+//
+// gRPC integration
+// session recording
+// profile recording
+//
+// Registration methods for hooks must be called prior to calling beam.Init()
+// Request methods for hooks must be called as part of building the pipeline
+// request for the runner's Execute method.
+
+package hooks
+
+import (
+ "bytes"
+ "context"
+ "encoding/csv"
+ "encoding/json"
+ "fmt"
+ "os"
+ "strings"
+
+ "github.com/apache/beam/sdks/go/pkg/beam/core/runtime"
+ "github.com/apache/beam/sdks/go/pkg/beam/log"
+ fnpb "github.com/apache/beam/sdks/go/pkg/beam/model/fnexecution_v1"
+)
+
+var (
+ hookRegistry = make(map[string]HookFactory)
+ enabledHooks = make(map[string][]string)
+ activeHooks = make(map[string]Hook)
+)
+
+// A Hook is a set of hooks to run at various stages of executing a
+// pipelne.
+type Hook struct {
+ // Init is called once at the startup of the worker.
+ Init InitHook
+ // Req is called each time the worker handles a FnAPI instruction
request.
+ Req RequestHook
+ // Resp is called each time the worker generates a FnAPI instruction
response.
+ Resp ResponseHook
+}
+
+// InitHook is a hook that is called when the harness
+// initializes.
+type InitHook func(context.Context) error
+
+// HookFactory is a function that produces a Hook from the supplied arguments.
+type HookFactory func([]string) Hook
+
+// RegisterHook registers a Hook for the
+// supplied identifier.
+func RegisterHook(name string, h HookFactory) {
+ hookRegistry[name] = h
+}
+
+// RunInitHooks runs the init hooks.
+func RunInitHooks(ctx context.Context) error {
+ // If an init hook fails to complete, the invariants of the
+ // system are compromised and we can't run a workflow.
+ // The hooks can run in any order. They should not be
+ // interdependent or interfere with each other.
+ for _, h := range activeHooks {
+ if h.Init != nil {
+ if err := h.Init(ctx); err != nil {
+ return err
+ }
+ }
+ }
+ return nil
+}
+
+// RequestHook is called when handling a Fn API instruction.
+type RequestHook func(context.Context, *fnpb.InstructionRequest) error
+
+// RunRequestHooks runs the hooks that handle a FnAPI request.
+func RunRequestHooks(ctx context.Context, req *fnpb.InstructionRequest) {
+ // The request hooks should not modify the request.
+ // TODO(wcn): pass the request by value to enforce? That's a perf hit.
+ // I'd rather trust users to do the right thing.
+ for n, h := range activeHooks {
+ if h.Req != nil {
+ if err := h.Req(ctx, req); err != nil {
+ log.Infof(ctx, "request hook %s failed: %v", n,
err)
+ }
+ }
+ }
+}
+
+// ResponseHook is called when sending a Fn API instruction response.
+type ResponseHook func(context.Context, *fnpb.InstructionRequest,
*fnpb.InstructionResponse) error
+
+// RunResponseHooks runs the hooks that handle a FnAPI response.
+func RunResponseHooks(ctx context.Context, req *fnpb.InstructionRequest, resp
*fnpb.InstructionResponse) {
+ for n, h := range activeHooks {
+ if h.Resp != nil {
+ if err := h.Resp(ctx, req, resp); err != nil {
+ log.Infof(ctx, "response hook %s failed: %v",
n, err)
+ }
+ }
+ }
+}
+
+// SerializeHooks serializes the activated hooks and their configuration into
a JSON string
+// that can be deserialized later by the runner.
+func SerializeHooks() {
+ data, err := json.Marshal(enabledHooks)
+ if err != nil {
+ // Shouldn't happen, since all the data is strings.
+ panic(fmt.Sprintf("Couldn't serialize hooks: %v", err))
+ }
+ fmt.Fprintf(os.Stderr, "SerializeHooks: %q", string(data))
+ runtime.GlobalOptions.Set("hooks", string(data))
+}
+
+// DeserializeHooks extracts the hook configuration information from the
options and configures
+// the hooks with the supplied options.
+func DeserializeHooks() {
+ cfg := runtime.GlobalOptions.Get("hooks")
+ if err := json.Unmarshal([]byte(cfg), &enabledHooks); err != nil {
+ // Shouldn't happen
+ panic(fmt.Sprintf("DeserializeHooks failed on input %q: %v",
cfg, err))
+ }
+
+ for h, opts := range enabledHooks {
+ activeHooks[h] = hookRegistry[h](opts)
+ }
+}
+
+// EnableHook enables the hook to be run for the pipline. It will be
+// receive the supplied args when the pipeline executes. It is safe
+// to enable the same hook with different options, as this is necessary
+// if a hook wants to compose behavior.
Review comment:
Reworded. It's the last call to EnableHook that wins.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
Issue Time Tracking
-------------------
Worklog Id: (was: 88247)
Time Spent: 5h 20m (was: 5h 10m)
> Make Go SDK runtime harness hooks pluggable
> -------------------------------------------
>
> Key: BEAM-3355
> URL: https://issues.apache.org/jira/browse/BEAM-3355
> Project: Beam
> Issue Type: Improvement
> Components: sdk-go
> Reporter: Henning Rohde
> Assignee: Bill Neubauer
> Priority: Minor
> Time Spent: 5h 20m
> Remaining Estimate: 0h
>
> We currently hardcode cpu profiling and session recording in the harness. We
> should make it pluggable instead.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
