[FEATURE] Add GRPC/Protobuf support to Java client
Los mantenedores suelen responder en 1 día
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 25/100
Línea de trabajo
Comienza con el transporte HTTP existente en el OpenSearch Java client y, después, lee common.proto en opensearch-protobufs y la entrada transport-grpc de build.gradle en OpenSearch. Aclara si el cliente debe reutilizar las clases existentes, generar una ruta gRPC separada o proporcionar compatibilidad parcial. Se considera terminado cuando haya un enfoque acordado para el transporte Java gRPC, con la compatibilidad de la API y el comportamiento de migración definidos.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Is your feature request related to a problem?
https://github.com/opensearch-project/OpenSearch/issues/16787 introduces GRPC/Protobuf as a new protocol/schema for client-server APIs, which has shown great performance improvements compared to traditional HTTP/REST APIs. This feature is now moving towards maturity and stabilization.
To further this feature's integration within the OpenSearch ecosystem, we would like to propose adding GRPC/Protobuf as a supported protocol in OpenSearch language clients. This will allow:
- users to more easily be able to use this feature, rather than raw protobuf generated code
- have shared common utilities which all clients can benefit from
- maintain parity with the HTTP/JSON user experience.
- Offer a more seamless transition from HTTP APIs to GRPC ones (e.g. through adding a flag to toggle
--protocol={grpc,http})
What solution would you like?
Add gRPC transport support to the OpenSearch Java client, providing a high-performance alternative to the existing HTTP transport while maintaining full API compatibility.
Some questions/challenges to consider are:
- Reuse HTTP java classes vs. build new ones: Whether the existing java classes can be refactored to support GRPC as well. If not possible, another option is to build a new GRPC Java code path which gets generated differently from the HTTP ones, which
- Handwritten vs. auto-generated client If the GRPC code path is separate from the HTTP code path, should we handwrite the java client for GRPC, or is there a way to autogenerate it similar to the HTTP one? There could be divergences from spec and protobufs (due to protobuf best practices), so how can autogeneration work? Should it be generated from the API spec or opensearch-protobufs?
- Full support vs. partial support: Depending on the challenges for supporting a fully fledged GRPC client, shall we opt to provide support only on utilities for common patterns? Can we fallback on using the default generated protobuf language client for APIs which are not supported by the client yet?
- Protocol specific considerations: Is there a way for the Java client support gRPC-protocol-specific features, such as streaming? On the other hand, how can the client properly convert HTTP-specific features, like the bulk NDJSON format?
- User migration: How should users transition from HTTP to gRPC (e.g.
--protocol={grpc,http}flag for a seamless transition, or would they have to rewrite their code to adhere to the GRPC client?
What alternatives have you considered?
Using the generated Java code for protobufs directly, rather than integrating into the existing client architecture.
Do you have any additional context?
- How protobufs are generated from spec: https://github.com/opensearch-project/opensearch-api-specification/issues/677
- opensearch-protobufs repo where protobufs are stored: https://github.com/opensearch-project/opensearch-protobufs/blob/main/protos/schemas/common.proto
- How the GRPC core module uses the protobufs: https://github.com/opensearch-project/OpenSearch/blob/main/modules/transport-grpc/build.gradle#L37
- Lenguaje dominante
- Java
- Estrellas
- 164
- Forks
- 260
- Merge medio
- 20 h 4 min
- PR fusionados (30 d)
- 53
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de opensearch-project/opensearch-java
-
enhancement untriaged
Dificultad 2/5 1-3 horas Aptitud para principiantes 74/100
opensearch-project/opensearch-java#2188 ·
Los mantenedores suelen responder en 1 día
-
[BUG] "shape" should not be required in GeoShapeQueryFieldQuizá libre de nuevo @lsh1215 la tomó hace 131 días y no hay ningún pull request abierto. Abiertobug untriaged
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
opensearch-project/opensearch-java#2011 · 2 comentarios ·
Los mantenedores suelen responder en 1 día
-
untriaged
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
opensearch-project/opensearch-java#2008 ·
Los mantenedores suelen responder en 1 día
-
[BUG] ISM types lastUpdatedTime is susceptible to int overflowPosiblemente ocupada @gingeekrishna la tomó hace 126 días. Abiertobug
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
opensearch-project/opensearch-java#1898 · 3 comentarios ·
Los mantenedores suelen responder en 1 día
-
[BUG] `BulkIngester` can deadlock when retried operations fill the bufferPosiblemente ocupada @emreekiziltoprak la tomó hace 8 días. Abiertobug untriaged
Dificultad 4/5 3-5 días Aptitud para principiantes 45/100
opensearch-project/opensearch-java#2248 ·
Los mantenedores suelen responder en 1 día
Todos los issues de opensearch-project/opensearch-java
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
commons-app/apps-android-commons#7275 ·
Los mantenedores suelen responder en 1 día
-
documentation
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
liberation-data/drivine4j#682 ·
Los mantenedores suelen responder en 1 día
-
Document and enforce pull request review guidelinesPosiblemente ocupada @dashorst la tomó hoy. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
Los mantenedores suelen responder en 1 día
-
`Time.at(t, in: nil)` returns UTC instead of the local time (or the time zone of `t`), unlike CRubyAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
Los mantenedores suelen responder en 1 día
-
hermes-queue
Dificultad 1/5 Menos de una hora Aptitud para principiantes 72/100
chrisalunlloyd2-sudo/mindpalace#349 ·
Los mantenedores suelen responder en 1 día