GRPC Agent #203

santigimeno · 2024-10-28T15:43:18Z

agents: add protofiles for GRPCAgent service

agents: add GrpcClient implementation

The static `GrpcClient` namespace exposes multiple methods implementing
part of the NSolidService rpc's.

- The `MakeChannel()` methods, which accepts `OtlpGrpcClientOptions` as
  a param, which allows creating a gRPC channel.
- The `MakeClientContext()` method which ºsets up a gRPC client context with
  metadata: `nsolid-agent-id: agent_id` and `nsolid-saas-token: token`.
- The `MakeNSolidServiceStub` method which creates a stub for the N|Solid service
  to facilitate communication with the N|Solid Console.
- The `DelegateAsyncExport()` methods which perform all the unary rpc
  calls defined in `NSolidService`.

agents: implement CommandStream class
    
It implements the bi-directional `Command` rpc using the gRPC Callback
API by inheriting from
`grpc::ClientBidiReactor<grpcagent::CommandResponse,grpcagent::CommandRequest>`.

Also add `nsolid_grpc_agent` as a "debuggable` native module.

agents: implement AssetStream class
    
It implements the gRPC Client Streaming `ExportAsset` rpc using the gRPC
Callback API by inheriting from
`grpc::ClientWriteReactor<grpcagent::Asset>`.

agents: GrpcAgent initial implementation

This implementation, in principle, implements exactly the same
functionality the `ZmqAgent` provides.

Expanded the `ProfileOptionsBase` to add `google::protobuf::Struct
metadata_pb`, so the metadata can be stored as a protobuf struct.

agents: implement JS bindings to the gRPC Agent

They implement the asset collection API's mirroring the bindings in the
`ZmqAgent`.

lib,src: gRPCAgent integration in N|Solid
    
For now the integration looks like this:

The `NSOLID_GRPC` env variable needs to be set to enable the agent. Its
value can be interpreted in 2 different ways:
- If a SaaS token is provided (via NSOLID_SAAS for example), its value
  has no meaning but "enable gRPC Agent".
- Otoh, if no SaaS token is provided, its contents are parsed as the
  endpoint the `gRPCAgent` should connect to.

test: add gRPC agent tests

trevnorris

Awesome stuff.

trevnorris · 2024-10-29T17:21:30Z

agents/grpc/src/binding.cc

+void InitGrpcAgent(Local<Object> exports,
+                  Local<Value> unused,
+                  Local<Context> context,
+                  void* priv) {


nit: left alignment.

trevnorris · 2024-10-29T17:25:25Z

agents/grpc/src/grpc_agent.h

+      const ProfileType& type,
+      ProfileOptions& options);  // NOLINT(runtime/references)
+
+  // ErrorType do_start_prof(const grpcagent::CommandRequest& req,


Can this be removed, or was it for something we'll need in the future?

The static `GrpcClient` namespace exposes multiple methods implementing part of the NSolidService rpc's. - The `MakeChannel()` methods, which accepts `OtlpGrpcClientOptions` as a param, which allows creating a gRPC channel. - The `MakeClientContext()` method which ºsets up a gRPC client context with metadata: `nsolid-agent-id: agent_id` and `nsolid-saas-token: token`. - The `MakeNSolidServiceStub` method which creates a stub for the N|Solid service to facilitate communication with the N|Solid Console. - The `DelegateAsyncExport()` methods which perform all the unary rpc calls defined in `NSolidService`.

It implements the bi-directional `Command` rpc using the gRPC Callback API by inheriting from `grpc::ClientBidiReactor<grpcagent::CommandResponse,grpcagent::CommandRequest>`. Also add `nsolid_grpc_agent` as a "debuggable` native module.

It implements the gRPC Client Streaming `ExportAsset` rpc using the gRPC Callback API by inheriting from `grpc::ClientWriteReactor<grpcagent::Asset>`.

This implementation, in principle, implements exactly the same functionality the `ZmqAgent` provides. Expanded the `ProfileOptionsBase` to add `google::protobuf::Struct metadata_pb`, so the metadata can be stored as a protobuf struct.

They implement the asset collection API's mirroring the bindings in the `ZmqAgent`.

For now the integration looks like this: The `NSOLID_GRPC` env variable needs to be set to enable the agent. Its value can be interpreted in 2 different ways: - If a SaaS token is provided (via NSOLID_SAAS for example), its value has no meaning but "enable gRPC Agent". - Otoh, if no SaaS token is provided, its contents are parsed as the endpoint the `gRPCAgent` should connect to.

It should be a valid URL otherwise, `opentelemetry-cpp` `URLParser` will throw. Also fixed handling of `grpc` configuration via package.json.

PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

The static `GrpcClient` namespace exposes multiple methods implementing part of the NSolidService rpc's. - The `MakeChannel()` methods, which accepts `OtlpGrpcClientOptions` as a param, which allows creating a gRPC channel. - The `MakeClientContext()` method which ºsets up a gRPC client context with metadata: `nsolid-agent-id: agent_id` and `nsolid-saas-token: token`. - The `MakeNSolidServiceStub` method which creates a stub for the N|Solid service to facilitate communication with the N|Solid Console. - The `DelegateAsyncExport()` methods which perform all the unary rpc calls defined in `NSolidService`. PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

It implements the bi-directional `Command` rpc using the gRPC Callback API by inheriting from `grpc::ClientBidiReactor<grpcagent::CommandResponse,grpcagent::CommandRequest>`. Also add `nsolid_grpc_agent` as a "debuggable` native module. PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

It implements the gRPC Client Streaming `ExportAsset` rpc using the gRPC Callback API by inheriting from `grpc::ClientWriteReactor<grpcagent::Asset>`. PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

This implementation, in principle, implements exactly the same functionality the `ZmqAgent` provides. Expanded the `ProfileOptionsBase` to add `google::protobuf::Struct metadata_pb`, so the metadata can be stored as a protobuf struct. PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

They implement the asset collection API's mirroring the bindings in the `ZmqAgent`. PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

For now the integration looks like this: The `NSOLID_GRPC` env variable needs to be set to enable the agent. Its value can be interpreted in 2 different ways: - If a SaaS token is provided (via NSOLID_SAAS for example), its value has no meaning but "enable gRPC Agent". - Otoh, if no SaaS token is provided, its contents are parsed as the endpoint the `gRPCAgent` should connect to. PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

The static `GrpcClient` namespace exposes multiple methods implementing part of the NSolidService rpc's. - The `MakeChannel()` methods, which accepts `OtlpGrpcClientOptions` as a param, which allows creating a gRPC channel. - The `MakeClientContext()` method which ºsets up a gRPC client context with metadata: `nsolid-agent-id: agent_id` and `nsolid-saas-token: token`. - The `MakeNSolidServiceStub` method which creates a stub for the N|Solid service to facilitate communication with the N|Solid Console. - The `DelegateAsyncExport()` methods which perform all the unary rpc calls defined in `NSolidService`. PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

It implements the bi-directional `Command` rpc using the gRPC Callback API by inheriting from `grpc::ClientBidiReactor<grpcagent::CommandResponse,grpcagent::CommandRequest>`. Also add `nsolid_grpc_agent` as a "debuggable` native module. PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

It implements the gRPC Client Streaming `ExportAsset` rpc using the gRPC Callback API by inheriting from `grpc::ClientWriteReactor<grpcagent::Asset>`. PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

This implementation, in principle, implements exactly the same functionality the `ZmqAgent` provides. Expanded the `ProfileOptionsBase` to add `google::protobuf::Struct metadata_pb`, so the metadata can be stored as a protobuf struct. PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

They implement the asset collection API's mirroring the bindings in the `ZmqAgent`. PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

For now the integration looks like this: The `NSOLID_GRPC` env variable needs to be set to enable the agent. Its value can be interpreted in 2 different ways: - If a SaaS token is provided (via NSOLID_SAAS for example), its value has no meaning but "enable gRPC Agent". - Otoh, if no SaaS token is provided, its contents are parsed as the endpoint the `gRPCAgent` should connect to. PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

It should be a valid URL otherwise, `opentelemetry-cpp` `URLParser` will throw. Also fixed handling of `grpc` configuration via package.json. PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

The static `GrpcClient` namespace exposes multiple methods implementing part of the NSolidService rpc's. - The `MakeChannel()` methods, which accepts `OtlpGrpcClientOptions` as a param, which allows creating a gRPC channel. - The `MakeClientContext()` method which ºsets up a gRPC client context with metadata: `nsolid-agent-id: agent_id` and `nsolid-saas-token: token`. - The `MakeNSolidServiceStub` method which creates a stub for the N|Solid service to facilitate communication with the N|Solid Console. - The `DelegateAsyncExport()` methods which perform all the unary rpc calls defined in `NSolidService`. PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

It implements the bi-directional `Command` rpc using the gRPC Callback API by inheriting from `grpc::ClientBidiReactor<grpcagent::CommandResponse,grpcagent::CommandRequest>`. Also add `nsolid_grpc_agent` as a "debuggable` native module. PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

It implements the gRPC Client Streaming `ExportAsset` rpc using the gRPC Callback API by inheriting from `grpc::ClientWriteReactor<grpcagent::Asset>`. PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

This implementation, in principle, implements exactly the same functionality the `ZmqAgent` provides. Expanded the `ProfileOptionsBase` to add `google::protobuf::Struct metadata_pb`, so the metadata can be stored as a protobuf struct. PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

They implement the asset collection API's mirroring the bindings in the `ZmqAgent`. PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

For now the integration looks like this: The `NSOLID_GRPC` env variable needs to be set to enable the agent. Its value can be interpreted in 2 different ways: - If a SaaS token is provided (via NSOLID_SAAS for example), its value has no meaning but "enable gRPC Agent". - Otoh, if no SaaS token is provided, its contents are parsed as the endpoint the `gRPCAgent` should connect to. PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

It should be a valid URL otherwise, `opentelemetry-cpp` `URLParser` will throw. Also fixed handling of `grpc` configuration via package.json. PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

The static `GrpcClient` namespace exposes multiple methods implementing part of the NSolidService rpc's. - The `MakeChannel()` methods, which accepts `OtlpGrpcClientOptions` as a param, which allows creating a gRPC channel. - The `MakeClientContext()` method which ºsets up a gRPC client context with metadata: `nsolid-agent-id: agent_id` and `nsolid-saas-token: token`. - The `MakeNSolidServiceStub` method which creates a stub for the N|Solid service to facilitate communication with the N|Solid Console. - The `DelegateAsyncExport()` methods which perform all the unary rpc calls defined in `NSolidService`. PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

It implements the bi-directional `Command` rpc using the gRPC Callback API by inheriting from `grpc::ClientBidiReactor<grpcagent::CommandResponse,grpcagent::CommandRequest>`. Also add `nsolid_grpc_agent` as a "debuggable` native module. PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

It implements the gRPC Client Streaming `ExportAsset` rpc using the gRPC Callback API by inheriting from `grpc::ClientWriteReactor<grpcagent::Asset>`. PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

This implementation, in principle, implements exactly the same functionality the `ZmqAgent` provides. Expanded the `ProfileOptionsBase` to add `google::protobuf::Struct metadata_pb`, so the metadata can be stored as a protobuf struct. PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

They implement the asset collection API's mirroring the bindings in the `ZmqAgent`. PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

For now the integration looks like this: The `NSOLID_GRPC` env variable needs to be set to enable the agent. Its value can be interpreted in 2 different ways: - If a SaaS token is provided (via NSOLID_SAAS for example), its value has no meaning but "enable gRPC Agent". - Otoh, if no SaaS token is provided, its contents are parsed as the endpoint the `gRPCAgent` should connect to. PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

It should be a valid URL otherwise, `opentelemetry-cpp` `URLParser` will throw. Also fixed handling of `grpc` configuration via package.json. PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

santigimeno requested a review from trevnorris October 28, 2024 15:43

santigimeno self-assigned this Oct 28, 2024

santigimeno force-pushed the santi/grpc_agent_pr branch 4 times, most recently from 6346451 to 5364e4c Compare October 28, 2024 22:43

trevnorris approved these changes Oct 29, 2024

View reviewed changes

santigimeno added 4 commits October 30, 2024 09:53

agents: add protofiles for GRPCAgent service

2a73017

agents: implement CommandStream class

eeb6f83

It implements the bi-directional `Command` rpc using the gRPC Callback API by inheriting from `grpc::ClientBidiReactor<grpcagent::CommandResponse,grpcagent::CommandRequest>`. Also add `nsolid_grpc_agent` as a "debuggable` native module.

agents: implement AssetStream class

1e828cf

It implements the gRPC Client Streaming `ExportAsset` rpc using the gRPC Callback API by inheriting from `grpc::ClientWriteReactor<grpcagent::Asset>`.

santigimeno force-pushed the santi/grpc_agent_pr branch 2 times, most recently from 9c02817 to a657715 Compare October 30, 2024 15:48

santigimeno added 3 commits October 31, 2024 02:03

agents: GrpcAgent initial implementation

bf3fd5c

This implementation, in principle, implements exactly the same functionality the `ZmqAgent` provides. Expanded the `ProfileOptionsBase` to add `google::protobuf::Struct metadata_pb`, so the metadata can be stored as a protobuf struct.

agents: implement JS bindings to the gRPC Agent

b9d8b2e

They implement the asset collection API's mirroring the bindings in the `ZmqAgent`.

santigimeno force-pushed the santi/grpc_agent_pr branch from a657715 to dbf23fa Compare October 31, 2024 01:03

trevnorris approved these changes Oct 31, 2024

View reviewed changes

santigimeno added 3 commits November 1, 2024 00:58

test: add gRPC agent tests

bb8345b

lib: validate NSOLID_GRPC value

bfb8a74

It should be a valid URL otherwise, `opentelemetry-cpp` `URLParser` will throw. Also fixed handling of `grpc` configuration via package.json.

agents: fix deadlock on CommandStream destruction

4b4e5d4

santigimeno force-pushed the santi/grpc_agent_pr branch from dbf23fa to 4b4e5d4 Compare October 31, 2024 23:58

santigimeno added a commit that referenced this pull request Nov 1, 2024

agents: add protofiles for GRPCAgent service

e20272f

PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

santigimeno added a commit that referenced this pull request Nov 1, 2024

agents: implement JS bindings to the gRPC Agent

93db684

They implement the asset collection API's mirroring the bindings in the `ZmqAgent`. PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

santigimeno added a commit that referenced this pull request Nov 1, 2024

test: add gRPC agent tests

fd217c9

PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

trevnorris pushed a commit that referenced this pull request Nov 1, 2024

agents: add protofiles for GRPCAgent service

c2a8299

PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

trevnorris pushed a commit that referenced this pull request Nov 1, 2024

agents: implement JS bindings to the gRPC Agent

37f4eaa

They implement the asset collection API's mirroring the bindings in the `ZmqAgent`. PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

trevnorris pushed a commit that referenced this pull request Nov 1, 2024

test: add gRPC agent tests

b098485

PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

trevnorris pushed a commit that referenced this pull request Nov 1, 2024

agents: fix deadlock on CommandStream destruction

502b6c5

PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

trevnorris pushed a commit that referenced this pull request Nov 1, 2024

agents: add protofiles for GRPCAgent service

14246ff

PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

trevnorris pushed a commit that referenced this pull request Nov 1, 2024

agents: implement JS bindings to the gRPC Agent

c882afb

They implement the asset collection API's mirroring the bindings in the `ZmqAgent`. PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

trevnorris pushed a commit that referenced this pull request Nov 1, 2024

test: add gRPC agent tests

aba5f2a

PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

trevnorris pushed a commit that referenced this pull request Nov 1, 2024

agents: fix deadlock on CommandStream destruction

79281e7

PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

trevnorris pushed a commit that referenced this pull request Nov 1, 2024

agents: add protofiles for GRPCAgent service

92aca9a

PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

trevnorris pushed a commit that referenced this pull request Nov 1, 2024

agents: implement JS bindings to the gRPC Agent

049fa3e

They implement the asset collection API's mirroring the bindings in the `ZmqAgent`. PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

trevnorris pushed a commit that referenced this pull request Nov 1, 2024

test: add gRPC agent tests

f1a0387

PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

trevnorris pushed a commit that referenced this pull request Nov 1, 2024

agents: fix deadlock on CommandStream destruction

7ea9444

PR-URL: #203 Reviewed-By: Trevor Norris <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GRPC Agent #203

GRPC Agent #203

santigimeno commented Oct 28, 2024

trevnorris left a comment

trevnorris Oct 29, 2024

trevnorris Oct 29, 2024

GRPC Agent #203

GRPC Agent #203

Conversation

santigimeno commented Oct 28, 2024

trevnorris left a comment

Choose a reason for hiding this comment

trevnorris Oct 29, 2024

Choose a reason for hiding this comment

trevnorris Oct 29, 2024

Choose a reason for hiding this comment