Teach your (micro)services speak Protocol Buffers with grpc.

Size: px

Start display at page:

Download "Teach your (micro)services speak Protocol Buffers with grpc."

Belinda Bryant
5 years ago
Views:

1 Teach your (micro)services speak Protocol Buffers with grpc. Mihai

2 What s inside?

3 What s inside? Message serialization and deserialization

4 What s inside? Message serialization and deserialization Message transport

5 What s inside? Message serialization and deserialization Message transport Services diversity

6 How it works in real life B A C D

7 How it works in real life B A C D

8 In a nutshell Client Service

9 In a nutshell Client Service Over HTTP Serialized to JSON

10 In a nutshell Client Service Over HTTP Proprietary protocol Serialized to JSON Remote objects

11 JSON advantages

12 Human readable JSON advantages

13 JSON advantages Human readable Schema-less

14 JSON advantages Human readable Schema-less Language agnostic

15 JSON disadvantages

16 JSON disadvantages Human readable

17 JSON disadvantages Human readable Isn t it a benefit?

18 JSON disadvantages Human readable Isn t it a benefit? Schema-less

19 JSON disadvantages Human readable Isn t it a benefit? Schema-less Isn t it a benefit as well?

20 JSON disadvantages Human readable Isn t it a benefit? Schema-less Isn t it a benefit as well? Type-less

21 Protocol Buffers? Protocol buffers are Google's language-neutral, platform-neutral, extensible mechanism for serializing structured data think XML, but smaller, faster, and simpler.

22 Protocol Buffers? Protocol buffers are Google's language-neutral, platform-neutral, extensible mechanism for serializing structured data think XML, but smaller, faster, and simpler.

23 Protocol Buffers? Protocol buffers are Google's language-neutral, platform-neutral, extensible mechanism for serializing structured data think XML, but smaller, faster, and simpler. JSON

24 Protocol Buffers example message Person { string name = 1; int32 id = 2; repeated string aliases = 3; }

25 Protocol Buffers example message Person { string name = 1; int32 id = 2; repeated string aliases = 3; }

26 Protocol Buffers example message Person { string name = 1; int32 id = 2; repeated string aliases = 3; }

27 Protocol Buffers example message Person { string name = 1; int32 id = 2; repeated string aliases = 3; }

28 Protocol Buffers example message Person { string name = 1; int32 id = 2; repeated string aliases = 3; }

29 Protocol Buffers example message Person { string name = 1; int32 id = 2; repeated string aliases = 3; }

30 Protocol Buffers example message Person { reserved 1, 2, 5; reserved "name"; int32 id = 3; repeated string aliases = 4; }

31 Why protocol buffers Binary format

32 Why protocol buffers Enforcing the schema

33 Why protocol buffers Language neutral

34 Why protocol buffers Out-of the box backward compatibility

35 Why protocol buffers Out-of the box backward compatibility

36 Why protocol buffers Out-of the box backward compatibility if version == 3:... elif version > 4: if (version == 5):......

37 Why protocol buffers Generally faster

38 How to message Person { string name = 1; int32 id = 2; repeated string aliases = 3; }

39 How to message Person { string name = 1; Proto message definition int32 id = 2; repeated string aliases = 3; }

40 How to message Person { string name = 1; Proto message definition int32 id = 2; repeated string aliases = 3; } Person john = Person.newBuilder().setId(1234).setName("John Doe").addAliases("ionel").build();

41 How to message Person { string name = 1; Proto message definition int32 id = 2; repeated string aliases = 3; } Person john = Person.newBuilder().setId(1234) Object creation.setname("john Doe").addAliases("ionel").build();

42 How to message Person { string name = 1; Proto message definition int32 id = 2; repeated string aliases = 3; } john = Person() Object creation john.id = 1234 john.name = 'John Doe' john.aliases.add( ionel )

43 How to message Person { string name = 1; Proto message definition int32 id = 2; repeated string aliases = 3; } john = Person(id=1234, Object creation name='john Doe', aliases=['ionel'])

44 Communication (REST-ish) 1. URI: 2. Make an HTTP GET Request 3. Receive a plaintext JSON 4. Parse it 5.

