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

chore: allow tags for few metrics #39359

Merged
merged 2 commits into from
Feb 20, 2025
Merged

Conversation

ApekshaBhosale
Copy link
Contributor

@ApekshaBhosale ApekshaBhosale commented Feb 19, 2025

Description

Tip

Add a TL;DR when the description is longer than 500 words or extremely technical (helps the content, marketing, and DevRel team).

Please also include relevant motivation and context. List any dependencies that are required for this change. Add links to Notion, Figma or any other documents that might be relevant to the PR.

Fixes #Issue Number
or
Fixes Issue URL

Warning

If no issue exists, please create an issue first, and check with the maintainers if the issue is valid.

Automation

/ok-to-test tags="@tag.All"

🔍 Cypress test results

Caution

🔴 🔴 🔴 Some tests have failed.
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/13428563653
Commit: 494eede
Cypress dashboard.
Tags: @tag.All
Spec:
The following are new failures, please fix them before merging the PR:

  1. cypress/e2e/Regression/ClientSide/ActionExecution/FrameworkFunctions_LocalStoreValueFunctions_spec.ts
  2. cypress/e2e/Regression/ClientSide/SetProperty/WidgetPropertySetters2_spec.ts
  3. cypress/e2e/Regression/ClientSide/Widgets/TableV2/table_data_change_spec.ts
List of identified flaky tests.
Thu, 20 Feb 2025 06:45:14 UTC

Communication

Should the DevRel and Marketing teams inform users about this change?

  • Yes
  • No

Summary by CodeRabbit

  • Bug Fixes
    • Improved metric filtering to ensure that important monitoring details are correctly retained for enhanced tracking accuracy.
    • Added exemptions for specific metrics to prevent unintended tag removals.

Copy link
Contributor

coderabbitai bot commented Feb 19, 2025

Walkthrough

The changes update the metric filtering in NoTagsMeterFilter. A new static final variable seriesExceptionList is introduced to list metric name prefixes that should not have their tags removed. The map method is revised to check if the metric name starts with "appsmith" and is not part of the exception list before stripping its tags. A helper method, startsWithPrefix, encapsulates this prefix-checking logic.

Changes

File Change Summary
app/.../NoTagsMeterFilter.java Added seriesExceptionList variable, added a private method startsWithPrefix for prefix matching, and modified the map method logic to account for exceptions.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant MeterFilter as NoTagsMeterFilter
    Caller->>MeterFilter: map(Meter.Id)
    alt Metric name starts with "appsmith"
        MeterFilter->>MeterFilter: startsWithPrefix(metricName)
        alt Metric matches exception prefix
            MeterFilter-->>Caller: Return original Meter.Id
        else Metric does not match exception prefix
            MeterFilter-->>Caller: Return Meter.Id with tags removed
        end
    else
        MeterFilter-->>Caller: Return original Meter.Id
    end
Loading

Possibly related PRs

Suggested reviewers

  • trishaanand
  • rajatagrawal
  • subhrashisdas

Poem

In code's realm, a tweak so keen,
A list of exceptions now seen,
Metric tags handled with care,
A helper method crafted fair,
Our code marches on with a vibrant sheen! 🚀
Cheers to progress in our code machine!

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@ApekshaBhosale ApekshaBhosale added the ok-to-test Required label for CI label Feb 19, 2025
@github-actions github-actions bot added the skip-changelog Adding this label to a PR prevents it from being listed in the changelog label Feb 19, 2025
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (3)
app/server/appsmith-server/src/main/java/com/appsmith/server/configurations/NoTagsMeterFilter.java (3)

10-11: Consider using constants for metric names.

While the implementation is correct, consider defining metric names as constants to improve maintainability and prevent typos.

+ private static final String METRIC_PLUGIN_EXECUTION = "appsmith.total.plugin.execution";
+ private static final String METRIC_SERVER_EXECUTION = "appsmith.total.server.execution";
+ private static final String METRIC_DATASOURCE_CONTEXT = "appsmith.get.datasource.context";

- private static final List<String> seriesExceptionList = List.of(
-         "appsmith.total.plugin.execution", "appsmith.total.server.execution", "appsmith.get.datasource.context");
+ private static final List<String> seriesExceptionList = List.of(
+         METRIC_PLUGIN_EXECUTION, METRIC_SERVER_EXECUTION, METRIC_DATASOURCE_CONTEXT);

16-16: Extract "appsmith" prefix as a constant.

Consider extracting the "appsmith" prefix as a constant to improve maintainability.

+ private static final String METRIC_PREFIX = "appsmith";

- if (id.getName().startsWith("appsmith") && !startsWithAnyPrefix(id.getName())) {
+ if (id.getName().startsWith(METRIC_PREFIX) && !startsWithAnyPrefix(id.getName())) {

22-29: Consider using Java streams for better readability.

The implementation is correct, but could be more concise using Java streams.

- private boolean startsWithAnyPrefix(String metricName) {
-     for (String prefix : seriesExceptionList) {
-         if (metricName.startsWith(prefix)) {
-             return true;
-         }
-     }
-     return false;
- }
+ private boolean startsWithAnyPrefix(String metricName) {
+     return seriesExceptionList.stream()
+             .anyMatch(metricName::startsWith);
+ }
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7b61634 and bd200f8.

📒 Files selected for processing (1)
  • app/server/appsmith-server/src/main/java/com/appsmith/server/configurations/NoTagsMeterFilter.java (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: perform-test / rts-build / build
  • GitHub Check: perform-test / client-build / client-build
  • GitHub Check: server-spotless / spotless-check

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (3)
app/server/appsmith-server/src/main/java/com/appsmith/server/configurations/NoTagsMeterFilter.java (3)

10-11: Add documentation for exception list and consider externalization.

Consider adding Javadoc explaining why these specific metrics need to retain their tags. For maintainability, these values could be moved to a configuration file.


14-20: Document method behavior and extract magic string.

The implementation looks good, but consider:

  1. Adding Javadoc to explain the tag removal criteria
  2. Extracting "appsmith" as a constant
+    private static final String METRIC_PREFIX = "appsmith";
+
+    /**
+     * Removes tags from metrics that start with METRIC_PREFIX unless they're in the exception list.
+     *
+     * @param id The meter ID to process
+     * @return The processed meter ID
+     */
     @Override
     public Meter.Id map(Meter.Id id) {
-        if (id.getName().startsWith("appsmith") && !startsWithPrefix(id.getName())) {
+        if (id.getName().startsWith(METRIC_PREFIX) && !startsWithPrefix(id.getName())) {

22-29: Consider using String.startsWith(prefix, 0) for potential performance optimization.

The implementation is clean. For a minor optimization, you could use the String.startsWith overload that takes a starting position to avoid creating substrings:

     private boolean startsWithPrefix(String metricName) {
         for (String prefix : seriesExceptionList) {
-            if (metricName.startsWith(prefix)) {
+            if (metricName.startsWith(prefix, 0)) {
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bd200f8 and 494eede.

📒 Files selected for processing (1)
  • app/server/appsmith-server/src/main/java/com/appsmith/server/configurations/NoTagsMeterFilter.java (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: perform-test / client-build / client-build
  • GitHub Check: perform-test / rts-build / build
  • GitHub Check: perform-test / server-build / server-unit-tests
  • GitHub Check: server-unit-tests / server-unit-tests
  • GitHub Check: server-spotless / spotless-check

@ApekshaBhosale ApekshaBhosale added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels Feb 20, 2025
@rajatagrawal rajatagrawal merged commit 9728e8b into release Feb 20, 2025
148 of 156 checks passed
@rajatagrawal rajatagrawal deleted the allow-tags-for-certain-metrics branch February 20, 2025 07:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ok-to-test Required label for CI skip-changelog Adding this label to a PR prevents it from being listed in the changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants