Skip to content

feat(attributes): add search alias metadata#492

Draft
cleptric wants to merge 1 commit into
mainfrom
add-new-properties
Draft

feat(attributes): add search alias metadata#492
cleptric wants to merge 1 commit into
mainfrom
add-new-properties

Conversation

@cleptric

Copy link
Copy Markdown
Member

No description provided.

@github-actions

Copy link
Copy Markdown

Semver Impact of This PR

🟡 Minor (new features)

📋 Changelog Preview

This is how your changes will appear in the changelog.
Entries from this PR are highlighted with a left border (blockquote style).


New Features ✨

  • (attributes) Add search alias metadata by cleptric in #492

🤖 This preview updates automatically when you update the PR.

{
"public_alias": "span.op",
"internal_name": "sentry.op",
"search_type": "string",

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can likely make string the default, so not required.

Comment on lines +113 to +116
"internal_name": {
"description": "The internal attribute name used by the EAP search resolver",
"type": "string"
},

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will this always duplicate the attribute's key? It feels like it ought to, in which case I'd prefer we make mismatches impossible by removing this property.

Comment on lines +135 to +138
"private": {
"description": "Whether the internal attribute should be hidden from public search results",
"type": "boolean"
},

@mjq mjq Jul 13, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this already covered by visibility? cc @nsdeschenes

Comment on lines +145 to +148
"spans": {
"description": "The column expression in the indexed spans dataset",
"type": "string"
},

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This dataset has been removed. Only EAP exists now.

Comment on lines +149 to +152
"eap": {
"description": "The column expression in the Events Analytics Platform dataset",
"type": "string"
}

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems better left to the Sentry backend to compute. (What's sent to EAP isn't a string either, so I don't think this is helpful here anyway). We do need a way to record when the search types and internal types of an attribute mismatch, though. I'd rather expose an (optional) internal_type property for this (one of string, boolean, double, integer, or array) so that the backend can construct the correct RPC proto.

"description": "Whether the internal attribute should be hidden from public search results",
"type": "boolean"
},
"dataset_mappings": {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given the two other two comments re: spans and eap I think the whole dataset_mappings can be removed.

@buenaflor

Copy link
Copy Markdown
Contributor

this closes #85 right?

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.

3 participants