proto: Problem differentiating not-set value from default value
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 25/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Necesita aclaración
- Estado de actividad
- Estancado
- Área
- backend-api-design
Línea de trabajo
Comienza con proto/openmetrics_data_model.proto alrededor de las líneas 109-123 y revisa la especificación de OpenMetrics Protobuf enlazada. Compara la definición referenciada de Prometheus metrics.proto y los tres enfoques propuestos; después, establece qué comportamiento de presencia de campos debería admitir el esquema y cómo se verificaría la finalización.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Problem
The OpenMetrics Protobuf specification is using the proto3 syntax.
With the proto3 syntax all fields are optional by default. This is not to be confused with null-able. While one can choose not to specify a field it is then represented by its default value. Someone receiving a proto3 encoded payload has no way to tell the difference between a field explicitly set to its default value or not set at all.
The most prominent case where this can be problematic is for boolean fields where both the default value and the not-set value is false. In the context of OpenMetrics, as far as I can tell, one problematic example would be the examplar field in the CounterValue message. A use can not tell the difference between a not-set examplar and an examplar set to 0.
Solution
To solve the above I see 3 solutions:
- The
optionalkeyword, which would allow differentiating between a default value and a not-set value, was initially removed with theproto3syntax, but has been revived with v3.12.0. In case requiring protocv3.12.0is fine, one could just make use of the revivedoptionalkeyword. - The
optionalkeyword is just syntactic sugar foroneof. Thus, in case requiring protocv3.12.0is not an option, one can useoneofdirectly. See this stackoverflow answer. - Use
proto2instead ofproto3(see original Prometheus proto definition).
Further reading
- General Stackoverflow discussing
optionalinproto3. - Protoc release introducing
optionaltoproto3. - Documentation on field presence.
What do people think? Do you see alternative approaches?
Given that I don't have much expertise with Protobuf I might be missing something. If so, I would appreciate an answer pointing out my mistake.
- Lenguaje dominante
- Go
- Estrellas
- 2.5k
- Forks
- 175
- Merge medio
- 1 d 22 h
- PR fusionados (30 d)
- 1
Preparar el entorno
Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.
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 prometheus/OpenMetrics
-
Dificultad 4/5 3-5 días Aptitud para principiantes 45/100
prometheus/OpenMetrics#323 ·
-
OM 2.0
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
prometheus/OpenMetrics#312 · 13 comentarios ·
-
OM 2.0
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
prometheus/OpenMetrics#310 · 4 comentarios · 1 reacción ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 35/100
prometheus/OpenMetrics#304 · 1 comentario ·
-
RFC next stepsAbierto
Dificultad 5/5 Más de una semana Aptitud para principiantes 20/100
prometheus/OpenMetrics#301 ·
Todos los issues de prometheus/OpenMetrics
Issues similares
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 86/100
txn2/mcp-data-platform#2728 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
blinklabs-io/dingo#6504 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
SocialGouv/iterion#3413 ·
Los mantenedores suelen responder en 1 día
-
bug
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
orion-belt-dev/orion-belt#181 ·
Los mantenedores suelen responder en 1 día
-
documentation good first issue
Dificultad 2/5 1-3 horas Aptitud para principiantes 79/100
kubesmarts/logic-operator#105 ·
Los mantenedores suelen responder en 1 día