Merge pull request #372 from matrix-org/j94/matrix_api_calls_failed-help

Clarify help of matrix_api_calls_failed metric
matrix-org · Nov 10, 2021 · b57a3f2 · b57a3f2
2 parents 7b4f1eb + 17239f3
commit b57a3f2
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/changelog.d/372.misc b/changelog.d/372.misc
@@ -0,0 +1 @@
+Clarify help text of matrix_api_calls_failed metric
diff --git a/src/components/prometheusmetrics.ts b/src/components/prometheusmetrics.ts
@@ -137,12 +137,12 @@ export class PrometheusMetrics {
     public registerMatrixSdkMetrics(appservice: BotSdkAppservice): void {
         const callCounts = this.addCounter({
             name: "matrix_api_calls",
-            help: "Count of the number of Matrix client API calls made",
+            help: "The number of Matrix client API calls made",
             labels: ["method"],
         });
         const callCountsFailed = this.addCounter({
             name: "matrix_api_calls_failed",
-            help: "Count of the number of Matrix client API calls made",
+            help: "The number of Matrix client API calls which failed",
             labels: ["method"],
         });
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Clarify help text of matrix_api_calls_failed metric