45 Request GET /person/42 HTTP/1.1 Accept: */* Accept-Encoding: gzip, deflate Connection: keep-alive Host: api.example.com...

46 Response headers HTTP/ OK Access-Control-Allow-Credentials: true Cache-Control: public, max-age=14400 Content-Encoding: gzip Content-Type: application/json; charset=utf-8...

47 Response body { "name": "John Doe", "id": 42, "aliases": [ "ionel", "honzík" ] }

48 HTTP2

49 Distributed objects

50 Distributed objects First Law of Distributed Object Design: don't distribute your objects. Martin Fowler

51 The 8 Fallacies of distributed computing 1. The network is reliable. 5. Topology doesn't change. 2. Latency is zero. 6. There is one administrator. 3. Bandwidth is infinite. 7. Transport cost is zero. 4. The network is secure. 8. The network is homogeneous.

52 Keep in mind Anything that can go wrong will go wrong. Murphy s Law

53 So, what s next?

54 Services not Objects, Messages not References

55 Coverage & Simplicity

56 How does it work

57 Service definition service RoutePlanner { rpc GetRoutes (GetRoutesRequest) returns (GetRoutesResponse) {} }

58 Service definition service RoutePlanner { rpc GetRoutes (GetRoutesRequest) returns (GetRoutesResponse) {} }

59 Service definition service RoutePlanner { rpc GetRoutes (GetRoutesRequest) returns (GetRoutesResponse) {} }

60 Service definition service RoutePlanner { rpc GetRoutes (GetRoutesRequest) returns (GetRoutesResponse) {} }

61 Service definition service RoutePlanner { rpc GetRoutes (GetRoutesRequest) returns (GetRoutesResponse) {} }

62 Service definition service RoutePlanner { rpc GetRoutes (GetRoutesRequest) returns (GetRoutesResponse) {} }

63 Service definition message GetRoutesRequest { Location origin = 1; Location destination = 2; } message GetRoutesResponse { } repeated Route routes = 1;

64 Generate server code $ python -m grpc_tools.protoc \ --proto_path=../protos \ --python_out=. \ --grpc_python_out=. \../protos/route_planner.proto

65 Generate server code $ python -m grpc_tools.protoc \ --proto_path=../protos \ --python_out=. \ --grpc_python_out=. \../protos/route_planner.proto

66 Generate server code $ python -m grpc_tools.protoc \ --proto_path=../protos \ --python_out=. \ --grpc_python_out=. \../protos/route_planner.proto

67 Generate server code $ python -m grpc_tools.protoc \ --proto_path=../protos \ --python_out=. \ --grpc_python_out=. \../protos/route_planner.proto

68 Generate server code $ python -m grpc_tools.protoc \ --proto_path=../protos \ --python_out=. \ --grpc_python_out=. \../protos/route_planner.proto

69 Generate server code $ python -m grpc_tools.protoc \ --proto_path=../protos \ --python_out=. \ --grpc_python_out=. \../protos/route_planner.proto

70 Generate server code $ python -m grpc_tools.protoc \ --proto_path=../protos \ --python_out=. \ --grpc_python_out=. \../protos/route_planner.proto

71 Generated code $ tree. route_planner_pb2.py route_planner_pb2_grpc.py 0 directories, 2 files

72 Implementing the service

73 Implementing the service

74 Service code class Servicer(route_planner_pb2_grpc.RoutePlannerServicer): """Service implementation.""" def GetRoutes(self, request, context): return process_magically_the_request(request)

75 Service code server = grpc.server( futures.threadpoolexecutor(max_workers=10)) route_planner_pb2_grpc.add_routeplannerservicer_to_server( Servicer(), server) server.add_insecure_port('[::]:12345') server.start()

76 Service code server = grpc.server( futures.threadpoolexecutor(max_workers=10)) route_planner_pb2_grpc.add_routeplannerservicer_to_server( Servicer(), server) server.add_insecure_port('[::]:12345') server.start()

77 Service code server = grpc.server( futures.threadpoolexecutor(max_workers=10)) route_planner_pb2_grpc.add_routeplannerservicer_to_server( Servicer(), server) server.add_insecure_port('[::]:12345') server.start()

78 Service code server = grpc.server( futures.threadpoolexecutor(max_workers=10)) route_planner_pb2_grpc.add_routeplannerservicer_to_server( Servicer(), server) server.add_insecure_port('[::]:12345') server.start()

79 Service code server = grpc.server( futures.threadpoolexecutor(max_workers=10)) route_planner_pb2_grpc.add_routeplannerservicer_to_server( Servicer(), server) server.add_insecure_port('[::]:12345') server.start()

80 Implementing the client

81 Implementing the client

82 Client code channel = grpc.insecure_channel( localhost:12345') stub = route_planner_pb2_grpc.routeplannerstub(channel) request = route_planner_pb2.getroutesrequest( origin=current_location, destination=destination_coords) response = stub.getroutes(request)

83 Client code channel = grpc.insecure_channel( localhost:12345') stub = route_planner_pb2_grpc.routeplannerstub(channel) request = route_planner_pb2.getroutesrequest( origin=current_location, destination=destination_coords) response = stub.getroutes(request)

84 Client code channel = grpc.insecure_channel( localhost:12345') stub = route_planner_pb2_grpc.routeplannerstub(channel) request = route_planner_pb2.getroutesrequest( origin=current_location, destination=destination_coords) response = stub.getroutes(request)

85 Client code channel = grpc.insecure_channel( localhost:12345') stub = route_planner_pb2_grpc.routeplannerstub(channel) request = route_planner_pb2.getroutesrequest( origin=current_location, destination=destination_coords) response = stub.getroutes(request)

86 Client code channel = grpc.insecure_channel( localhost:12345') stub = route_planner_pb2_grpc.routeplannerstub(channel) request = route_planner_pb2.getroutesrequest( origin=current_location, destination=destination_coords) response = stub.getroutes(request)

87 Client code channel = grpc.insecure_channel( localhost:12345') stub = route_planner_pb2_grpc.routeplannerstub(channel) request = route_planner_pb2.getroutesrequest( origin=current_location, destination=destination_coords) response = stub.getroutes(request)

88 Client code (async) response_future = stub.getroutes.future(request) response_future.result()

89 grpc_cli $ grpc_cli call localhost:12345 \ RoutePlanner.GetRoutes \ <<- PROTO origin: <long: 0.0 lat: 0.0> destination: <long: 1.1 lat: 1.1> PROTO

90 grpc_cli $ grpc_cli call localhost:12345 \ RoutePlanner.GetRoutes \ <<- PROTO origin: <long: 0.0 lat: 0.0> destination: <long: 1.1 lat: 1.1> PROTO

91 grpc_cli $ grpc_cli call localhost:12345 \ RoutePlanner.GetRoutes \ <<- PROTO origin: <long: 0.0 lat: 0.0> destination: <long: 1.1 lat: 1.1> PROTO

92 grpc_cli $ grpc_cli call localhost:12345 \ RoutePlanner.GetRoutes \ <<- PROTO origin: <long: 0.0 lat: 0.0> destination: <long: 1.1 lat: 1.1> PROTO

93 grpc_cli $ grpc_cli call localhost:12345 \ RoutePlanner.GetRoutes \ <<- PROTO origin: <long: 0.0 lat: 0.0> destination: <long: 1.1 lat: 1.1> PROTO

94 grpc_cli Rpc succeeded with OK status Response: routes: <...> routes: <...> routes: <...> routes: <...>

95 Service definition service RoutePlanner { rpc GetRoutes (GetRoutesRequest) returns (GetRoutesResponse) {} }

96 Service definition - response streaming service RoutePlanner { rpc GetRoutes (GetRoutesRequest) returns (stream GetRoutesResponse) {} }

97 Service definition service RoutePlanner { rpc GetRoutes (GetRoutesRequest) returns (GetRoutesResponse) {} }

98 Service definition - request streaming service RoutePlanner { rpc GetRoutes (stream GetRoutesRequest) returns (GetRoutesResponse) {} }

99 Request streaming? Response streaming?

100 Request streaming? Response streaming?

101 Service definition - bidirectional streaming service RoutePlanner { rpc GetRoutes (stream GetRoutesRequest) returns (stream GetRoutesResponse) {} }

102 Keep in mind Things will go wrong

103 Timeouts? ms A D? ms? ms Client Service B? ms? ms E? ms C

104 Uniform timeout Client Service A B

105 Uniform timeout 500 ms timeout 500 ms timeout 500 ms timeout Client Service A B

106 Uniform timeout 500 ms timeout 500 ms timeout 500 ms timeout 20 ms Client Service A B

107 Uniform timeout 500 ms timeout 500 ms timeout 500 ms timeout 20 ms 30 ms Client Service A B

108 Uniform timeout 500 ms timeout 500 ms timeout 500 ms timeout 20 ms 30 ms 40 ms Client Service A B

109 Uniform timeout 500 ms timeout 500 ms timeout 500 ms timeout 20 ms 30 ms 40 ms Client Service A 420 ms B

110 Uniform timeout 500 ms timeout 500 ms timeout 500 ms timeout X 20 ms 30 ms Client Service A 40 ms 420 ms B

111 Uniform timeout 500 ms timeout 500 ms timeout 500 ms timeout 20 ms 30 ms 40 ms X X Client Service A 20 ms 420 ms B

112 Fine-tuned timeout Client Service A B

113 Fine-tuned timeout 300 ms timeout 280 ms timeout 50 ms timeout Client Service A B

114 Fine-tuned timeout 300 ms timeout 280 ms timeout 50 ms timeout 20 ms Client Service A B

115 Fine-tuned timeout 300 ms timeout 280 ms timeout 50 ms timeout 20 ms 30 ms Client Service A B

116 Fine-tuned timeout 300 ms timeout 280 ms timeout 50 ms timeout 20 ms 30 ms 15 ms Client Service A B

117 Fine-tuned timeout 300 ms timeout 280 ms timeout 50 ms timeout 20 ms 30 ms 15 ms Client Service A 40 ms B

118 Fine-tuned timeout 300 ms timeout 280 ms timeout 50 ms timeout 20 ms 30 ms X Client Service A 15 ms 40 ms B

119 Adaptive timeout Client Service A B

120 Adaptive timeout 200 ms timeout Client Service A B

121 Adaptive timeout 200 ms timeout 20 ms Client Service A B

122 Adaptive timeout 200 ms timeout 200ms - 20ms = 180 ms 20 ms Client Service A B

123 Adaptive timeout 200 ms timeout 200ms - 20ms = 180 ms 20 ms 30 ms Client Service A B

124 Adaptive timeout 200 ms timeout 200ms - 20ms = 180 ms 180ms - 30ms = 150ms 20 ms 30 ms Client Service A B

125 Adaptive timeout 200 ms timeout 200ms - 20ms = 180 ms 180ms - 30ms = 150ms 20 ms 30 ms 15 ms Client Service A B

126 Adaptive timeout 200 ms timeout 200ms - 20ms = 180 ms 180ms - 30ms = 150ms 20 ms 30 ms 15 ms Client Service A 40 ms B

127 Adaptive timeout 200 ms timeout 200ms - 20ms = 180 ms 180ms - 30ms = 150ms 20 ms 30 ms 15 ms Client Service A 20 ms 40 ms B

128 Adaptive timeout 200 ms timeout 200ms - 20ms = 180 ms 180ms - 30ms = 150ms 20 ms 30 ms 15 ms Client Service A 40 ms 20 ms 40 ms B

129 grpc: Deadlines

130 Timeout is relative grpc: Deadlines

131 grpc: Deadlines Timeout is relative Deadline is absolute

132 Deadline propagation Start TS: Timeout: 200 Deadline: Client Service A B

133 Deadline propagation Start TS: Timeout: 200 Deadline: TS: Client Service A B

134 Deadline propagation Start TS: Timeout: 200 Deadline: TS: ms Client Service A B

135 Deadline propagation Start TS: Timeout: 200 Deadline: TS: TS: ms Client Service A B

136 Deadline propagation Start TS: Timeout: 200 Deadline: TS: TS: ms 30 ms Client Service A B

137 Deadline propagation Start TS: Timeout: 200 Deadline: TS: TS: TS: ms 30 ms Client Service A B

138 Deadline propagation Start TS: Timeout: 200 Deadline: TS: TS: TS: ms 30 ms 15 ms Client Service A B

139 Deadline propagation Start TS: Timeout: 200 Deadline: TS: TS: TS: TS: ms 30 ms 15 ms Client Service A B

140 Deadline propagation Start TS: Timeout: 200 Deadline: TS: TS: TS: TS: ms 30 ms 15 ms Client Service A 40 ms B

141 Deadline propagation Start TS: Timeout: 200 Deadline: TS: TS: TS: TS: ms 30 ms 15 ms Client Service A 40 ms B TS:

142 Deadline propagation Start TS: Timeout: 200 Deadline: TS: TS: TS: TS: ms 30 ms 15 ms Client Service A 20 ms 40 ms B TS:

143 Deadline propagation Start TS: Timeout: 200 Deadline: TS: TS: TS: TS: ms 30 ms 15 ms Client Service A 20 ms 40 ms B TS: TS:

144 Deadline propagation Start TS: Timeout: 200 Deadline: TS: TS: TS: TS: ms 30 ms 15 ms Client Service A 40 ms 20 ms 40 ms B TS: TS:

145 Deadline propagation Start TS: Timeout: 200 Deadline: TS: TS: TS: TS: ms 30 ms 15 ms Client Service A 40 ms 20 ms 40 ms B TS: TS: TS:

146 Deadline propagation Start TS: Timeout: 200 Deadline: Client Service A B

147 Deadline propagation Start TS: Timeout: 200 Deadline: TS: Client Service A B

148 Deadline propagation Start TS: Timeout: 200 Deadline: TS: ms Client Service A B

149 Deadline propagation Start TS: Timeout: 200 Deadline: TS: TS: ms Client Service A B

150 Deadline propagation Start TS: Timeout: 200 Deadline: TS: TS: ms 100 ms Client Service A B

151 Deadline propagation Start TS: Timeout: 200 Deadline: TS: TS: TS: ms 100 ms Client Service A B

152 Deadline propagation Start TS: Timeout: 200 Deadline: TS: TS: TS: ms 100 ms X Client Service A B

153 Deadline propagation Start TS: Timeout: 200 Deadline: TS: TS: TS: ms 100 ms X Client Service A B DEADLINE_EXCEEDED

154 Deadline propagation Start TS: Timeout: 200 Deadline: TS: TS: TS: ms 100 ms X Client Service A B DEADLINE_EXCEEDED DEADLINE_EXCEEDED

155 Cancellation

156 Cancellation Can be initiated by both client/server

157 Cancellation Can be initiated by both client/server Immediately terminates the RPC

158 Cancellation Can be initiated by both client/server Immediately terminates the RPC It is not a roll-back

159 Cancellation Can be initiated by both client/server Immediately terminates the RPC It is not a roll-back Automatically cascaded

160 Backward compatibility

161 grpc language support C++ C# Python JS (Node) Java Android Java Go Objective-C Ruby PHP

162 grpc Platform support Linux macos Windows Android ios

163 Success stories

164 Success stories

165 Benefits

166 Benefits Focus on the API design & contract

167 Benefits Focus on the API design & contract HTTP2 is awesome

168 Benefits Focus on the API design & contract HTTP2 is awesome Bi-directional streaming

169 Benefits Focus on the API design & contract HTTP2 is awesome Bi-directional streaming Freedom to pick any language

170 Benefits Focus on the API design & contract HTTP2 is awesome Bi-directional streaming Freedom to pick any language Service-to-Service and Service-to-Mobile friendly

171 Benefits Focus on the API design & contract HTTP2 is awesome Bi-directional streaming Freedom to pick any language Service-to-Service and Service-to-Mobile friendly Production ready

172 Fin. Thank you.

{ REST } vs. Battle of API s

{ REST } vs. Battle of API s { REST } vs Battle of API s Software Engineer at Sensedia Who am I? MBA in java projects Java and microservice enthusiastic Microservices Agenda REST grpc Demo Questions Moving to Microservices Monolith