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

fix(spans): remove array type #173

Merged
merged 1 commit into from
Aug 9, 2023
Merged

fix(spans): remove array type #173

merged 1 commit into from
Aug 9, 2023

Conversation

dbanda
Copy link
Contributor

@dbanda dbanda commented Aug 9, 2023

Fixes a bug where the span message type was an array. It should just be a an object.

@dbanda dbanda requested a review from a team as a code owner August 9, 2023 20:54
@dbanda dbanda force-pushed the dbanda/spans-schema branch 2 times, most recently from 40a41d2 to 438c1fe Compare August 9, 2023 21:04
@github-actions
Copy link

github-actions bot commented Aug 9, 2023

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.

  • getsentry/snuba: pip:sentry-kafka-schemas==0.1.23 (upgrade)
  • getsentry/sentry: pip:sentry-kafka-schemas==0.1.22 (upgrade)

latest version: 0.1.24

changes considered breaking

schemas/snuba-spans.v1.schema.json

  • Restricted the type of ``, as array is no longer allowed

    {"path": "", "change": {"TypeRemove": {"removed": "array"}}}
    
  • {"path": "", "change": {"PropertyAdd": {"lhs_additional_properties": true, "added": "duration_ms"}}}
    
  • {"path": "", "change": {"PropertyAdd": {"lhs_additional_properties": true, "added": "event_id"}}}
    
  • {"path": "", "change": {"PropertyAdd": {"lhs_additional_properties": true, "added": "exclusive_time_ms"}}}
    
  • {"path": "", "change": {"PropertyAdd": {"lhs_additional_properties": true, "added": "group_raw"}}}
    
  • {"path": "", "change": {"PropertyAdd": {"lhs_additional_properties": true, "added": "is_segment"}}}
    
  • {"path": "", "change": {"PropertyAdd": {"lhs_additional_properties": true, "added": "organization_id"}}}
    
  • {"path": "", "change": {"PropertyAdd": {"lhs_additional_properties": true, "added": "parent_span_id"}}}
    
  • {"path": "", "change": {"PropertyAdd": {"lhs_additional_properties": true, "added": "project_id"}}}
    
  • {"path": "", "change": {"PropertyAdd": {"lhs_additional_properties": true, "added": "retention_days"}}}
    
  • {"path": "", "change": {"PropertyAdd": {"lhs_additional_properties": true, "added": "segment_id"}}}
    
  • {"path": "", "change": {"PropertyAdd": {"lhs_additional_properties": true, "added": "sentry_tags"}}}
    
  • {"path": "", "change": {"PropertyAdd": {"lhs_additional_properties": true, "added": "span_id"}}}
    
  • {"path": "", "change": {"PropertyAdd": {"lhs_additional_properties": true, "added": "start_timestamp_ms"}}}
    
  • {"path": "", "change": {"PropertyAdd": {"lhs_additional_properties": true, "added": "tags"}}}
    
  • {"path": "", "change": {"PropertyAdd": {"lhs_additional_properties": true, "added": "trace_id"}}}
    
  • {"path": "", "change": {"RequiredAdd": {"property": "duration_ms"}}}
    
  • {"path": "", "change": {"RequiredAdd": {"property": "exclusive_time_ms"}}}
    
  • {"path": "", "change": {"RequiredAdd": {"property": "is_segment"}}}
    
  • {"path": "", "change": {"RequiredAdd": {"property": "project_id"}}}
    
  • {"path": "", "change": {"RequiredAdd": {"property": "retention_days"}}}
    
  • {"path": "", "change": {"RequiredAdd": {"property": "span_id"}}}
    
  • {"path": "", "change": {"RequiredAdd": {"property": "start_timestamp_ms"}}}
    
  • {"path": "", "change": {"RequiredAdd": {"property": "trace_id"}}}
    
benign changes

schemas/snuba-spans.v1.schema.json

  • {"path": "", "change": {"TypeAdd": {"added": "object"}}}
    

⚠️ 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.

author Dalitso Banda <dalitso.banda@sentry.io> 1691122711 -0700
committer Dalitso Banda <dalitso.banda@sentry.io> 1691614785 -0700

remove array type from spans message
@dbanda dbanda merged commit 2b59ed0 into main Aug 9, 2023
14 of 15 checks passed
@dbanda dbanda deleted the dbanda/spans-schema branch August 9, 2023 22:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants