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(azure): Replace traces.message with customDimensions.MessageTemplate in slackNotifier #1437

Merged
merged 1 commit into from
Nov 11, 2024

Conversation

knuhau
Copy link
Collaborator

@knuhau knuhau commented Nov 11, 2024

Replace traces.message with customDimensions.MessageTemplate in the slackNotifier for improved grouping

Summary by CodeRabbit

  • Bug Fixes

    • Improved clarity of logged messages in the Slack Notifier function app.
    • Enhanced alert rule computations for better accuracy in logging.
  • Chores

    • Added comments for future refactoring plans regarding storage account management.

@knuhau knuhau requested review from a team as code owners November 11, 2024 09:49
Copy link
Contributor

coderabbitai bot commented Nov 11, 2024

📝 Walkthrough

Walkthrough

The pull request introduces modifications to the Bicep template for the Slack Notifier function app. Key changes include updates to the exceptionOccuredAlertRule resource, specifically altering the message and Details fields to reference the correct custom dimensions. Additionally, comments have been added to indicate future refactoring plans for storage account name generation and consolidation. The overall structure of the resources remains unchanged, with no new resources added or removed.

Changes

File Path Change Summary
.azure/modules/functionApp/slackNotifier.bicep Updated exceptionOccuredAlertRule resource's message and Details fields for improved clarity in logging. Added comments for future refactoring plans.

Possibly related PRs

Suggested reviewers

  • oskogstad
  • MagnusSandgren

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 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.

Copy link

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

🧹 Outside diff range and nitpick comments (1)
.azure/modules/functionApp/slackNotifier.bicep (1)

181-181: LGTM! Consider improving readability with column aliasing.

The change to use customDimensions_MessageTemplate in the coalesce is correct and consistent with the previous change.

Consider using explicit column aliasing in the summarize statement for better readability:

- tostring(customDimensions.MessageTemplate),
+ tostring(customDimensions.MessageTemplate) as MessageTemplate,

Then update the coalesce to use the alias:

- | extend Details = coalesce(customDimensions_MessageTemplate, problemId)
+ | extend Details = coalesce(MessageTemplate, problemId)
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between fec472b and e32c33c.

📒 Files selected for processing (1)
  • .azure/modules/functionApp/slackNotifier.bicep (2 hunks)
🔇 Additional comments (1)
.azure/modules/functionApp/slackNotifier.bicep (1)

171-171: LGTM! Verify query results in Azure Portal.

The change to use customDimensions.MessageTemplate is correct and aligns with the PR objective. The tostring() casting is properly applied.

To ensure the query continues to work as expected, please verify the results in Azure Portal:

  1. Navigate to Application Insights
  2. Use Analytics to test this query segment:

This will help confirm that MessageTemplate contains the expected values.

✅ Verification successful

The change to use customDimensions.MessageTemplate is correctly implemented

After examining the full bicep template, I can verify that the change is correctly implemented within the KQL query. The tostring(customDimensions.MessageTemplate) is:

  • Used appropriately in the summarize statement
  • Properly type-cast using tostring()
  • Referenced correctly in the coalesce function via customDimensions_MessageTemplate
  • Part of a well-structured query that handles both exceptions and traces

The query structure ensures that the MessageTemplate will be used for message grouping in the alert rule, which aligns with the PR objective.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

traces
| where severityLevel >= 2
| project message, 
    customDimensions.MessageTemplate,
    severityLevel
| take 10

Length of output: 246


Script:

#!/bin/bash
# Let's examine the bicep file to understand the full context of the query
cat .azure/modules/functionApp/slackNotifier.bicep

Length of output: 7140

@knuhau knuhau merged commit a7a2c74 into main Nov 11, 2024
19 checks passed
@knuhau knuhau deleted the chore/slack-alerts-customdimensions-messagetemplate branch November 11, 2024 09:59
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.

2 participants