add a ping service (#372)

* add a ping service

* add examples and public api file

* add minecraft server ping

ping/.gitignore

@@ -0,0 +1,2 @@
+
+ping

ping/Dockerfile

@@ -0,0 +1,3 @@
+FROM alpine
+ADD ping /ping
+ENTRYPOINT [ "/ping" ]

ping/Makefile

@@ -0,0 +1,28 @@
+
+GOPATH:=$(shell go env GOPATH)
+.PHONY: init
+init:
+	go get -u github.com/golang/protobuf/proto
+	go get -u github.com/golang/protobuf/protoc-gen-go
+	go get github.com/micro/micro/v3/cmd/protoc-gen-micro
+	go get github.com/micro/micro/v3/cmd/protoc-gen-openapi
+
+.PHONY: api
+api:
+	protoc --openapi_out=. --proto_path=. proto/ping.proto
+
+.PHONY: proto
+proto:
+	protoc --proto_path=. --micro_out=. --go_out=:. proto/ping.proto
+	
+.PHONY: build
+build:
+	go build -o ping *.go
+
+.PHONY: test
+test:
+	go test -v ./... -cover
+
+.PHONY: docker
+docker:
+	docker build . -t ping:latest

ping/README.md

@@ -0,0 +1,7 @@
+Ping any URL
+
+# Ping Service
+
+Use ping to monitor services, check uptime and availability of any HTTP URL or TCP endpoint. 
+
+

ping/examples.json

@@ -0,0 +1,36 @@
+{
+    "ip": [{
+        "title": "Ping an ip",
+        "description": "Ping an ip address to get the latency",
+        "run_check": false,
+        "request": {
+            "google.com"
+        },
+        "response": {
+            "status": "OK"
+        }
+    }],
+    "tcp": [{
+        "title": "Dial a tcp address",
+        "description": "Dial a tcp address",
+        "run_check": false,
+        "request": {
+            "google.com:80"
+        },
+        "response": {
+            "status": "OK"
+        }
+    }],
+    "http": [{
+        "title": "Check a url",
+        "description": "Check a url endpoint",
+        "run_check": false,
+        "request": {
+            "google.com"
+        },
+        "response": {
+            "status": "200 OK",
+            "code": 200
+        }
+    }]
+}

ping/generate.go

@@ -0,0 +1,3 @@
+package main
+
+//go:generate make proto

ping/handler/ping.go

@@ -0,0 +1,120 @@
+package handler
+
+import (
+	"bufio"
+	"context"
+	"fmt"
+	"io/ioutil"
+	"net"
+	"net/http"
+	"net/url"
+
+	"github.com/go-ping/ping"
+	"github.com/micro/micro/v3/service/errors"
+	"github.com/micro/micro/v3/service/logger"
+	pb "github.com/micro/services/ping/proto"
+)
+
+type Ping struct{}
+
+func (p *Ping) Ip(ctx context.Context, req *pb.IpRequest, rsp *pb.IpResponse) error {
+	if len(req.Address) == 0 {
+		return errors.BadRequest("ping.ip", "missing address")
+	}
+
+	pinger, err := ping.NewPinger(req.Address)
+	if err != nil {
+		rsp.Status = err.Error()
+		return nil
+	}
+
+	pinger.Count = 4
+	pinger.SetPrivileged(true)
+	err = pinger.Run() // Blocks until finished.
+	if err != nil {
+		rsp.Status = err.Error()
+		return nil
+	}
+
+	pinger.Stop()
+	stats := pinger.Statistics()
+
+	rsp.Status = "OK"
+	rsp.Latency = fmt.Sprintf("%v", stats.AvgRtt)
+
+	return nil
+}
+
+func (p *Ping) Url(ctx context.Context, req *pb.UrlRequest, rsp *pb.UrlResponse) error {
+	if len(req.Address) == 0 {
+		return errors.BadRequest("ping.url", "missing address")
+	}
+
+	u, err := url.Parse(req.Address)
+	if err != nil {
+		return errors.BadRequest("ping.url", "failed to parse url: %v", err)
+	}
+
+	if u.Scheme == "" {
+		u.Scheme = "https"
+	}
+
+	if req.Method == "" {
+		req.Method = "GET"
+	}
+
+	logger.Infof("Calling %s %s", req.Method, u.String())
+
+	hreq, err := http.NewRequest(req.Method, u.String(), nil)
+	if err != nil {
+		return errors.InternalServerError("ping.url", "failed to make request: %v", err)
+	}
+
+	resp, err := http.DefaultClient.Do(hreq)
+	if err != nil {
+		return errors.InternalServerError("ping.url", "failed to call %v: %v", req.Address, err)
+	}
+	defer resp.Body.Close()
+
+	// read body
+	ioutil.ReadAll(resp.Body)
+	// set status
+	rsp.Status = resp.Status
+	rsp.Code = int32(resp.StatusCode)
+
+	return nil
+}
+
+func (p *Ping) Tcp(ctx context.Context, req *pb.TcpRequest, rsp *pb.TcpResponse) error {
+	if len(req.Address) == 0 {
+		return errors.BadRequest("ping.tcp", "missing address")
+	}
+
+	c, err := net.Dial("tcp", req.Address)
+	if err != nil {
+		rsp.Status = err.Error()
+		return nil
+	}
+	defer c.Close()
+
+	// if no data being sent then just return
+	if len(req.Data) == 0 {
+		rsp.Status = "OK"
+		return nil
+	}
+
+	// write data to the connection
+	fmt.Fprint(c, req.Data)
+
+	// wait for a response
+	data, err := bufio.NewReader(c).ReadString('\n')
+	if err != nil {
+		rsp.Status = err.Error()
+		return nil
+	}
+
+	rsp.Status = "OK"
+	rsp.Data = data
+
+	return nil
+}

ping/main.go

@@ -0,0 +1,24 @@
+package main
+
+import (
+	"github.com/micro/micro/v3/service"
+	"github.com/micro/micro/v3/service/logger"
+	"github.com/micro/services/ping/handler"
+	pb "github.com/micro/services/ping/proto"
+)
+
+func main() {
+	// Create service
+	srv := service.New(
+		service.Name("ping"),
+		service.Version("latest"),
+	)
+
+	// Register handler
+	pb.RegisterPingHandler(srv.Server(), new(handler.Ping))
+
+	// Run service
+	if err := srv.Run(); err != nil {
+		logger.Fatal(err)
+	}
+}

ping/micro.mu

@@ -0,0 +1 @@
+service ping

ping/proto/ping.pb.go

@@ -0,0 +1,530 @@
+// Code generated by protoc-gen-go. DO NOT EDIT.
+// versions:
+// 	protoc-gen-go v1.27.1
+// 	protoc        v3.15.6
+// source: proto/ping.proto
+
+package ping
+
+import (
+	protoreflect "google.golang.org/protobuf/reflect/protoreflect"
+	protoimpl "google.golang.org/protobuf/runtime/protoimpl"
+	reflect "reflect"
+	sync "sync"
+)
+
+const (
+	// Verify that this generated code is sufficiently up-to-date.
+	_ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion)
+	// Verify that runtime/protoimpl is sufficiently up-to-date.
+	_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
+)
+
+// Ping an IP address
+type IpRequest struct {
+	state         protoimpl.MessageState
+	sizeCache     protoimpl.SizeCache
+	unknownFields protoimpl.UnknownFields
+
+	// address to ping
+	Address string `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty"`
+}
+
+func (x *IpRequest) Reset() {
+	*x = IpRequest{}
+	if protoimpl.UnsafeEnabled {
+		mi := &file_proto_ping_proto_msgTypes[0]
+		ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+		ms.StoreMessageInfo(mi)
+	}
+}
+
+func (x *IpRequest) String() string {
+	return protoimpl.X.MessageStringOf(x)
+}
+
+func (*IpRequest) ProtoMessage() {}
+
+func (x *IpRequest) ProtoReflect() protoreflect.Message {
+	mi := &file_proto_ping_proto_msgTypes[0]
+	if protoimpl.UnsafeEnabled && x != nil {
+		ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+		if ms.LoadMessageInfo() == nil {
+			ms.StoreMessageInfo(mi)
+		}
+		return ms
+	}
+	return mi.MessageOf(x)
+}
+
+// Deprecated: Use IpRequest.ProtoReflect.Descriptor instead.
+func (*IpRequest) Descriptor() ([]byte, []int) {
+	return file_proto_ping_proto_rawDescGZIP(), []int{0}
+}
+
+func (x *IpRequest) GetAddress() string {
+	if x != nil {
+		return x.Address
+	}
+	return ""
+}
+
+type IpResponse struct {
+	state         protoimpl.MessageState
+	sizeCache     protoimpl.SizeCache
+	unknownFields protoimpl.UnknownFields
+
+	// response status
+	Status string `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
+	// average latency e.g 10ms
+	Latency string `protobuf:"bytes,2,opt,name=latency,proto3" json:"latency,omitempty"`
+}
+
+func (x *IpResponse) Reset() {
+	*x = IpResponse{}
+	if protoimpl.UnsafeEnabled {
+		mi := &file_proto_ping_proto_msgTypes[1]
+		ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+		ms.StoreMessageInfo(mi)
+	}
+}
+
+func (x *IpResponse) String() string {
+	return protoimpl.X.MessageStringOf(x)
+}
+
+func (*IpResponse) ProtoMessage() {}
+
+func (x *IpResponse) ProtoReflect() protoreflect.Message {
+	mi := &file_proto_ping_proto_msgTypes[1]
+	if protoimpl.UnsafeEnabled && x != nil {
+		ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+		if ms.LoadMessageInfo() == nil {
+			ms.StoreMessageInfo(mi)
+		}
+		return ms
+	}
+	return mi.MessageOf(x)
+}
+
+// Deprecated: Use IpResponse.ProtoReflect.Descriptor instead.
+func (*IpResponse) Descriptor() ([]byte, []int) {
+	return file_proto_ping_proto_rawDescGZIP(), []int{1}
+}
+
+func (x *IpResponse) GetStatus() string {
+	if x != nil {
+		return x.Status
+	}
+	return ""
+}
+
+func (x *IpResponse) GetLatency() string {
+	if x != nil {
+		return x.Latency
+	}
+	return ""
+}
+
+// Ping a HTTP URL
+type UrlRequest struct {
+	state         protoimpl.MessageState
+	sizeCache     protoimpl.SizeCache
+	unknownFields protoimpl.UnknownFields
+
+	// address to use
+	Address string `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty"`
+	// method of the call
+	Method string `protobuf:"bytes,2,opt,name=method,proto3" json:"method,omitempty"`
+}
+
+func (x *UrlRequest) Reset() {
+	*x = UrlRequest{}
+	if protoimpl.UnsafeEnabled {
+		mi := &file_proto_ping_proto_msgTypes[2]
+		ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+		ms.StoreMessageInfo(mi)
+	}
+}
+
+func (x *UrlRequest) String() string {
+	return protoimpl.X.MessageStringOf(x)
+}
+
+func (*UrlRequest) ProtoMessage() {}
+
+func (x *UrlRequest) ProtoReflect() protoreflect.Message {
+	mi := &file_proto_ping_proto_msgTypes[2]
+	if protoimpl.UnsafeEnabled && x != nil {
+		ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+		if ms.LoadMessageInfo() == nil {
+			ms.StoreMessageInfo(mi)
+		}
+		return ms
+	}
+	return mi.MessageOf(x)
+}
+
+// Deprecated: Use UrlRequest.ProtoReflect.Descriptor instead.
+func (*UrlRequest) Descriptor() ([]byte, []int) {
+	return file_proto_ping_proto_rawDescGZIP(), []int{2}
+}
+
+func (x *UrlRequest) GetAddress() string {
+	if x != nil {
+		return x.Address
+	}
+	return ""
+}
+
+func (x *UrlRequest) GetMethod() string {
+	if x != nil {
+		return x.Method
+	}
+	return ""
+}
+
+type UrlResponse struct {
+	state         protoimpl.MessageState
+	sizeCache     protoimpl.SizeCache
+	unknownFields protoimpl.UnknownFields
+
+	// the response status
+	Status string `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
+	// the response code
+	Code int32 `protobuf:"varint,2,opt,name=code,proto3" json:"code,omitempty"`
+}
+
+func (x *UrlResponse) Reset() {
+	*x = UrlResponse{}
+	if protoimpl.UnsafeEnabled {
+		mi := &file_proto_ping_proto_msgTypes[3]
+		ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+		ms.StoreMessageInfo(mi)
+	}
+}
+
+func (x *UrlResponse) String() string {
+	return protoimpl.X.MessageStringOf(x)
+}
+
+func (*UrlResponse) ProtoMessage() {}
+
+func (x *UrlResponse) ProtoReflect() protoreflect.Message {
+	mi := &file_proto_ping_proto_msgTypes[3]
+	if protoimpl.UnsafeEnabled && x != nil {
+		ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+		if ms.LoadMessageInfo() == nil {
+			ms.StoreMessageInfo(mi)
+		}
+		return ms
+	}
+	return mi.MessageOf(x)
+}
+
+// Deprecated: Use UrlResponse.ProtoReflect.Descriptor instead.
+func (*UrlResponse) Descriptor() ([]byte, []int) {
+	return file_proto_ping_proto_rawDescGZIP(), []int{3}
+}
+
+func (x *UrlResponse) GetStatus() string {
+	if x != nil {
+		return x.Status
+	}
+	return ""
+}
+
+func (x *UrlResponse) GetCode() int32 {
+	if x != nil {
+		return x.Code
+	}
+	return 0
+}
+
+// Ping a TCP port is open
+type TcpRequest struct {
+	state         protoimpl.MessageState
+	sizeCache     protoimpl.SizeCache
+	unknownFields protoimpl.UnknownFields
+
+	// address to dial
+	Address string `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty"`
+	// optional data to send
+	Data string `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
+}
+
+func (x *TcpRequest) Reset() {
+	*x = TcpRequest{}
+	if protoimpl.UnsafeEnabled {
+		mi := &file_proto_ping_proto_msgTypes[4]
+		ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+		ms.StoreMessageInfo(mi)
+	}
+}
+
+func (x *TcpRequest) String() string {
+	return protoimpl.X.MessageStringOf(x)
+}
+
+func (*TcpRequest) ProtoMessage() {}
+
+func (x *TcpRequest) ProtoReflect() protoreflect.Message {
+	mi := &file_proto_ping_proto_msgTypes[4]
+	if protoimpl.UnsafeEnabled && x != nil {
+		ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+		if ms.LoadMessageInfo() == nil {
+			ms.StoreMessageInfo(mi)
+		}
+		return ms
+	}
+	return mi.MessageOf(x)
+}
+
+// Deprecated: Use TcpRequest.ProtoReflect.Descriptor instead.
+func (*TcpRequest) Descriptor() ([]byte, []int) {
+	return file_proto_ping_proto_rawDescGZIP(), []int{4}
+}
+
+func (x *TcpRequest) GetAddress() string {
+	if x != nil {
+		return x.Address
+	}
+	return ""
+}
+
+func (x *TcpRequest) GetData() string {
+	if x != nil {
+		return x.Data
+	}
+	return ""
+}
+
+type TcpResponse struct {
+	state         protoimpl.MessageState
+	sizeCache     protoimpl.SizeCache
+	unknownFields protoimpl.UnknownFields
+
+	// response status
+	Status string `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
+	// response data if any
+	Data string `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
+}
+
+func (x *TcpResponse) Reset() {
+	*x = TcpResponse{}
+	if protoimpl.UnsafeEnabled {
+		mi := &file_proto_ping_proto_msgTypes[5]
+		ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+		ms.StoreMessageInfo(mi)
+	}
+}
+
+func (x *TcpResponse) String() string {
+	return protoimpl.X.MessageStringOf(x)
+}
+
+func (*TcpResponse) ProtoMessage() {}
+
+func (x *TcpResponse) ProtoReflect() protoreflect.Message {
+	mi := &file_proto_ping_proto_msgTypes[5]
+	if protoimpl.UnsafeEnabled && x != nil {
+		ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+		if ms.LoadMessageInfo() == nil {
+			ms.StoreMessageInfo(mi)
+		}
+		return ms
+	}
+	return mi.MessageOf(x)
+}
+
+// Deprecated: Use TcpResponse.ProtoReflect.Descriptor instead.
+func (*TcpResponse) Descriptor() ([]byte, []int) {
+	return file_proto_ping_proto_rawDescGZIP(), []int{5}
+}
+
+func (x *TcpResponse) GetStatus() string {
+	if x != nil {
+		return x.Status
+	}
+	return ""
+}
+
+func (x *TcpResponse) GetData() string {
+	if x != nil {
+		return x.Data
+	}
+	return ""
+}
+
+var File_proto_ping_proto protoreflect.FileDescriptor
+
+var file_proto_ping_proto_rawDesc = []byte{
+	0x0a, 0x10, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x2f, 0x70, 0x69, 0x6e, 0x67, 0x2e, 0x70, 0x72, 0x6f,
+	0x74, 0x6f, 0x12, 0x04, 0x70, 0x69, 0x6e, 0x67, 0x22, 0x25, 0x0a, 0x09, 0x49, 0x70, 0x52, 0x65,
+	0x71, 0x75, 0x65, 0x73, 0x74, 0x12, 0x18, 0x0a, 0x07, 0x61, 0x64, 0x64, 0x72, 0x65, 0x73, 0x73,
+	0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x07, 0x61, 0x64, 0x64, 0x72, 0x65, 0x73, 0x73, 0x22,
+	0x3e, 0x0a, 0x0a, 0x49, 0x70, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x16, 0x0a,
+	0x06, 0x73, 0x74, 0x61, 0x74, 0x75, 0x73, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x06, 0x73,
+	0x74, 0x61, 0x74, 0x75, 0x73, 0x12, 0x18, 0x0a, 0x07, 0x6c, 0x61, 0x74, 0x65, 0x6e, 0x63, 0x79,
+	0x18, 0x02, 0x20, 0x01, 0x28, 0x09, 0x52, 0x07, 0x6c, 0x61, 0x74, 0x65, 0x6e, 0x63, 0x79, 0x22,
+	0x3e, 0x0a, 0x0a, 0x55, 0x72, 0x6c, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x12, 0x18, 0x0a,
+	0x07, 0x61, 0x64, 0x64, 0x72, 0x65, 0x73, 0x73, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x07,
+	0x61, 0x64, 0x64, 0x72, 0x65, 0x73, 0x73, 0x12, 0x16, 0x0a, 0x06, 0x6d, 0x65, 0x74, 0x68, 0x6f,
+	0x64, 0x18, 0x02, 0x20, 0x01, 0x28, 0x09, 0x52, 0x06, 0x6d, 0x65, 0x74, 0x68, 0x6f, 0x64, 0x22,
+	0x39, 0x0a, 0x0b, 0x55, 0x72, 0x6c, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x16,
+	0x0a, 0x06, 0x73, 0x74, 0x61, 0x74, 0x75, 0x73, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x06,
+	0x73, 0x74, 0x61, 0x74, 0x75, 0x73, 0x12, 0x12, 0x0a, 0x04, 0x63, 0x6f, 0x64, 0x65, 0x18, 0x02,
+	0x20, 0x01, 0x28, 0x05, 0x52, 0x04, 0x63, 0x6f, 0x64, 0x65, 0x22, 0x3a, 0x0a, 0x0a, 0x54, 0x63,
+	0x70, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x12, 0x18, 0x0a, 0x07, 0x61, 0x64, 0x64, 0x72,
+	0x65, 0x73, 0x73, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x07, 0x61, 0x64, 0x64, 0x72, 0x65,
+	0x73, 0x73, 0x12, 0x12, 0x0a, 0x04, 0x64, 0x61, 0x74, 0x61, 0x18, 0x02, 0x20, 0x01, 0x28, 0x09,
+	0x52, 0x04, 0x64, 0x61, 0x74, 0x61, 0x22, 0x39, 0x0a, 0x0b, 0x54, 0x63, 0x70, 0x52, 0x65, 0x73,
+	0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x16, 0x0a, 0x06, 0x73, 0x74, 0x61, 0x74, 0x75, 0x73, 0x18,
+	0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x06, 0x73, 0x74, 0x61, 0x74, 0x75, 0x73, 0x12, 0x12, 0x0a,
+	0x04, 0x64, 0x61, 0x74, 0x61, 0x18, 0x02, 0x20, 0x01, 0x28, 0x09, 0x52, 0x04, 0x64, 0x61, 0x74,
+	0x61, 0x32, 0x8d, 0x01, 0x0a, 0x04, 0x50, 0x69, 0x6e, 0x67, 0x12, 0x29, 0x0a, 0x02, 0x49, 0x70,
+	0x12, 0x0f, 0x2e, 0x70, 0x69, 0x6e, 0x67, 0x2e, 0x49, 0x70, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73,
+	0x74, 0x1a, 0x10, 0x2e, 0x70, 0x69, 0x6e, 0x67, 0x2e, 0x49, 0x70, 0x52, 0x65, 0x73, 0x70, 0x6f,
+	0x6e, 0x73, 0x65, 0x22, 0x00, 0x12, 0x2c, 0x0a, 0x03, 0x55, 0x72, 0x6c, 0x12, 0x10, 0x2e, 0x70,
+	0x69, 0x6e, 0x67, 0x2e, 0x55, 0x72, 0x6c, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x11,
+	0x2e, 0x70, 0x69, 0x6e, 0x67, 0x2e, 0x55, 0x72, 0x6c, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73,
+	0x65, 0x22, 0x00, 0x12, 0x2c, 0x0a, 0x03, 0x54, 0x63, 0x70, 0x12, 0x10, 0x2e, 0x70, 0x69, 0x6e,
+	0x67, 0x2e, 0x54, 0x63, 0x70, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x11, 0x2e, 0x70,
+	0x69, 0x6e, 0x67, 0x2e, 0x54, 0x63, 0x70, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x22,
+	0x00, 0x42, 0x0e, 0x5a, 0x0c, 0x2e, 0x2f, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x3b, 0x70, 0x69, 0x6e,
+	0x67, 0x62, 0x06, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x33,
+}
+
+var (
+	file_proto_ping_proto_rawDescOnce sync.Once
+	file_proto_ping_proto_rawDescData = file_proto_ping_proto_rawDesc
+)
+
+func file_proto_ping_proto_rawDescGZIP() []byte {
+	file_proto_ping_proto_rawDescOnce.Do(func() {
+		file_proto_ping_proto_rawDescData = protoimpl.X.CompressGZIP(file_proto_ping_proto_rawDescData)
+	})
+	return file_proto_ping_proto_rawDescData
+}
+
+var file_proto_ping_proto_msgTypes = make([]protoimpl.MessageInfo, 6)
+var file_proto_ping_proto_goTypes = []interface{}{
+	(*IpRequest)(nil),   // 0: ping.IpRequest
+	(*IpResponse)(nil),  // 1: ping.IpResponse
+	(*UrlRequest)(nil),  // 2: ping.UrlRequest
+	(*UrlResponse)(nil), // 3: ping.UrlResponse
+	(*TcpRequest)(nil),  // 4: ping.TcpRequest
+	(*TcpResponse)(nil), // 5: ping.TcpResponse
+}
+var file_proto_ping_proto_depIdxs = []int32{
+	0, // 0: ping.Ping.Ip:input_type -> ping.IpRequest
+	2, // 1: ping.Ping.Url:input_type -> ping.UrlRequest
+	4, // 2: ping.Ping.Tcp:input_type -> ping.TcpRequest
+	1, // 3: ping.Ping.Ip:output_type -> ping.IpResponse
+	3, // 4: ping.Ping.Url:output_type -> ping.UrlResponse
+	5, // 5: ping.Ping.Tcp:output_type -> ping.TcpResponse
+	3, // [3:6] is the sub-list for method output_type
+	0, // [0:3] is the sub-list for method input_type
+	0, // [0:0] is the sub-list for extension type_name
+	0, // [0:0] is the sub-list for extension extendee
+	0, // [0:0] is the sub-list for field type_name
+}
+
+func init() { file_proto_ping_proto_init() }
+func file_proto_ping_proto_init() {
+	if File_proto_ping_proto != nil {
+		return
+	}
+	if !protoimpl.UnsafeEnabled {
+		file_proto_ping_proto_msgTypes[0].Exporter = func(v interface{}, i int) interface{} {
+			switch v := v.(*IpRequest); i {
+			case 0:
+				return &v.state
+			case 1:
+				return &v.sizeCache
+			case 2:
+				return &v.unknownFields
+			default:
+				return nil
+			}
+		}
+		file_proto_ping_proto_msgTypes[1].Exporter = func(v interface{}, i int) interface{} {
+			switch v := v.(*IpResponse); i {
+			case 0:
+				return &v.state
+			case 1:
+				return &v.sizeCache
+			case 2:
+				return &v.unknownFields
+			default:
+				return nil
+			}
+		}
+		file_proto_ping_proto_msgTypes[2].Exporter = func(v interface{}, i int) interface{} {
+			switch v := v.(*UrlRequest); i {
+			case 0:
+				return &v.state
+			case 1:
+				return &v.sizeCache
+			case 2:
+				return &v.unknownFields
+			default:
+				return nil
+			}
+		}
+		file_proto_ping_proto_msgTypes[3].Exporter = func(v interface{}, i int) interface{} {
+			switch v := v.(*UrlResponse); i {
+			case 0:
+				return &v.state
+			case 1:
+				return &v.sizeCache
+			case 2:
+				return &v.unknownFields
+			default:
+				return nil
+			}
+		}
+		file_proto_ping_proto_msgTypes[4].Exporter = func(v interface{}, i int) interface{} {
+			switch v := v.(*TcpRequest); i {
+			case 0:
+				return &v.state
+			case 1:
+				return &v.sizeCache
+			case 2:
+				return &v.unknownFields
+			default:
+				return nil
+			}
+		}
+		file_proto_ping_proto_msgTypes[5].Exporter = func(v interface{}, i int) interface{} {
+			switch v := v.(*TcpResponse); i {
+			case 0:
+				return &v.state
+			case 1:
+				return &v.sizeCache
+			case 2:
+				return &v.unknownFields
+			default:
+				return nil
+			}
+		}
+	}
+	type x struct{}
+	out := protoimpl.TypeBuilder{
+		File: protoimpl.DescBuilder{
+			GoPackagePath: reflect.TypeOf(x{}).PkgPath(),
+			RawDescriptor: file_proto_ping_proto_rawDesc,
+			NumEnums:      0,
+			NumMessages:   6,
+			NumExtensions: 0,
+			NumServices:   1,
+		},
+		GoTypes:           file_proto_ping_proto_goTypes,
+		DependencyIndexes: file_proto_ping_proto_depIdxs,
+		MessageInfos:      file_proto_ping_proto_msgTypes,
+	}.Build()
+	File_proto_ping_proto = out.File
+	file_proto_ping_proto_rawDesc = nil
+	file_proto_ping_proto_goTypes = nil
+	file_proto_ping_proto_depIdxs = nil
+}

ping/proto/ping.pb.micro.go

@@ -0,0 +1,127 @@
+// Code generated by protoc-gen-micro. DO NOT EDIT.
+// source: proto/ping.proto
+
+package ping
+
+import (
+	fmt "fmt"
+	proto "github.com/golang/protobuf/proto"
+	math "math"
+)
+
+import (
+	context "context"
+	api "github.com/micro/micro/v3/service/api"
+	client "github.com/micro/micro/v3/service/client"
+	server "github.com/micro/micro/v3/service/server"
+)
+
+// Reference imports to suppress errors if they are not otherwise used.
+var _ = proto.Marshal
+var _ = fmt.Errorf
+var _ = math.Inf
+
+// This is a compile-time assertion to ensure that this generated file
+// is compatible with the proto package it is being compiled against.
+// A compilation error at this line likely means your copy of the
+// proto package needs to be updated.
+const _ = proto.ProtoPackageIsVersion3 // please upgrade the proto package
+
+// Reference imports to suppress errors if they are not otherwise used.
+var _ api.Endpoint
+var _ context.Context
+var _ client.Option
+var _ server.Option
+
+// Api Endpoints for Ping service
+
+func NewPingEndpoints() []*api.Endpoint {
+	return []*api.Endpoint{}
+}
+
+// Client API for Ping service
+
+type PingService interface {
+	Ip(ctx context.Context, in *IpRequest, opts ...client.CallOption) (*IpResponse, error)
+	Url(ctx context.Context, in *UrlRequest, opts ...client.CallOption) (*UrlResponse, error)
+	Tcp(ctx context.Context, in *TcpRequest, opts ...client.CallOption) (*TcpResponse, error)
+}
+
+type pingService struct {
+	c    client.Client
+	name string
+}
+
+func NewPingService(name string, c client.Client) PingService {
+	return &pingService{
+		c:    c,
+		name: name,
+	}
+}
+
+func (c *pingService) Ip(ctx context.Context, in *IpRequest, opts ...client.CallOption) (*IpResponse, error) {
+	req := c.c.NewRequest(c.name, "Ping.Ip", in)
+	out := new(IpResponse)
+	err := c.c.Call(ctx, req, out, opts...)
+	if err != nil {
+		return nil, err
+	}
+	return out, nil
+}
+
+func (c *pingService) Url(ctx context.Context, in *UrlRequest, opts ...client.CallOption) (*UrlResponse, error) {
+	req := c.c.NewRequest(c.name, "Ping.Url", in)
+	out := new(UrlResponse)
+	err := c.c.Call(ctx, req, out, opts...)
+	if err != nil {
+		return nil, err
+	}
+	return out, nil
+}
+
+func (c *pingService) Tcp(ctx context.Context, in *TcpRequest, opts ...client.CallOption) (*TcpResponse, error) {
+	req := c.c.NewRequest(c.name, "Ping.Tcp", in)
+	out := new(TcpResponse)
+	err := c.c.Call(ctx, req, out, opts...)
+	if err != nil {
+		return nil, err
+	}
+	return out, nil
+}
+
+// Server API for Ping service
+
+type PingHandler interface {
+	Ip(context.Context, *IpRequest, *IpResponse) error
+	Url(context.Context, *UrlRequest, *UrlResponse) error
+	Tcp(context.Context, *TcpRequest, *TcpResponse) error
+}
+
+func RegisterPingHandler(s server.Server, hdlr PingHandler, opts ...server.HandlerOption) error {
+	type ping interface {
+		Ip(ctx context.Context, in *IpRequest, out *IpResponse) error
+		Url(ctx context.Context, in *UrlRequest, out *UrlResponse) error
+		Tcp(ctx context.Context, in *TcpRequest, out *TcpResponse) error
+	}
+	type Ping struct {
+		ping
+	}
+	h := &pingHandler{hdlr}
+	return s.Handle(s.NewHandler(&Ping{h}, opts...))
+}
+
+type pingHandler struct {
+	PingHandler
+}
+
+func (h *pingHandler) Ip(ctx context.Context, in *IpRequest, out *IpResponse) error {
+	return h.PingHandler.Ip(ctx, in, out)
+}
+
+func (h *pingHandler) Url(ctx context.Context, in *UrlRequest, out *UrlResponse) error {
+	return h.PingHandler.Url(ctx, in, out)
+}
+
+func (h *pingHandler) Tcp(ctx context.Context, in *TcpRequest, out *TcpResponse) error {
+	return h.PingHandler.Tcp(ctx, in, out)
+}

ping/proto/ping.proto

@@ -0,0 +1,54 @@
+syntax = "proto3";
+
+package ping;
+
+option go_package = "./proto;ping";
+
+service Ping {
+	rpc Ip(IpRequest) returns (IpResponse) {}
+	rpc Url(UrlRequest) returns (UrlResponse) {}
+	rpc Tcp(TcpRequest) returns (TcpResponse) {}
+}
+
+// Ping an IP address
+message IpRequest {
+	// address to ping
+	string address = 1;
+}
+
+message IpResponse {
+	// response status
+	string status = 1;
+	// average latency e.g 10ms
+	string latency = 2;
+}
+
+// Ping a HTTP URL
+message UrlRequest {
+	// address to use
+	string address = 1;
+	// method of the call
+	string method = 2;
+}
+
+message UrlResponse {
+	// the response status
+	string status = 1;
+	// the response code
+	int32 code = 2;
+}
+
+// Ping a TCP port is open
+message TcpRequest {
+	// address to dial
+	string address = 1;
+	// optional data to send
+	string data = 2;
+}
+
+message TcpResponse {
+	// response status
+	string status = 1;
+	// response data if any
+	string data = 2;
+}

ping/publicapi.json

@@ -0,0 +1,6 @@
+{
+  "name": "ping",
+  "icon": "🏓",
+  "category": "utility",
+  "display_name": "Ping"
+}