You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@skywalking.apache.org by GitBox <gi...@apache.org> on 2020/11/30 06:06:54 UTC
[GitHub] [skywalking-satellite] kezhenxu94 commented on a change in pull request #5: Add API && Plugin framework registry
kezhenxu94 commented on a change in pull request #5:
URL: https://github.com/apache/skywalking-satellite/pull/5#discussion_r532362284
##########
File path: internal/pkg/api/event.go
##########
@@ -0,0 +1,103 @@
+// 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
+ ProflingEvent
Review comment:
typo
```suggestion
ProfilingEvent
```
##########
File path: internal/pkg/api/event.go
##########
@@ -0,0 +1,103 @@
+// 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
+ ProflingEvent
+ SegmentEvent
+ ManagementEvent
+ MeterEvent
+ LogEvent
+)
+
+type EventType int32
+
+// Event that implement this interface would be allowed to transmit in the Satellite.
+type Event interface {
+ // Name is a identify to distinguish different events.
+ Name() string
+
+ // Meta is a pair of key and value to record meta data, such as labels.
+ Meta() map[string]string
+
+ // Data returns the wrappered data.
+ Data() interface{}
+
+ // Time returns the event time.
+ Time() time.Time
+
+ // Type returns the event type.
+ Type() EventType
+
+ // Remote means is a output event when returns true.
+ Remote() bool
+}
+
+// SerializationEvent is used in Collector to bridge Queue.
+type SerializationEvent interface {
Review comment:
`SerializationEvent` -> `SerializableEvent`?
##########
File path: internal/pkg/api/event.go
##########
@@ -0,0 +1,103 @@
+// 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
+ ProflingEvent
+ SegmentEvent
+ ManagementEvent
+ MeterEvent
+ LogEvent
+)
+
+type EventType int32
+
+// Event that implement this interface would be allowed to transmit in the Satellite.
+type Event interface {
+ // Name is a identify to distinguish different events.
Review comment:
```suggestion
// Name is an identifier to distinguish different events.
```
##########
File path: internal/pkg/api/event.go
##########
@@ -0,0 +1,103 @@
+// 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
+ ProflingEvent
+ SegmentEvent
+ ManagementEvent
+ MeterEvent
+ LogEvent
+)
+
+type EventType int32
+
+// Event that implement this interface would be allowed to transmit in the Satellite.
+type Event interface {
+ // Name is a identify to distinguish different events.
+ Name() string
+
+ // Meta is a pair of key and value to record meta data, such as labels.
+ Meta() map[string]string
+
+ // Data returns the wrappered data.
Review comment:
```suggestion
// Data returns the wrapped data.
```
##########
File path: internal/pkg/api/event.go
##########
@@ -0,0 +1,103 @@
+// 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
+ ProflingEvent
+ SegmentEvent
+ ManagementEvent
+ MeterEvent
+ LogEvent
+)
+
+type EventType int32
+
+// Event that implement this interface would be allowed to transmit in the Satellite.
+type Event interface {
+ // Name is a identify to distinguish different events.
+ Name() string
Review comment:
If it's an identifier, maybe name it as `ID` is more semantic?
----------------------------------------------------------------
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