chore: update docs

validaoxyz · Oct 6, 2024 · 7e247f9 · 7e247f9
1 parent 40ee984
commit 7e247f9
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 4 deletions.
diff --git a/LICENSE b/LICENSE
@@ -12,3 +12,4 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
diff --git a/README.md b/README.md
@@ -123,7 +123,8 @@ hl_validator_count
 hl_software_version_info
 hl_software_up_to_date
 hl_latest_block_time
-hl_apply_duration_seconds 
+hl_apply_duration_seconds
+hl_block_time_milliseconds_bucket
 ```
 To see an example of how to query these metrics in Grafana, see the example dashboard provided [in this repository](./grafana/). To understand what these metrics mean, see the [metrics documentation](./internal/metrics/).
 
@@ -141,3 +142,4 @@ Adjust the logging level using the flag `--log-level` with values: `debug`, `inf
 ## Contributing
 
 Contributions are greatly appreciated. Please submit a PR or open an issue on GitHub.
+
diff --git a/internal/metrics/README.md b/internal/metrics/README.md
@@ -37,13 +37,17 @@ hl_latest_block_time * 1000
 - Type: Histogram
 - Description: Distribution of block apply durations in seconds.
 
-- Type: Histogram
-- Description: Distribution of block apply durations in seconds.
-
 Buckets: [0.0001, 0.0002, 0.0005, 0.001, 0.002, 0.005, 0.01, 0.02, 0.05, 0.1, 0.2, 0.5, 1, 2, 5, 10, 20, 50, 100]
 
 Usage: Provides insights into the performance of block application which can help identify potential bottlenecks or performance issues.
 
+### hl_block_time_milliseconds
+
+Type: Histogram
+Description: Histogram of time between blocks in milliseconds.
+
+Usage: Similar to `hl_apply_duration_seconds`, but for the time between blocks.
+
 #### Sample queries
 ```promql
 # Median apply duration over the last 5 minutes
@@ -213,3 +217,4 @@ hl_validator_count - hl_validator_count offset 24h
 # Alert if validator count drops below a threshold
 hl_validator_count < 50
 ```
+
Original file line number	Diff line number	Diff line change
Expand Up		@@ -12,3 +12,4 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
		WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
		COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
		OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.