From 844121d717528ee784aa1811914d79c26d474587 Mon Sep 17 00:00:00 2001 From: Tharindu Weerasinghe <52607043+tharindu-nw@users.noreply.github.com> Date: Thu, 19 Sep 2024 08:13:01 +0530 Subject: [PATCH 1/3] Fix typo in observability BBE --- examples/gauge-metrics/gauge_metrics.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/gauge-metrics/gauge_metrics.md b/examples/gauge-metrics/gauge_metrics.md index b76bd67051..ac91109153 100644 --- a/examples/gauge-metrics/gauge_metrics.md +++ b/examples/gauge-metrics/gauge_metrics.md @@ -1,6 +1,6 @@ # Gauge-based metrics -Ballerina supports Observability out of the box and Metrics is one of the three important aspects of the bservability. To observe Ballerina code, the build time flag `--observability-included` should be given along with the `Config.toml` file when starting the service. The `Config.toml` file contains the required runtime configurations related to observability. +Ballerina supports Observability out of the box and Metrics is one of the three important aspects of the observability. To observe Ballerina code, the build time flag `--observability-included` should be given along with the `Config.toml` file when starting the service. The `Config.toml` file contains the required runtime configurations related to observability. The developers can define and use metrics to measure their own logic. A gauge is one type of the metrics that is supported by default in Ballerina, and it represents a single numerical value that can arbitrarily go up and down, and also based on the statistics configurations provided to the Gauge, it can also report the statistics such as max, min, mean, percentiles, etc. From 0f3280b6e635fb0132c9643b0a24e10c23b77aca Mon Sep 17 00:00:00 2001 From: Tharindu Weerasinghe <52607043+tharindu-nw@users.noreply.github.com> Date: Thu, 19 Sep 2024 08:26:54 +0530 Subject: [PATCH 2/3] Rearrange bbe menu --- examples/index.json | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/examples/index.json b/examples/index.json index 6a45c8a9f1..6b5d4fc039 100644 --- a/examples/index.json +++ b/examples/index.json @@ -4931,15 +4931,6 @@ "disableVerificationReason": "Includes ballerinax components", "disablePlayground": true, "isLearnByExample": false - }, - { - "name": "Counter-based metrics", - "url": "counter-metrics", - "verifyBuild": false, - "verifyOutput": false, - "disableVerificationReason": "Includes ballerinax components", - "disablePlayground": true, - "isLearnByExample": false } ] }, @@ -4956,6 +4947,15 @@ "disableVerificationReason": "Includes ballerinax components", "disablePlayground": true, "isLearnByExample": false + }, + { + "name": "Counter-based metrics", + "url": "counter-metrics", + "verifyBuild": false, + "verifyOutput": false, + "disableVerificationReason": "Includes ballerinax components", + "disablePlayground": true, + "isLearnByExample": false } ] } From 851d7a8684430257255c5894fae451c3189f612d Mon Sep 17 00:00:00 2001 From: Tharindu Weerasinghe <52607043+tharindu-nw@users.noreply.github.com> Date: Thu, 19 Sep 2024 09:34:31 +0530 Subject: [PATCH 3/3] Add review suggestion Co-authored-by: Maryam Ziyad --- examples/gauge-metrics/gauge_metrics.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/gauge-metrics/gauge_metrics.md b/examples/gauge-metrics/gauge_metrics.md index ac91109153..2b25a0bf9b 100644 --- a/examples/gauge-metrics/gauge_metrics.md +++ b/examples/gauge-metrics/gauge_metrics.md @@ -1,6 +1,6 @@ # Gauge-based metrics -Ballerina supports Observability out of the box and Metrics is one of the three important aspects of the observability. To observe Ballerina code, the build time flag `--observability-included` should be given along with the `Config.toml` file when starting the service. The `Config.toml` file contains the required runtime configurations related to observability. +Ballerina supports observability out of the box and metrics is one of the three key components of observability. To observe Ballerina code, the build time flag `--observability-included` should be given along with the `Config.toml` file when starting the service. The `Config.toml` file should contain the required runtime configurations related to observability. The developers can define and use metrics to measure their own logic. A gauge is one type of the metrics that is supported by default in Ballerina, and it represents a single numerical value that can arbitrarily go up and down, and also based on the statistics configurations provided to the Gauge, it can also report the statistics such as max, min, mean, percentiles, etc.