fix(uptime): Refine new fields on the `uptime-results` schema #418

wedamija · 2025-06-23T22:58:18Z

Due to how we defined some fields in the schema, the code wasn't generated correctly. Also taking the opportunity to skip allowing fields to nullable. Instead, if the field isn't available, it should just not be set, instead of being null. This aligns with sending data to EAP as well, since EAP doesn't support null attributes.

github-actions · 2025-06-23T22:58:47Z

versions in use:

The following repositories use one of the schemas you are editing. It is recommended to roll out schema changes in small PRs, meaning that if those used versions lag behind the latest, it is probably best to update those services before rolling out your change.

latest version: 1.3.12

changes considered breaking

schemas/uptime-results.v1.schema.json

Restricted the type of .request_info_list.?.durations.dns_lookup, as string is no longer allowed

{"path": ".request_info_list.?.durations.dns_lookup", "change": {"TypeRemove": {"removed": "string"}}}

Restricted the type of .request_info_list.?.durations.dns_lookup, as number is no longer allowed

{"path": ".request_info_list.?.durations.dns_lookup", "change": {"TypeRemove": {"removed": "number"}}}

Restricted the type of .request_info_list.?.durations.dns_lookup, as integer is no longer allowed

{"path": ".request_info_list.?.durations.dns_lookup", "change": {"TypeRemove": {"removed": "integer"}}}

Restricted the type of .request_info_list.?.durations.dns_lookup, as array is no longer allowed

{"path": ".request_info_list.?.durations.dns_lookup", "change": {"TypeRemove": {"removed": "array"}}}

Restricted the type of .request_info_list.?.durations.dns_lookup, as boolean is no longer allowed

{"path": ".request_info_list.?.durations.dns_lookup", "change": {"TypeRemove": {"removed": "boolean"}}}

Restricted the type of .request_info_list.?.durations.dns_lookup, as null is no longer allowed

{"path": ".request_info_list.?.durations.dns_lookup", "change": {"TypeRemove": {"removed": "null"}}}

Added a new property, but the consumer has been ignoring additional properties so far. This is probably still fine, but please double-check that the producer does not already send this property with a different type in practice than you defined in this schema.
```
{"path": ".request_info_list.?.durations.dns_lookup", "change": {"PropertyAdd": {"lhs_additional_properties": true, "added": "duration_us"}}}
```
Added a new property, but the consumer has been ignoring additional properties so far. This is probably still fine, but please double-check that the producer does not already send this property with a different type in practice than you defined in this schema.
```
{"path": ".request_info_list.?.durations.dns_lookup", "change": {"PropertyAdd": {"lhs_additional_properties": true, "added": "start_us"}}}
```

{"path": ".request_info_list.?.durations.dns_lookup", "change": {"RequiredAdd": {"property": "duration_us"}}}

{"path": ".request_info_list.?.durations.dns_lookup", "change": {"RequiredAdd": {"property": "start_us"}}}

Restricted the type of .request_info_list.?.durations.receive_response, as string is no longer allowed

{"path": ".request_info_list.?.durations.receive_response", "change": {"TypeRemove": {"removed": "string"}}}

Restricted the type of .request_info_list.?.durations.receive_response, as number is no longer allowed

{"path": ".request_info_list.?.durations.receive_response", "change": {"TypeRemove": {"removed": "number"}}}

Restricted the type of .request_info_list.?.durations.receive_response, as integer is no longer allowed

{"path": ".request_info_list.?.durations.receive_response", "change": {"TypeRemove": {"removed": "integer"}}}

Restricted the type of .request_info_list.?.durations.receive_response, as array is no longer allowed

{"path": ".request_info_list.?.durations.receive_response", "change": {"TypeRemove": {"removed": "array"}}}

Restricted the type of .request_info_list.?.durations.receive_response, as boolean is no longer allowed

{"path": ".request_info_list.?.durations.receive_response", "change": {"TypeRemove": {"removed": "boolean"}}}

Restricted the type of .request_info_list.?.durations.receive_response, as null is no longer allowed

{"path": ".request_info_list.?.durations.receive_response", "change": {"TypeRemove": {"removed": "null"}}}

Added a new property, but the consumer has been ignoring additional properties so far. This is probably still fine, but please double-check that the producer does not already send this property with a different type in practice than you defined in this schema.
```
{"path": ".request_info_list.?.durations.receive_response", "change": {"PropertyAdd": {"lhs_additional_properties": true, "added": "duration_us"}}}
```
Added a new property, but the consumer has been ignoring additional properties so far. This is probably still fine, but please double-check that the producer does not already send this property with a different type in practice than you defined in this schema.
```
{"path": ".request_info_list.?.durations.receive_response", "change": {"PropertyAdd": {"lhs_additional_properties": true, "added": "start_us"}}}
```

