Skip to content

Commit

Permalink
🔀 Merge pull request #2668 metrics-clarity
Browse files Browse the repository at this point in the history
📝 Add clarity to metrics
  • Loading branch information
CollierCZ authored Nov 8, 2022
2 parents 9e71065 + 64da73f commit 03ad14a
Show file tree
Hide file tree
Showing 7 changed files with 23 additions and 13 deletions.
11 changes: 8 additions & 3 deletions docs/src/administration/web/configure-environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,9 +118,13 @@ select it in the tree or list on the left-hand side:
![Services: app overview](/images/management-console/service-tab/app-overview.png "0.5")

The **Overview** tab gives you information about your app.
You can see the language version, the container size, the amount of persistent disk,
the number of active workers and cron jobs, and the command to SSH into the container.
You can also see all cron jobs with their name, frequency, and command.
You can see:

* The language version, the container size, the amount of persistent disk,
the number of cron jobs, and the command to SSH into the container.
* A summary of [metrics for the environment](../../increase-observability/metrics/_index.md).
* All cron jobs with their name, frequency, and command.
* All workers with their name, size, amount of persistent disk, and command to SSH into the container.

To view [the configuration file where your app is set up](../../create-apps/), click **Configuration**.

Expand All @@ -133,5 +137,6 @@ select it in the tree or list on the left-hand side:

The **Overview** gives you information about the selected service.
You can see the service version, the container size, and the disk size, if you've configured a persistent disk.
You can also see a summary of [metrics for the environment](../../increase-observability/metrics/_index.md).

To view the configuration file where your services are set up, click **Configuration**.
20 changes: 11 additions & 9 deletions docs/src/increase-observability/metrics/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,20 +62,22 @@ you might want to consider:

#### {{% names/dedicated-gen-3 %}} environments

For {{% names/dedicated-gen-3 %}} environments, the thresholds are set for each host.
If the resources are high and hovering close to the 100% threshold,
you might want to consider:
For {{% names/dedicated-gen-3 %}} environments, the thresholds are set for each container.

* [Optimizing your code](../integrate-observability/_index.md) (if possible)
If you have one container in a temporary burst state but your host still has plenty of available resources,
it might not be an issue as long as the site is functioning properly.
Burst allows your container to use additional resources when they aren't needed elsewhere.

If you have a container in a prolonged burst state, you might want to consider:

* [Optimizing your code](../integrate-observability/_index.md)
* Changing your [app size](../../create-apps/app-reference.md#sizes)
or [service size](../../add-services/_index.md#size)
* [Increasing your plan](../../administration/pricing/_index.md)

If your containers are in a prolonged burst state,
review your configuration or plan size because burst isn't guaranteed for long periods.
If the burst threshold is triggered for short, infrequent activities,
it might not be an issue as long as the site is functioning properly.
Burst allows your container to use additional resources when they aren't required on the container's host.
You can reallocate your existing resources if other containers have resources they aren't using.

If you have multiple containers in a burst state, review your configuration or plan size.

#### Grid environments

Expand Down
3 changes: 3 additions & 0 deletions docs/src/increase-observability/metrics/grid.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ Infrastructure metrics report CPU, RAM, and disk space for app and worker contai
and CPU and disk space for service containers.
These metrics are available for all of your Grid environments.

You can see summaries of the metrics for each container separately in the Console under **Services** for a given environment.
The full details are available under **Metrics**.

App containers are shown first, with the app name and an image corresponding to the app type.
Service containers follow next with the same pattern and worker containers are shown last.

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/static/images/management-console/service-tab/routes.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion styles/Platform/link-text.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@ level: warning
nonword: true
scope: link
tokens:
- (?<!t)here
- \b(?<!t)here\b
- click here

0 comments on commit 03ad14a

Please sign in to comment.