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

SDK sends mysterious "_meta" property #3544

Closed
vanschelven opened this issue Sep 16, 2024 · 6 comments
Closed

SDK sends mysterious "_meta" property #3544

vanschelven opened this issue Sep 16, 2024 · 6 comments
Labels

Comments

@vanschelven
Copy link
Contributor

As per the title: the SDK sends a mysterious "_meta" property, but I can't seem to find any official docs on it; it also doesn't seem to be correct given the json schema

@szokeasaurusrex
Copy link
Member

Hi @vanschelven, this appears to be intentional. The underscore typically indicates that the _meta field is intended for internal use only, which is probably why we don't document it anywhere. Might be worth investigating though what this field does.

Does that answer your question? Is _meta causing any problems for you, or is there any other way we can help here?

@vanschelven
Copy link
Contributor Author

I had run into that commit in my research last week, but had forgotten about it when I revisited my notes today. Good find.

It does somewhat answer my question... but it raises one or more new ones 😄

Does "internal" mean "internal to the Python SDK"? If so... that seems at odds with actually sending it out over the wire 😄

and if internal means "Internal to the Sentry ecosystem"... that's more or less implied by this being the Sentry API. So then I'd argue for documenting it. That is... if anyone knows what it does.

Regarding "is this a problem"... I had moved to "let's just ignore this", so no not really. But I tend to be a bit of a perfectionist about interfaces.

@sl0thentr0py
Copy link
Member

The _meta field is used to annotate when we filter or truncate fields in our serializer so that the end product UI can display useful information to the user about these operations.

@vanschelven
Copy link
Contributor Author

The _meta field is used to annotate when we filter or truncate fields in our serializer so that the end product UI can display useful information to the user about these operations.

Ah, that makes (some) sense: I indeed see this information in the "_meta" field... but not in the (sentry.io) UI!

@sentrivana
Copy link
Contributor

Added a docs issue to add _meta. Will close this.

@vanschelven
Copy link
Contributor Author

but not in the (sentry.io) UI!

This is known

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Archived in project
Development

No branches or pull requests

4 participants