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

[improve][pip] PIP-347: add role field in consumer's stat #22562

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

thetumbled
Copy link
Contributor

@thetumbled thetumbled commented Apr 23, 2024

Motivation

By setting config allowAutoSubscriptionCreation=true, we allow user to create subscriptions automatically if user have the consume permission.
We have a strong need to trace back the owner of a specific subscription, but currently there is no such way to achieve that.

Modifications

Add field role in the stats response.

Verifying this change

  • Make sure that the change passes the CI checks.

(Please pick either of the following options)

This change added tests and can be verified as follows:

(example:)

  • Added integration tests for end-to-end deployment with large payloads (10MB)
  • Extended integration test for recovery after broker failure

Does this pull request potentially affect one of the following parts:

If the box was checked, please highlight the changes

  • Dependencies (add or upgrade a dependency)
  • The public API
  • The schema
  • The default values of configurations
  • The threading model
  • The binary protocol
  • The REST endpoints
  • The admin CLI options
  • The metrics
  • Anything that affects deployment

Documentation

  • doc
  • doc-required
  • doc-not-needed
  • doc-complete

Matching PR in forked repository

PR in forked repository: thetumbled#48

@github-actions github-actions bot added the doc-required Your PR changes impact docs and you will update later. label Apr 23, 2024
@thetumbled
Copy link
Contributor Author

thetumbled commented Apr 23, 2024

Comment on lines +28 to +29
/** the role used for authorization. */
String getRole();
Copy link
Contributor

Choose a reason for hiding this comment

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

Since this PR adds a new method to an existing public interface in the pulsar-xxx-api module, it needs a PIP.

We have a strong need to trace back the owner of a specific subscription

It's better to explain a bit more for why the role is needed here. From the wiki of statistics

Statistics (from German: Statistik, orig. "description of a state, a country")[1][2] is the discipline that concerns the collection, organization, analysis, interpretation, and presentation of data.

The role info is more like an attribute of a consumer, not a statistics. Generally, the role info never changes unlike other fields (e.g. the in/out rate)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

this is the pip for this pr: #22564.

@thetumbled thetumbled changed the title [improve] [broker] add role for consumer stat [improve][pip] PIP-347: add role field in consumer's stat Apr 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-required Your PR changes impact docs and you will update later.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants