Reference Elixir metrics (tuist#6449)

hiltonc · Jun 29, 2024 · b9003a6 · b9003a6
1 parent 242180b
commit b9003a6
Show file tree

Hide file tree

Showing 3 changed files with 269 additions and 41 deletions.
diff --git a/docs/.vitepress/config.mjs b/docs/.vitepress/config.mjs
@@ -35,15 +35,18 @@ function generateNestedSidebarItems(items) {
   const nestedItems = {};
 
   items.forEach((item) => {
-    const category = item.category
+    const category = item.category;
     if (!nestedItems[category]) {
       nestedItems[category] = {
         text: capitalize(category),
         collapsed: true,
         items: [],
       };
     }
-    nestedItems[category].items.push({ text: item.title, link: `/reference/cli/${item.command}` });
+    nestedItems[category].items.push({
+      text: item.title,
+      link: `/reference/cli/${item.command}`,
+    });
   });
 
   function isLinkItem(item) {
@@ -68,7 +71,6 @@ function generateNestedSidebarItems(items) {
   return convertToArray(nestedItems);
 }
 
-
 const cliData = cliDataLoader.load();
 
 const cliSidebar = {
@@ -202,6 +204,12 @@ const guideSidebar = [
       {
         text: "On-premise",
         link: "/cloud/on-premise",
+        items: [
+          {
+            text: "Metrics",
+            link: "/cloud/on-premise/metrics",
+          },
+        ],
       },
     ],
   },

diff --git a/docs/docs/cloud/on-premise.md b/docs/docs/cloud/on-premise.md
@@ -313,41 +313,4 @@ services:
 volumes:
   db:
     driver: local
-```
-
-## Metrics
-
-You can ingest metrics gathered by the Tuist server using [Prometheus](https://prometheus.io/) and a visualization tool such as [Grafana](https://grafana.com/) to create a custom dashboard tailored to your needs. The Prometheus metrics are served via the `/metrics` endpoint. The Prometheus' [scrape_interval](https://prometheus.io/docs/introduction/first_steps/#configuring-prometheus) should be set as less than 10_000 seconds (we recommend keeping the default of 15 seconds).
-
-### Runs metrics
-
-A set of metrics related to Tuist Runs.
-
-#### `tuist_runs_total` (counter)
-
-The total number of Tuist Runs.
-
-**Tags:**
-- `name` – name of the `tuist` command that was run, such as `build`, `test`, etc.
-- `is_ci` – a boolean indicating if the executor was a CI or a developer's machine.
-- `status` – `0` in case of `success`, `1` in case of `failure`
-
-#### `tuist_runs_duration_milliseconds` (histogram)
-
-The total duration of each tuist run in milliseconds.
-
-**Tags:**
-- `name` – name of the `tuist` command that was run, such as `build`, `test`, etc.
-- `is_ci` – a boolean indicating if the executor was a CI or a developer's machine.
-- `status` – `0` in case of `success`, `1` in case of `failure`
-
-### Cache metrics
-
-A set of metrics related to the Tuist Cache.
-
-#### `tuist_cache_events_total` (counter)
-
-The total number of Tuist Binary Cache events.
-
-**Tags:**
-- `event_type`: Can be either of `local_hit`, `remote_hit`, or `miss`.
+```
diff --git a/docs/docs/cloud/on-premise/metrics.md b/docs/docs/cloud/on-premise/metrics.md
@@ -0,0 +1,257 @@
+---
+title: On-premise metrics
+titleTemplate: ':title - Tuist Cloud'
+description: Optimize your build times by caching compiled binaries and sharing them across different environments.
+---
+
+
+# Metrics
+
+You can ingest metrics gathered by the Tuist server using [Prometheus](https://prometheus.io/) and a visualization tool such as [Grafana](https://grafana.com/) to create a custom dashboard tailored to your needs. The Prometheus metrics are served via the `/metrics` endpoint. The Prometheus' [scrape_interval](https://prometheus.io/docs/introduction/first_steps/#configuring-prometheus) should be set as less than 10_000 seconds (we recommend keeping the default of 15 seconds).
+
+## Elixir metrics
+
+By default we include metrics of the Elixir runtime, [BEAM](https://en.wikipedia.org/wiki/BEAM_(Erlang_virtual_machine)), Elixir, and some of the libraries we use. The following are some of the metrics you can expect to see:
+- [Application](https://hexdocs.pm/prom_ex/PromEx.Plugins.Application.html)
+- [BEAM](https://hexdocs.pm/prom_ex/PromEx.Plugins.Beam.html)
+- [Phoenix](https://hexdocs.pm/prom_ex/PromEx.Plugins.Phoenix.html)
+- [Phoenix LiveView](https://hexdocs.pm/prom_ex/PromEx.Plugins.PhoenixLiveView.html)
+- [Ecto](https://hexdocs.pm/prom_ex/PromEx.Plugins.Ecto.html)
+- [Oban](https://hexdocs.pm/prom_ex/PromEx.Plugins.Oban.html)
+
+We recommend checking those pages to know which metrics are available and how to use them.
+
+## Runs metrics
+
+A set of metrics related to Tuist Runs.
+
+### `tuist_runs_total` (counter)
+
+The total number of Tuist Runs.
+
+#### Tags
+
+| Tag | Description |
+|--- | ---- |
+| `name` | The name of the `tuist` command that was run, such as `build`, `test`, etc. |
+| `is_ci` | A boolean indicating if the executor was a CI or a developer's machine. |
+| `status` | `0` in case of `success`, `1` in case of `failure`. |
+
+### `tuist_runs_duration_milliseconds` (histogram)
+
+The total duration of each tuist run in milliseconds.
+
+#### Tags
+
+| Tag | Description |
+|--- | ---- |
+| `name` | The name of the `tuist` command that was run, such as `build`, `test`, etc. |
+| `is_ci` | A boolean indicating if the executor was a CI or a developer's machine. |
+| `status` | `0` in case of `success`, `1` in case of `failure`. |
+
+## Cache metrics
+
+A set of metrics related to the Tuist Cache.
+
+### `tuist_cache_events_total` (counter)
+
+The total number of Tuist Binary Cache events.
+
+#### Tags
+
+| Tag | Description |
+|--- | ---- |
+| `event_type` | Can be either of `local_hit`, `remote_hit`, or `miss`. |
+
+---
+
+## Storage metrics
+
+A set of metrics related to the storage of artifacts in a remote storage (e.g. s3).
+
+> [!TIP]
+> These metrics are useful to understand the performance of the storage operations and to identify potential bottlenecks.
+
+### `tuist_storage_get_object_size_size_bytes` (histogram)
+
+The size (in bytes) of an object fetched from the remote storage.
+
+#### Tags
+
+| Tag | Description |
+|--- | ---- |
+| `object_key` | The lookup key of the object in the remote storage. |
+
+
+### `tuist_storage_get_object_size_duration_miliseconds` (histogram)
+
+The duration (in milliseconds) of fetching an object size from the remote storage.
+
+#### Tags
+
+| Tag | Description |
+|--- | ---- |
+| `object_key` | The lookup key of the object in the remote storage. |
+
+
+### `tuist_storage_get_object_size_count` (counter)
+
+The number of times an object size was fetched from the remote storage.
+
+#### Tags
+
+| Tag | Description |
+|--- | ---- |
+| `object_key` | The lookup key of the object in the remote storage. |
+
+### `tuist_storage_delete_all_objects_duration_milliseconds` (histogram)
+
+The duration (in milliseconds) of deleting all objects from the remote storage.
+
+#### Tags
+
+| Tag | Description |
+|--- | ---- |
+| `project_slug` | The project slug of the project whose objects are being deleted. |
+
+
+### `tuist_storage_delete_all_objects_count` (counter)
+
+The number of times all project objects were deleted from the remote storage.
+
+#### Tags
+
+| Tag | Description |
+|--- | ---- |
+| `project_slug` | The project slug of the project whose objects are being deleted. |
+
+
+### `tuist_storage_multipart_start_upload_duration_milliseconds` (histogram)
+
+The duration (in milliseconds) of starting an upload to the remote storage.
+
+#### Tags
+
+| Tag | Description |
+|--- | ---- |
+| `object_key` | The lookup key of the object in the remote storage. |
+
+### `tuist_storage_multipart_start_upload_duration_count` (counter)
+
+The number of times an upload was started to the remote storage.
+
+#### Tags
+
+| Tag | Description |
+|--- | ---- |
+| `object_key` | The lookup key of the object in the remote storage. |
+
+
+### `tuist_storage_get_object_as_string_duration_milliseconds` (histogram)
+
+The duration (in milliseconds) of fetching an object as a string from the remote storage.
+
+#### Tags
+
+| Tag | Description |
+|--- | ---- |
+| `object_key` | The lookup key of the object in the remote storage. |
+
+### `tuist_storage_get_object_as_string_count` (count)
+
+The number of times an object was fetched as a string from the remote storage.
+
+#### Tags
+
+| Tag | Description |
+|--- | ---- |
+| `object_key` | The lookup key of the object in the remote storage. |
+
+
+### `tuist_storage_check_object_existence_duration_milliseconds` (histogram)
+
+The duration (in milliseconds) of checking the existence of an object in the remote storage.
+
+#### Tags
+
+| Tag | Description |
+|--- | ---- |
+| `object_key` | The lookup key of the object in the remote storage. |
+
+### `tuist_storage_check_object_existence_count` (count)
+
+The number of times the existence of an object was checked in the remote storage.
+
+#### Tags
+
+| Tag | Description |
+|--- | ---- |
+| `object_key` | The lookup key of the object in the remote storage. |
+
+### `tuist_storage_generate_download_presigned_url_duration_milliseconds` (histogram)
+
+The duration (in milliseconds) of generating a download presigned URL for an object in the remote storage.
+
+#### Tags
+
+| Tag | Description |
+|--- | ---- |
+| `object_key` | The lookup key of the object in the remote storage. |
+
+
+### `tuist_storage_generate_download_presigned_url_count` (count)
+
+The number of times a download presigned URL was generated for an object in the remote storage.
+
+#### Tags
+
+| Tag | Description |
+|--- | ---- |
+| `object_key` | The lookup key of the object in the remote storage. |
+
+### `tuist_storage_multipart_generate_upload_part_presigned_url_duration_milliseconds` (histogram)
+
+The duration (in milliseconds) of generating a part upload presigned URL for an object in the remote storage.
+
+#### Tags
+
+| Tag | Description |
+|--- | ---- |
+| `object_key` | The lookup key of the object in the remote storage. |
+| `part_number` | The part number of the object being uploaded. |
+| `upload_id` | The upload ID of the multipart upload. |
+
+### `tuist_storage_multipart_generate_upload_part_presigned_url_count` (count)
+
+The number of times a part upload presigned URL was generated for an object in the remote storage.
+
+#### Tags
+
+| Tag | Description |
+|--- | ---- |
+| `object_key` | The lookup key of the object in the remote storage. |
+| `part_number` | The part number of the object being uploaded. |
+| `upload_id` | The upload ID of the multipart upload. |
+
+### `tuist_storage_multipart_complete_upload_duration_milliseconds` (histogram)
+
+The duration (in milliseconds) of completing an upload to the remote storage.
+
+#### Tags
+
+| Tag | Description |
+|--- | ---- |
+| `object_key` | The lookup key of the object in the remote storage. |
+| `upload_id` | The upload ID of the multipart upload. |
+
+
+### `tuist_storage_multipart_complete_upload_count` (count)
+
+The total number of times an upload was completed to the remote storage.
+
+#### Tags
+
+| Tag | Description |
+|--- | ---- |
+| `object_key` | The lookup key of the object in the remote storage. |
+| `upload_id` | The upload ID of the multipart upload. |