feat[Do not merge][unlimited cardinality]: Added the procedure to adjust account cardinality #21337
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,154 +1,203 @@ | ||||||
| --- | ||||||
| title: 'Manage cardinality' | ||||||
| metaDescription: 'You can manage your data cardinality from the New Relic UI.' | ||||||
| freshnessValidatedDate: 2024-09-24 | ||||||
| --- | ||||||
|
|
||||||
|
|
||||||
| New relic provides a budget of 15 million cardinality per account per day. Under each account you can have multiple metrics, each with a cardinality budget of 100,000. If cardinality usage of a metrics approaches the limit, you can adjust the budget for metrics, or prune attributes to reduce cardinality. | ||||||
|
|
||||||
| <Callout variant="important"> | ||||||
| You can also [increase the cardinality budget of your account](#additional-account-cardinality-budget-adjustment) upto 200 million depending on your data needs. This option is only available with the [Advanced compute add-on](/docs/accounts/accounts-billing/new-relic-one-pricing-billing/add-on-billing) as a part of the Compute pricing model. Advanced [CCUs](/docs/licenses/license-information/product-definitions/new-relic-one-pricing-definitions/#compute-capacity-unit) are consumed for the additional cardinality used beyond the default budget. | ||||||
| </Callout> | ||||||
|
|
||||||
| To manage cardinality or create pruning rules, you need specific permissions. Reach out to your Authentication Domain Manager with your requirements. | ||||||
|
|
||||||
| <CollapserGroup> | ||||||
| <Collapser id="access-management" title="Access management (By Authentication Domain Manager)"> | ||||||
|
|
||||||
| As an Authentication Domain Manager, perform the following steps to grant access to a user for managing account and metrics cardinality. Check with the user about their specific needs and accordingly do the configuration. To learn more about user management, refer to [User management tutorial](/docs/accounts/accounts-billing/new-relic-one-user-management/account-user-mgmt-tutorial/). | ||||||
|
|
||||||
| <Steps> | ||||||
|
|
||||||
| <Step> | ||||||
| ### Add permissions to a custom role [#permissions-to-custom-role] | ||||||
| [Create a new custom role](/docs/accounts/accounts-billing/new-relic-one-user-management/account-user-mgmt-tutorial/#roles) with the following permissions, or add them to an existing role. Check with the user to understand the level of access required. | ||||||
| * `Manage account cardinality`: Adjust the cardinality budget of the account. | ||||||
| * `View`: Can see the cardinality budget of the account. | ||||||
| * `Modify`: Can update the cardinality budget of the account. | ||||||
| * `Manage metric cardinality`: Adjust the cardinality budget of metrics. | ||||||
| * `View`: Can see the cardinality budget of the metrics. | ||||||
| * `Modify`: Can update the cardinality budget of the metrics. | ||||||
| * `Manage pruning rules`: Manage pruning rules for metrics. | ||||||
| * `View`: Can see the pruning rules of the metrics. | ||||||
| * `Modify`: Can create and delete pruning rules for the metrics. | ||||||
| </Step> | ||||||
|
|
||||||
| <Step> | ||||||
| ### Add user, role, and account to a group [#group-access] | ||||||
| For the cardinality management, [create a new group](/docs/accounts/accounts-billing/new-relic-one-user-management/account-user-mgmt-tutorial/#group-access) or manage an existing group as follows: | ||||||
| 1. Navigate to **[New Relic Administration](https://one.newrelic.com/admin-portal) > Access Management > Groups**. | ||||||
| 2. Click <DNT>**Create a new group**</DNT>, or select <DNT>**Manage group access**</DNT> from the <Icon name="fe-more-horizontal"/> menu of an existing group. | ||||||
| 3. For a new group, provide a name and click <DNT>**Create group**</DNT>. The <DNT>**Admin**</DNT> pane for the group opens. | ||||||
| 4. Under <DNT>**Members**</DNT>, add the user. | ||||||
| 5. Under <DNT>**Account access**</DNT>, associate the custom role with the desired account for cardinality management. | ||||||
| 6. If cardinality management involves multiple accounts, under <DNT>**Account access**</DNT>, include the custom role for each relevant account within the group. | ||||||
| </Step> | ||||||
|
|
||||||
| </Steps> | ||||||
| </Collapser> | ||||||
| </CollapserGroup> | ||||||
|
|
||||||
|
|
||||||
| ## Account pruning rules [#account-pruning-rules] | ||||||
|
|
||||||
| A common method to maintain account cardinality within its budget is to implement pruning rules for non-critical attributes, which removes unnecessary data. | ||||||
|
|
||||||
| ### View account pruning rules [#view-pruning-rules] | ||||||
|
|
||||||
| <Steps> | ||||||
|
|
||||||
| <Step> | ||||||
| ### Prerequisite [#prerequisites] | ||||||
| To view account pruning rules, you must have the `Manage pruning rules: view` permission. Reach out to your Authentication Domain Manager to [add this permission](#access-management) to your custom role. | ||||||
| </Step> | ||||||
|
|
||||||
| <Step> | ||||||
| To view account pruning rules: | ||||||
| 1. Navigate to to **<DNT>[one.newrelic.com](https://one.newrelic.com)</DNT> > (click your user name) > <DNT>Administration > Cardinality Management</DNT>**. | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| 2. From the **Metrics** table, click <DNT>**View Pruning Rules**</DNT>. A scrollable list of all pruning rules associated with the account appears. | ||||||
|
|
||||||
| <Callout variant="tip"> | ||||||
| If no pruning rules exist in the account, the <DNT>**View Pruning Rules**</DNT> button doesn't appear. | ||||||
| </Callout> | ||||||
| </Step> | ||||||
|
|
||||||
| </Steps> | ||||||
|
|
||||||
| ### Create a pruning rule [#create-pruning-rule] | ||||||
|
|
||||||
| <Steps> | ||||||
|
|
||||||
| <Step> | ||||||
| ### Prerequisite [#prerequisites] | ||||||
| To create account pruning rules, you must have the `Manage pruning rules: modify` permission. Reach out to your Authentication Domain Manager to [add this permission](#access-management) to your custom role. | ||||||
| </Step> | ||||||
|
|
||||||
| <Step> | ||||||
| To create account pruning rules: | ||||||
| 1. Navigate to to **<DNT>[one.newrelic.com](https://one.newrelic.com)</DNT> > (click your user name) > <DNT>Administration > Cardinality Management</DNT>**. | ||||||
| 2. From the **Metrics** table, select the metric in which you want to create a pruning rule. The **Cardinality Management** page of the metric opens. | ||||||
| 3. Go to the **Attributes** table and select the attributes you want to prune. | ||||||
| <img | ||||||
| style={{ align: 'left', maxWidth: '90%' }} | ||||||
| title="Screenshot showing how to select attributes for pruning rule" | ||||||
| alt="Screenshot showing how to select attributes for pruning rule" | ||||||
| src="/images/apis-and-data_screenshot-crop_select-attributes-for-pruning-rule.webp"/> | ||||||
|
|
||||||
| 3. Click <DNT>**Create pruning rule**</DNT>. A pop-up appears, providing details on how the pruning rule impacts the metric's cardinality. | ||||||
|
|
||||||
| <img | ||||||
| style={{ align: 'left' }} | ||||||
| title="Screenshot of page to name the pruning rule" | ||||||
| alt="Screenshot of page to name the pruning rule" | ||||||
| src="/images/apis-and-data_screenshot-crop_name-pruning-rule.webp"/> | ||||||
|
|
||||||
| 4. Enter a rule name or description. | ||||||
|
|
||||||
| 4. Click <DNT>**Submit**</DNT>. | ||||||
|
|
||||||
| <Callout variant="important"> | ||||||
|
There was a problem hiding this comment. Should this be a caution rather than important? There was a problem hiding this comment. Changed it to caution |
||||||
| Pruning rules take effect immediately. Ensure you want to prune the data before creating a rule. You can delete a pruning rule after creating it, but the rule may prune some data before you remove it. | ||||||
| </Callout> | ||||||
| </Step> | ||||||
|
|
||||||
| </Steps> | ||||||
|
|
||||||
|
|
||||||
| ### Delete a pruning rule [#delete-pruning-rule] | ||||||
|
|
||||||
| <Steps> | ||||||
|
|
||||||
| <Step> | ||||||
| ### Prerequisite [#prerequisites] | ||||||
| To delete account pruning rules, you must have the `Manage pruning rules: modify` permission. Reach out to your Authentication Domain Manager to [add this permission](#access-management) to your custom role. | ||||||
| </Step> | ||||||
|
|
||||||
| <Step> | ||||||
| To delete account pruning rules: | ||||||
| 1. Navigate to to **<DNT>[one.newrelic.com](https://one.newrelic.com)</DNT> > (click your user name) > <DNT>Administration > Cardinality Management</DNT>**. | ||||||
| 2. From the **Metrics** table, select <DNT>**View Pruning Rules**</DNT>. | ||||||
| 3. Scroll to the relevant pruning rule and delete it. | ||||||
| </Step> | ||||||
|
|
||||||
| </Steps> | ||||||
|
|
||||||
| ## Per-metric budget adjustment [#per-metric-limit-adjustment] | ||||||
|
|
||||||
| When all attributes of a specific metric are crucial and you approach your cardinality budget, you can adjust the per-metric budget to meet your needs. Typically, metrics have a default maximum cardinality of 100,000, but you can increase this up to 1 million per metric. | ||||||
|
|
||||||
| <Callout variant="tip"> | ||||||
| Your account's overall cardinality budget remains unchanged. Therefore, setting all metric budgets to 1 million without careful consideration could quickly exhaust your account's cardinality capacity. | ||||||
| </Callout> | ||||||
|
|
||||||
| ### Edit per-metric budget [#edit-per-metric-limit] | ||||||
|
|
||||||
| <Steps> | ||||||
|
|
||||||
| <Step> | ||||||
| ### Prerequisite [#prerequisites] | ||||||
| To adjust per-metric budgets, you must have the `Manage metric cardinality: modify` permission. Reach out to your Authentication Domain Manager to [add this permission](#access-management) to your custom role. | ||||||
| </Step> | ||||||
|
|
||||||
| <Step> | ||||||
| To adjust the per-metric budget: | ||||||
| 1. Navigate to to **<DNT>[one.newrelic.com](https://one.newrelic.com)</DNT> > (click your user name) > <DNT>Administration > Cardinality Management</DNT>**. | ||||||
| 2. Select the metric for which you want to adjust the budget. The **Cardinality Management** page of the metric opens. | ||||||
| 3. Click <DNT>**Adjust metric budget**</DNT>. | ||||||
| 4. Update the budget to meet your needs. Make sure, it is less than or equal to 1 million. | ||||||
| </Step> | ||||||
|
|
||||||
| </Steps> | ||||||
|
|
||||||
|
|
||||||
| ## Additional account cardinality budget adjustment [#additional-account-cardinality-budget-adjustment] | ||||||
| While the default cardinality budget of 15 million is sufficient for most users, you may require a higher budget to accommodate your data needs. While you set an upper limit, you are only charged for the aggregates you generate above the 15 million default cardinality budget, up to the new limit you've set. Currently you can increase the cardinality budget of your account up to 200 million. If you need a higher budget, [create a support ticket](https://one.newrelic.com/help-xp). | ||||||
|
|
||||||
| <Steps> | ||||||
|
|
||||||
| <Step> | ||||||
| ### Prerequisites [#prerequisites] | ||||||
| To adjust the cardinality budget of your account, you must have: | ||||||
| * Subscribed to the [Advanced compute add-on](/docs/accounts/accounts-billing/new-relic-one-pricing-billing/add-on-billing). | ||||||
| * The `Manage account cardinality: modify` permission. Reach out to your Authentication Domain Manager to [add this permission](#access-management) to your custom role. | ||||||
| </Step> | ||||||
|
|
||||||
| <Step> | ||||||
| ### Adjust account cardinality budget [#adjust-account-cardinality-budget] | ||||||
| Perform the following steps to adjust the cardinality budget of your account. The adjustment may take 15 to 20 minutes to take effect. | ||||||
| 1. From the <DNT>**Cardinality Management**</DNT> page, click <DNT>**Manage account cardinality**</DNT>. | ||||||
| 2. From the <DNT>**Manage account cardinality limit**</DNT> pop-up: | ||||||
| 1. Adjust the slider to set the new cardinality budget for your account. The maximum limit is 200 million. | ||||||
| 2. Tick the checkbox to agree to and consent to the associated cost of the additional cardinality ingestion. | ||||||
| 3. Click <DNT>**Adjust cardinality budget**</DNT> to apply the changes. | ||||||
|
|
||||||
| <img | ||||||
| title="Manage account cardinality limit" | ||||||
| alt="Manage account cardinality limit" | ||||||
| src="/images/adjust-account-cardinality.webp" | ||||||
| /> | ||||||
|
|
||||||
| <Callout variant="tip"> | ||||||
| From the <DNT>**Manage account cardinality limit**</DNT> pop-up, you can view the change history to track when and by which user the account cardinality was adjusted. | ||||||
| </Callout> | ||||||
| </Step> | ||||||
|
|
||||||
| </Steps> | ||||||
|
|
||||||
| ## Related topics [#related-topics] | ||||||
|
|
||||||
| <DocTiles> | ||||||
| <DocTile title="Monitor cardinality" path="/docs/data-apis/ingest-apis/metric-api/monitor-cardinality" >Learn how to monitor cardinality usage.</DocTile> | ||||||
| <DocTile title="Understand and query high cardinality metrics" path="/docs/data-apis/ingest-apis/metric-api/NRQL-high-cardinality-metrics" >Understand the concept of cardinality and learn how to query and analyze high cardinality metrics using NRQL.</DocTile> | ||||||
| </DocTiles> | ||||||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we normally have Prerequisites as part of the procedure?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Moved it out