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

Operation Insights: Metadata Tags for operations #4931

Open
erikwrede opened this issue Jun 6, 2024 · 1 comment
Open

Operation Insights: Metadata Tags for operations #4931

erikwrede opened this issue Jun 6, 2024 · 1 comment
Labels
enhancement New feature or request that adds new things or value to Hive help wanted Extra attention is needed

Comments

@erikwrede
Copy link

It would be great if Hive reports were taggable and filterable by custom user-defined tags. Use cases for tags could include

  • Region (e.g. europe-west, asia-pacific, north-america) for examining perfomance per Region
  • Backend-Revision - examining revision-specific performance
  • Tenant-name - enabling multitenancy analysis

Essentially, tags complement ClientInfo to provide additional metadata on the request. An operation could have one or multiple tags, resulting in the following changes to the Hive Reporting Spec:

export interface RequestOperation {
  timestamp: number
  operationMapKey: string
  execution: Execution
  metadata?: Metadata
}
 
export interface Metadata {
  client?: Client
+ tag?: string // OR
+ tags?: string[]
}

In the first iteration, the insights UI could be adjusted to have an additional filter like this:

image

If you agree on this feature being useful, there's several points to discuss:

  • One vs Multiple tags - (utility vs DB index performance)
  • Necessity of additional ClickHouse materialized views for Tags (complementing client, operation views)
  • Default tag if none was provided (better DB performance), similar to client -> "unknown"

Looking forward to your opinion on this.

Happy to draft an initial PR once we are aligned on the open points.

@kamilkisiela
Copy link
Owner

Makes sense, it shouldn't be an issue to maintain it and it's relatively easy to implement.
Yeah, we could accept such PR.

  • Multiple tags (it's better future-wise)
  • index for tags in materialized views of ClickHouse

and we're good to go

@n1ru4l n1ru4l added enhancement New feature or request that adds new things or value to Hive help wanted Extra attention is needed labels Jun 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request that adds new things or value to Hive help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants