Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: add diagram for how Java SDK interacts with Dapr runtime #915

Open
sicoyle opened this issue Sep 14, 2023 · 1 comment
Open

doc: add diagram for how Java SDK interacts with Dapr runtime #915

sicoyle opened this issue Sep 14, 2023 · 1 comment
Labels
area/examples good first issue Good for newcomers kind/documentation Improvements or additions to documentation P2 size/XS triaged/resolved Items triaged and ready

Comments

@sicoyle
Copy link

sicoyle commented Sep 14, 2023

Describe the proposal

Is your feature request related to a problem? Please describe.
There is no visual representation for how the SDK interacts with the Dapr runtime.

Describe the solution you'd like
It would be nice for community members to have a diagram depicting the interactions with end user applications, the Dapr Java SDK, and the Dapr sidecar close to the codebase, within the README.md file.

The diagram should include:

  • 3 main components: end user application, Dapr Java SDK, Dapr sidecar
  • Initialization: which protocol is the application Dapr client using to establish connection with the Dapr sidecar, HTTP or gRPC? That depends on the SDK and should be depicted visually.
  • API calls that one can use the Dapr client for. For example you can save & retrieve state from state stores, publish and subscribe to events using pub/sub, invoke other services using service invocation, etc. We should represent which APIs the SDK supports.
  • Overall request routing (when app makes API call through Dapr client, then the request is sent to the Dapr sidecar running along the app)

Other ideas that can be included in diagram:

  • Sidecar processing
  • Response handling
  • Middleware and observability
  • Error handling
  • Security

Describe alternatives you've considered
We could technically keep the README.md file as is, but it would be nice to have visuals here for community members understanding of these interactions.

Additional context
https://docs.dapr.io/developing-applications/sdks/

@cicoyle
Copy link
Contributor

cicoyle commented Sep 14, 2023

The diagram from this Issue might be useful as a reference --but plz don't copy it exactly

@mukundansundar mukundansundar added kind/documentation Improvements or additions to documentation good first issue Good for newcomers triaged/resolved Items triaged and ready area/examples P2 size/XS labels Sep 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/examples good first issue Good for newcomers kind/documentation Improvements or additions to documentation P2 size/XS triaged/resolved Items triaged and ready
Projects
No open projects
Development

No branches or pull requests

3 participants