{"path": ".request_info_list.?.durations.receive_response", "change": {"RequiredAdd": {"property": "duration_us"}}}

{"path": ".request_info_list.?.durations.receive_response", "change": {"RequiredAdd": {"property": "start_us"}}}

Restricted the type of .request_info_list.?.durations.send_request, as string is no longer allowed

{"path": ".request_info_list.?.durations.send_request", "change": {"TypeRemove": {"removed": "string"}}}

Restricted the type of .request_info_list.?.durations.send_request, as number is no longer allowed

{"path": ".request_info_list.?.durations.send_request", "change": {"TypeRemove": {"removed": "number"}}}

Restricted the type of .request_info_list.?.durations.send_request, as integer is no longer allowed

{"path": ".request_info_list.?.durations.send_request", "change": {"TypeRemove": {"removed": "integer"}}}

Restricted the type of .request_info_list.?.durations.send_request, as array is no longer allowed

{"path": ".request_info_list.?.durations.send_request", "change": {"TypeRemove": {"removed": "array"}}}

Restricted the type of .request_info_list.?.durations.send_request, as boolean is no longer allowed

{"path": ".request_info_list.?.durations.send_request", "change": {"TypeRemove": {"removed": "boolean"}}}

Restricted the type of .request_info_list.?.durations.send_request, as null is no longer allowed

{"path": ".request_info_list.?.durations.send_request", "change": {"TypeRemove": {"removed": "null"}}}

Added a new property, but the consumer has been ignoring additional properties so far. This is probably still fine, but please double-check that the producer does not already send this property with a different type in practice than you defined in this schema.
```
{"path": ".request_info_list.?.durations.send_request", "change": {"PropertyAdd": {"lhs_additional_properties": true, "added": "duration_us"}}}
```
Added a new property, but the consumer has been ignoring additional properties so far. This is probably still fine, but please double-check that the producer does not already send this property with a different type in practice than you defined in this schema.
```
{"path": ".request_info_list.?.durations.send_request", "change": {"PropertyAdd": {"lhs_additional_properties": true, "added": "start_us"}}}
```

{"path": ".request_info_list.?.durations.send_request", "change": {"RequiredAdd": {"property": "duration_us"}}}

{"path": ".request_info_list.?.durations.send_request", "change": {"RequiredAdd": {"property": "start_us"}}}

Restricted the type of .request_info_list.?.durations.tcp_connection, as string is no longer allowed

{"path": ".request_info_list.?.durations.tcp_connection", "change": {"TypeRemove": {"removed": "string"}}}

Restricted the type of .request_info_list.?.durations.tcp_connection, as number is no longer allowed

{"path": ".request_info_list.?.durations.tcp_connection", "change": {"TypeRemove": {"removed": "number"}}}

Restricted the type of .request_info_list.?.durations.tcp_connection, as integer is no longer allowed

{"path": ".request_info_list.?.durations.tcp_connection", "change": {"TypeRemove": {"removed": "integer"}}}

Restricted the type of .request_info_list.?.durations.tcp_connection, as array is no longer allowed

{"path": ".request_info_list.?.durations.tcp_connection", "change": {"TypeRemove": {"removed": "array"}}}

Restricted the type of .request_info_list.?.durations.tcp_connection, as boolean is no longer allowed

{"path": ".request_info_list.?.durations.tcp_connection", "change": {"TypeRemove": {"removed": "boolean"}}}

Restricted the type of .request_info_list.?.durations.tcp_connection, as null is no longer allowed

{"path": ".request_info_list.?.durations.tcp_connection", "change": {"TypeRemove": {"removed": "null"}}}

Added a new property, but the consumer has been ignoring additional properties so far. This is probably still fine, but please double-check that the producer does not already send this property with a different type in practice than you defined in this schema.
```
{"path": ".request_info_list.?.durations.tcp_connection", "change": {"PropertyAdd": {"lhs_additional_properties": true, "added": "duration_us"}}}
```
Added a new property, but the consumer has been ignoring additional properties so far. This is probably still fine, but please double-check that the producer does not already send this property with a different type in practice than you defined in this schema.
```
{"path": ".request_info_list.?.durations.tcp_connection", "change": {"PropertyAdd": {"lhs_additional_properties": true, "added": "start_us"}}}
```

{"path": ".request_info_list.?.durations.tcp_connection", "change": {"RequiredAdd": {"property": "duration_us"}}}

{"path": ".request_info_list.?.durations.tcp_connection", "change": {"RequiredAdd": {"property": "start_us"}}}

Restricted the type of .request_info_list.?.durations.time_to_first_byte, as string is no longer allowed

{"path": ".request_info_list.?.durations.time_to_first_byte", "change": {"TypeRemove": {"removed": "string"}}}

Restricted the type of .request_info_list.?.durations.time_to_first_byte, as number is no longer allowed

{"path": ".request_info_list.?.durations.time_to_first_byte", "change": {"TypeRemove": {"removed": "number"}}}

Restricted the type of .request_info_list.?.durations.time_to_first_byte, as integer is no longer allowed

{"path": ".request_info_list.?.durations.time_to_first_byte", "change": {"TypeRemove": {"removed": "integer"}}}

Restricted the type of .request_info_list.?.durations.time_to_first_byte, as array is no longer allowed

{"path": ".request_info_list.?.durations.time_to_first_byte", "change": {"TypeRemove": {"removed": "array"}}}

Restricted the type of .request_info_list.?.durations.time_to_first_byte, as boolean is no longer allowed

{"path": ".request_info_list.?.durations.time_to_first_byte", "change": {"TypeRemove": {"removed": "boolean"}}}

Restricted the type of .request_info_list.?.durations.time_to_first_byte, as null is no longer allowed

{"path": ".request_info_list.?.durations.time_to_first_byte", "change": {"TypeRemove": {"removed": "null"}}}

Added a new property, but the consumer has been ignoring additional properties so far. This is probably still fine, but please double-check that the producer does not already send this property with a different type in practice than you defined in this schema.
```
{"path": ".request_info_list.?.durations.time_to_first_byte", "change": {"PropertyAdd": {"lhs_additional_properties": true, "added": "duration_us"}}}
```
Added a new property, but the consumer has been ignoring additional properties so far. This is probably still fine, but please double-check that the producer does not already send this property with a different type in practice than you defined in this schema.
```
{"path": ".request_info_list.?.durations.time_to_first_byte", "change": {"PropertyAdd": {"lhs_additional_properties": true, "added": "start_us"}}}
```

{"path": ".request_info_list.?.durations.time_to_first_byte", "change": {"RequiredAdd": {"property": "duration_us"}}}

{"path": ".request_info_list.?.durations.time_to_first_byte", "change": {"RequiredAdd": {"property": "start_us"}}}

Restricted the type of .request_info_list.?.durations.tls_handshake, as string is no longer allowed

{"path": ".request_info_list.?.durations.tls_handshake", "change": {"TypeRemove": {"removed": "string"}}}

Restricted the type of .request_info_list.?.durations.tls_handshake, as number is no longer allowed

{"path": ".request_info_list.?.durations.tls_handshake", "change": {"TypeRemove": {"removed": "number"}}}

Restricted the type of .request_info_list.?.durations.tls_handshake, as integer is no longer allowed

{"path": ".request_info_list.?.durations.tls_handshake", "change": {"TypeRemove": {"removed": "integer"}}}

Restricted the type of .request_info_list.?.durations.tls_handshake, as array is no longer allowed

{"path": ".request_info_list.?.durations.tls_handshake", "change": {"TypeRemove": {"removed": "array"}}}

Restricted the type of .request_info_list.?.durations.tls_handshake, as boolean is no longer allowed

{"path": ".request_info_list.?.durations.tls_handshake", "change": {"TypeRemove": {"removed": "boolean"}}}

Restricted the type of .request_info_list.?.durations.tls_handshake, as null is no longer allowed

{"path": ".request_info_list.?.durations.tls_handshake", "change": {"TypeRemove": {"removed": "null"}}}

Added a new property, but the consumer has been ignoring additional properties so far. This is probably still fine, but please double-check that the producer does not already send this property with a different type in practice than you defined in this schema.
```
{"path": ".request_info_list.?.durations.tls_handshake", "change": {"PropertyAdd": {"lhs_additional_properties": true, "added": "duration_us"}}}
```
Added a new property, but the consumer has been ignoring additional properties so far. This is probably still fine, but please double-check that the producer does not already send this property with a different type in practice than you defined in this schema.
```
{"path": ".request_info_list.?.durations.tls_handshake", "change": {"PropertyAdd": {"lhs_additional_properties": true, "added": "start_us"}}}
```

{"path": ".request_info_list.?.durations.tls_handshake", "change": {"RequiredAdd": {"property": "duration_us"}}}

{"path": ".request_info_list.?.durations.tls_handshake", "change": {"RequiredAdd": {"property": "start_us"}}}

Restricted the type of .request_info_list.?.request_body_size_bytes, as null is no longer allowed

{"path": ".request_info_list.?.request_body_size_bytes", "change": {"TypeRemove": {"removed": "null"}}}

Restricted the type of .request_info_list.?.request_duration_us, as null is no longer allowed

{"path": ".request_info_list.?.request_duration_us", "change": {"TypeRemove": {"removed": "null"}}}

Restricted the type of .request_info_list.?.response_body_size_bytes, as null is no longer allowed

{"path": ".request_info_list.?.response_body_size_bytes", "change": {"TypeRemove": {"removed": "null"}}}

benign changes

schemas/uptime-results.v1.schema.json

{"path": ".request_info_list.?.durations", "change": {"RequiredRemove": {"property": "dns_lookup"}}}

{"path": ".request_info_list.?.durations", "change": {"RequiredRemove": {"property": "receive_response"}}}

{"path": ".request_info_list.?.durations", "change": {"RequiredRemove": {"property": "send_request"}}}

{"path": ".request_info_list.?.durations", "change": {"RequiredRemove": {"property": "tcp_connection"}}}

{"path": ".request_info_list.?.durations", "change": {"RequiredRemove": {"property": "time_to_first_byte"}}}

{"path": ".request_info_list.?.durations", "change": {"RequiredRemove": {"property": "tls_handshake"}}}

⚠️ This PR contains breaking changes. Normally you should avoid that and make
your consumer backwards-compatible (meaning that updated consumers can still
accept old messages). There are a few exceptions:

If consumers already require these invariants in practice, and you're
just adjusting the JSON schema to reality, ignore this warning.
If you know what you are doing, this change could potentially be rolled out
to producers first, but that's not a flow we support.

wedamija · 2025-06-23T22:59:55Z

versions in use:

The following repositories use one of the schemas you are editing. It is recommended to roll out schema changes in small PRs, meaning that if those used versions lag behind the latest, it is probably best to update those services before rolling out your change.

latest version: 1.3.12

changes considered breaking
benign changes
⚠️ This PR contains breaking changes. Normally you should avoid that and make your consumer backwards-compatible (meaning that updated consumers can still accept old messages). There are a few exceptions:

If consumers already require these invariants in practice, and you're
just adjusting the JSON schema to reality, ignore this warning.

If you know what you are doing, this change could potentially be rolled out
to producers first, but that's not a flow we support.

These breaking changes can be ignored, we're not sending these fields

evanpurkhiser · 2025-06-23T23:04:30Z

schemas/uptime-results.v1.schema.json

+        },
+        "send_request": {
+          "$ref": "#/definitions/Timing",
+          "description": "Time spent sending the request (per OTEL conventions)."


Should this also say per OTEL and drop the conventions?

wedamija requested a review from a team as a code owner June 23, 2025 22:58

gaprl approved these changes Jun 23, 2025

View reviewed changes

wedamija merged commit 2e9e899 into main Jun 23, 2025
17 of 18 checks passed

wedamija deleted the danf/uptime-refine-schema branch June 23, 2025 23:00

evanpurkhiser reviewed Jun 23, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix(uptime): Refine new fields on the `uptime-results` schema #418

fix(uptime): Refine new fields on the `uptime-results` schema #418

Uh oh!

wedamija commented Jun 23, 2025

Uh oh!

github-actions bot commented Jun 23, 2025

Uh oh!

wedamija commented Jun 23, 2025

Uh oh!

Uh oh!

evanpurkhiser Jun 23, 2025

Uh oh!

Uh oh!

Uh oh!

fix(uptime): Refine new fields on the uptime-results schema #418

fix(uptime): Refine new fields on the uptime-results schema #418

Uh oh!

Conversation

wedamija commented Jun 23, 2025

Uh oh!

github-actions bot commented Jun 23, 2025

Uh oh!

wedamija commented Jun 23, 2025

Uh oh!

Uh oh!

evanpurkhiser Jun 23, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

fix(uptime): Refine new fields on the `uptime-results` schema #418

fix(uptime): Refine new fields on the `uptime-results` schema #418