[GitHub] [skywalking-satellite] surlymo commented on a change in pull request #5: Add API && Plugin framework registry

[GitBox <gi...@apache.org>]

surlymo commented on a change in pull request #5:
URL: https://github.com/apache/skywalking-satellite/pull/5#discussion_r533387287



##########
File path: internal/pkg/api/forwarder.go
##########
@@ -0,0 +1,42 @@
+// Licensed to 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. Apache Software Foundation (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.
+
+package api
+
+//   Init()     Initiating stage: Init plugin by config
+//    ||
+//    \/
+//   Prepare()   Preparing stage: Prepare the Forwarder, such as get remote client.
+//    ||
+//    \/
+//   Forward()  Running stage: Forward the batch events
+//    ||
+//    \/
+//   Close()    Closing stage: Close the Collector, such as close connection with SkyWalking javaagent.
+
+// Forwarder is a plugin interface, that defines new forwarders.
+type Forwarder interface {
+	Initializer
+	Preparer
+	Closer
+
+	// Forward the batch events to the external services, such as Kafka MQ and SkyWalking OAP cluster.
+	Forward(batch BatchEvents)
+
+	// ForwardType returns the supporting event type that could be forwarded.
+	ForwardType()

Review comment:
       where is return type?

##########
File path: internal/satellite/event/struectured_event.go
##########
@@ -0,0 +1,79 @@
+// Licensed to Apache Software Foundation (ASF) under one or more contributor

Review comment:
       typo file name

##########
File path: internal/pkg/api/event.go
##########
@@ -0,0 +1,95 @@
+// Licensed to 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. Apache Software Foundation (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.
+
+package api
+
+import (
+	"fmt"
+	"time"
+)
+
+// The event type.
+const (
+	// Mapping to the type supported by SkyWalking OAP.
+	_ EventType = iota
+	MetricsEvent
+	ProfilingEvent
+	SegmentEvent
+	ManagementEvent
+	MeterEvent
+	LogEvent
+)
+
+type EventType int32
+
+// Event that implement this interface would be allowed to transmit in the Satellite.
+type Event interface {
+	// Name returns the event name.
+	Name() string
+
+	// Meta is a pair of key and value to record meta data, such as labels.
+	Meta() map[string]string
+
+	// Data returns the wrapped data.
+	Data() interface{}
+
+	// Time returns the event time.
+	Time() time.Time
+
+	// Type is to distinguish different events.
+	Type() EventType

Review comment:
       where is id using as offset？




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org