Add Alerts Documentation#164
Open
Shamly-Shanawaz wants to merge 3 commits intowso2:mainfrom
Open
Conversation
WalkthroughAdded a new Alerts Overview documentation for API Platform Components describing alert types (Latency, Traffic, Status Code), configurable parameters, setup and management steps, notification behavior, and limits; also added an "Alerts" navigation entry under Monitor and Insights in the site config. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@en/docs/monitoring-and-insights/alerts-overview.md`:
- Line 18: Fix grammar and HTTP terminology in the alert descriptions: change
"Latency alerts notify you if the response latency of a API" to "Latency alerts
notify you if the response latency of an API exceeds a predefined threshold in a
given time period." and update any non-standard "status label" wording (seen in
the other alert descriptions at the same section) to the standard term "HTTP
status code" (or "HTTP status") so the alerts consistently use "an API" and
"HTTP status code" where appropriate (search for the exact phrases "a API" and
"status label" in the alert type descriptions and replace them with the
corrected phrases).
- Line 56: The "Configure Alert" heading and several procedural steps (notably
the sections titled "Setup" and "History" and the nearby steps) have
inconsistent capitalization and awkward phrasing; update the headings to
consistent title case (e.g., "Configure Alert"), rewrite the setup and history
step sentences to use consistent imperative voice and parallel structure, fix
capitalization (start sentences with uppercase), and correct punctuation for
clarity across the affected sections ("Configure Alert", "Setup", "History" and
the other nearby step lines referenced in the review).
- Line 6: Replace the sentence "Setting up alerts is only available in the API
level." with "Setting up alerts is only available at the API level." — locate
that exact sentence in alerts-overview content and change the preposition from
"in" to "at" so the note reads "available at the API level."
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 0c85be4d-37d1-45aa-a7f8-fad71ef37373
⛔ Files ignored due to path filters (1)
en/docs/assets/img/monitoring-and-insights/alert-creation.pngis excluded by!**/*.png
📒 Files selected for processing (2)
en/docs/monitoring-and-insights/alerts-overview.mden/mkdocs.yml
nisan-abeywickrama
previously approved these changes
Mar 13, 2026
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@en/docs/monitoring-and-insights/alerts-overview.md`:
- Line 63: Fix the typo and casing in the permissions note by changing the
phrase "inorder" to "in order" and converting "create Alerts" to sentence case
"create alerts" in the sentence that currently reads "You need to have a scope
of **Choreo DevOps** or **Choreo Platform Engineer** inorder to create Alerts."
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 083b44af-f26d-4ce3-b662-8b0ab82f6e64
📒 Files selected for processing (1)
en/docs/monitoring-and-insights/alerts-overview.md
There was a problem hiding this comment.
♻️ Duplicate comments (4)
en/docs/monitoring-and-insights/alerts-overview.md (4)
91-91:⚠️ Potential issue | 🟡 MinorCapitalize sentence start and add Oxford comma.
The sentence starts with lowercase "when" and is missing a comma before "and" (Oxford comma). This was flagged in a previous review.
✏️ Fix capitalization and punctuation
- when editing an alert, you can't edit the **Alert Type**, **Environment** and **Version**. + When editing an alert, you can't edit the **Alert Type**, **Environment**, and **Version**.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/docs/monitoring-and-insights/alerts-overview.md` at line 91, Capitalize the first word of the sentence "when editing an alert, you can't edit the **Alert Type**, **Environment** and **Version**." to "When" and add the Oxford comma before "and" so it reads: "When editing an alert, you can't edit the **Alert Type**, **Environment**, and **Version**." Make this change in the alerts-overview documentation line containing that sentence.
18-18:⚠️ Potential issue | 🟡 MinorFix article: "a API" → "an API".
Line 18 contains a grammatical error that was flagged in a previous review but remains unaddressed.
✏️ Grammar fix
-Latency alerts notify you if the response latency of a API exceeds a predefined threshold within a given time period. This is useful for APIs that need to meet specific SLAs and for proactively identifying slow components. +Latency alerts notify you if the response latency of an API exceeds a predefined threshold within a given time period. This is useful for APIs that need to meet specific SLAs and for proactively identifying slow components.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/docs/monitoring-and-insights/alerts-overview.md` at line 18, Update the sentence in alerts-overview.md that currently reads "a API" to use the correct indefinite article "an" so it reads "an API" in the Latency alerts paragraph; edit the text in the Latency alerts description (the line that starts "Latency alerts notify you if the response latency of a API...") to replace "a API" with "an API".
63-63:⚠️ Potential issue | 🟡 MinorFix spacing and capitalization in permissions note.
The issues "inorder" (should be "in order") and improper capitalization of "Alerts" were flagged previously but remain unaddressed.
✏️ Fix typo and casing
- You need to have a scope of **Choreo DevOps** or **Choreo Platform Engineer** inorder to create Alerts. + You need to have a scope of **Choreo DevOps** or **Choreo Platform Engineer** in order to create alerts.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/docs/monitoring-and-insights/alerts-overview.md` at line 63, Fix the typo and casing in the permissions note: update the sentence that currently reads "You need to have a scope of **Choreo DevOps** or **Choreo Platform Engineer** inorder to create Alerts." by changing "inorder" to "in order" and lowercasing "Alerts" to "alerts" (ensure proper spacing around "in order" and preserve the bolded role names **Choreo DevOps** and **Choreo Platform Engineer**).
44-44:⚠️ Potential issue | 🟡 MinorCorrect HTTP status terminology and grammar.
Multiple issues flagged in previous reviews remain unaddressed:
- "Status code" should be lowercase when mid-sentence
- "Internal Error" is non-standard; the correct HTTP status is "Internal Server Error"
- "help to detect" can be simplified to "help detect"
✏️ Corrections
-A Status code alert is triggered when your API returns specific HTTP error(s) (e.g.: **403** Forbidden, **500** Internal Error). These alerts help to detect issues affecting your component's availability. +A status code alert is triggered when your API returns specific HTTP error(s) (e.g., **403** Forbidden, **500** Internal Server Error). These alerts help detect issues affecting your component's availability.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/docs/monitoring-and-insights/alerts-overview.md` at line 44, In the sentence beginning "A Status code alert is triggered..." in alerts-overview.md, make three edits: lowercase "Status code" to "status code" (since it's mid-sentence), change "Internal Error" to the correct HTTP term "Internal Server Error", and simplify "help to detect" to "help detect" so the sentence reads correctly and uses standard HTTP terminology.
🧹 Nitpick comments (2)
en/docs/monitoring-and-insights/alerts-overview.md (2)
70-73: Reduce repetitive sentence structure.Lines 70-72 all begin with "Select the [field] you want to..." which creates monotonous reading. Consider varying the sentence structure for better flow.
♻️ Suggested rewording
-4. Select the **[Alert Type](`#alert-types`)** you want to create. -5. Select the **Environment** you want to create the alert for. -6. Select the **Version** as required for the API. +4. Select the **[Alert Type](`#alert-types`)** you want to create. +5. Choose the **Environment** for the alert. +6. Specify the **Version** as required for the API. 7. Configure the remaining fields specific to your selected alert type.Based on learnings from static analysis highlighting repetitive "Select" usage.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/docs/monitoring-and-insights/alerts-overview.md` around lines 70 - 73, The three consecutive steps use the same "Select the **[X]** you want to..." phrasing; update the lines for "Alert Type", "Environment", and "Version" to vary sentence structure for better flow (e.g., "Choose the **[Alert Type]** to create.", "Pick the **Environment** for the alert.", "Specify the **Version** required for the API.") while leaving step 7's "Configure the remaining fields..." unchanged; ensure bold/link labels **[Alert Type]**, **Environment**, and **Version** remain exactly as written so anchors and links stay valid.
3-3: Consider simplifying "APIs ecosystem" to "API ecosystem".The phrase "APIs ecosystem" is slightly redundant. Since "ecosystem" is already a collective noun, using the singular "API ecosystem" is more idiomatic.
✏️ Suggested refinement
-This section explains how you can configure alerts for your API Platform Components. Setting up alerts allows you to proactively monitor your APIs ecosystem and take corrective measures when necessary. +This section explains how you can configure alerts for your API Platform Components. Setting up alerts allows you to proactively monitor your API ecosystem and take corrective measures when necessary.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/docs/monitoring-and-insights/alerts-overview.md` at line 3, In the sentence starting "This section explains how you can configure alerts for your API Platform Components..." replace the phrase "APIs ecosystem" with the singular, idiomatic "API ecosystem" (so the sentence reads "...monitor your API ecosystem and take corrective measures when necessary"); update only that phrase to improve wording while preserving the rest of the sentence.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@en/docs/monitoring-and-insights/alerts-overview.md`:
- Line 91: Capitalize the first word of the sentence "when editing an alert, you
can't edit the **Alert Type**, **Environment** and **Version**." to "When" and
add the Oxford comma before "and" so it reads: "When editing an alert, you can't
edit the **Alert Type**, **Environment**, and **Version**." Make this change in
the alerts-overview documentation line containing that sentence.
- Line 18: Update the sentence in alerts-overview.md that currently reads "a
API" to use the correct indefinite article "an" so it reads "an API" in the
Latency alerts paragraph; edit the text in the Latency alerts description (the
line that starts "Latency alerts notify you if the response latency of a
API...") to replace "a API" with "an API".
- Line 63: Fix the typo and casing in the permissions note: update the sentence
that currently reads "You need to have a scope of **Choreo DevOps** or **Choreo
Platform Engineer** inorder to create Alerts." by changing "inorder" to "in
order" and lowercasing "Alerts" to "alerts" (ensure proper spacing around "in
order" and preserve the bolded role names **Choreo DevOps** and **Choreo
Platform Engineer**).
- Line 44: In the sentence beginning "A Status code alert is triggered..." in
alerts-overview.md, make three edits: lowercase "Status code" to "status code"
(since it's mid-sentence), change "Internal Error" to the correct HTTP term
"Internal Server Error", and simplify "help to detect" to "help detect" so the
sentence reads correctly and uses standard HTTP terminology.
---
Nitpick comments:
In `@en/docs/monitoring-and-insights/alerts-overview.md`:
- Around line 70-73: The three consecutive steps use the same "Select the
**[X]** you want to..." phrasing; update the lines for "Alert Type",
"Environment", and "Version" to vary sentence structure for better flow (e.g.,
"Choose the **[Alert Type]** to create.", "Pick the **Environment** for the
alert.", "Specify the **Version** required for the API.") while leaving step 7's
"Configure the remaining fields..." unchanged; ensure bold/link labels **[Alert
Type]**, **Environment**, and **Version** remain exactly as written so anchors
and links stay valid.
- Line 3: In the sentence starting "This section explains how you can configure
alerts for your API Platform Components..." replace the phrase "APIs ecosystem"
with the singular, idiomatic "API ecosystem" (so the sentence reads "...monitor
your API ecosystem and take corrective measures when necessary"); update only
that phrase to improve wording while preserving the rest of the sentence.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: a7007124-7a14-40c7-b3fb-b0151751e342
📒 Files selected for processing (1)
en/docs/monitoring-and-insights/alerts-overview.md
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Purpose
Summary by CodeRabbit