Environments

Your Magnolia PaaS Environments section contains critical information about your deployment’s health, response times, and overall usage. You can view Statistics about the environment by release, component, and date range or you can Manage your environments directly from your Cockpit.

The environments you see in this section of the Cockpit are those configured in your .gitlab-ci.yml file.
environments overview

Statistics

The Statistics tab reveals critical information about your Magnolia PaaS deployment and are broken down between Resources and Cache. You can find out more about each section by clicking the info icon in the Cockpit.

Select your Release, Component, and Date Range to display environment statistics.

This is found at the top of the Statistics page.

show select items

  • Resources

  • Cache

Item Description

Deadlocked threads

Deadlocked threads indicate a blocked request, command, or action to Magnolia.

Deadlocked threads may cause requests, command, and actions to remain uncompleted.

Heap size

The starting size, maximum size, and current size in bytes of the Magnolia instance.

Hover over an item to see more details.

heap size

Heap usage

The percentage of JVM currently used by the Magnolia instance.

Hover over an item to see more details.

heap usage

Memory [MB]

The starting size, maximum size, and current size in bytes for the Magnolia instance over time. The starting and maximum sizes are set at startup and will not change unless Magnolia is restarted.

Move the slider to your desired date range.
Hover over an item to see more details.

memory

Response time & distribution

The current average response time by quantile. The quantiles are 50%, 90%, 95%, and 99% of the measured response times.

Move the slider to your desired date range.
Hover over an item to see more details.

response time distribution

Response time

The average response time by quantile over time. The quantiles are 50%, 90%, 95%, and 99% of the measured response times.

Move the slider to your desired date range.
Hover over an item to see more details.

response time
Item Description

Last flush

The date and time when the Magnolia default page cache was last flushed.

The date and time reflect your current time zone.

Cache hits

Hits on the Magnolia default page cache by request category.

Table 1. Request categories

dam-image

images in Magnolia DAM

dam-font

fonts in Magnolia DAM

dam-video

videos in Magnolia DAM

dam-audio

audio clips in Magnolia DAM)

dam-other

other digital content in Magnolia DAM

resource-image

image resources

resource-javascript

Javascript resources

resource-css

CSS resources

resource-other

other resources

imaging-image

processed images

imaging-video

processed videos

imaging-other

other processed content

magnolia

Magnolia backend requests

rest

Magnolia REST endpoint requests

monitoring

Magnolia monitoring metrics

extension

requests to Magnolia starting with ":"

other

all other requests

JCR content

The Environments tab displays information related to JCR content for your Magnolia PaaS project. From here, you can see metrics on the size of frontend environments within JCR workspaces as well as query or count node types on a workspace.

In this section, you need to select your desired Cluster ID, Release, and Pod as the metrics and results are related to the choices there.

jcr content tab

The subsections below take you through all of the options from this section of the Cockpit.

JCR workspaces

In this JCR workspaces tab, you can see the number of nodes from the nt:base type per JCR workspace. The table displays the name of the workspace and the size of the associated frontend environment.

JCR query

In the JCR query tab, you can see the most common node types in the applicable workspace including those shown below. You can also use the Query generator to county or query a certain node type per selected workspace.

Query generator

To use the JCR Query generator:

  1. Go to Environments > JCR content > JCR query (tab).

  2. Scroll to the Query generator.

    1. Select a Workspace.

    2. Select a Node type.

    3. Select Count or Query.

      Count counts the number of node types per workspace.

      Query queries the node types in a workspace to show you the paths.

query generator

Persistence database

The Persistence database gives you an area to quickly see the size of the database. This is displayed under Database size at the top of the page. You can also see the size per table which is shown in the table on the tab.

Here, you can see:

  • The namespace

  • The database name.

  • The number of rows in the database.

  • The size of the database.

  • The relation size.

  • The index size.

  • The total size of the database.

Frontend metrics

The Frontend metrics tab show you important information about your Frontend environment(s). You can choose the Release, Component, and Date Range to drill down to more specific details.

View the metrics

To view the Frontend metrics:

  1. Go to Environments > Frontend (tab) in your Cockpit.

  2. Choose the Release you want to view.

  3. Choose the Component you want to view.

  4. Select the Date Range for the metrics.

  5. Scroll down to the desired section(s) to see the results:

    Currently, those sections are:

    • Frontend request rate (req/s): The frontend request rate measures the request rate over the specified interval chosen in the Date Range dropdown.

    • Average response time (s): This is the average response time of your Frontend in seconds over the specified interval chosen in the Date Range dropdown.

    • Average response size (bytes): This is the average response size of your Frontend requests in bytes over the specified interval chosen in the Date Range dropdown.

view frontend metrics
Use the slider on each section to narrow down the timeframe if you want.

Manage your environments

Manage your environments via the Cockpit by going to Environments and selecting the Manage tab. You can manage both your integration and production (prod) environments here.

Within the environment, you are able to manage your Magnolia PaaS backend and frontend separately.

The examples and descriptions below apply to both backend and frontend environments as well as both author/public instances.
manage environments
No Item Description

1

Start

Start your environment.

2

Stop

Destroys all instances down to 0 replicas.

3

Delete indexes

Delete the environment’s indexes. See Delete an index for instructions.

Deleting an index shuts down Magnolia. The subsequent restart will be slower, because Magnolia is rebuilding the index.

4

Scale up

Adds a public instance.

This action replicates content and subscriptions.

5

Scale down

Destroys a single public instance.

You can scale down to -1 replicas.

Delete an environment

You can delete an environment directly from the Cockpit.

This action permanently deletes the selected environment and cannot be undone.

Instructions

  1. Go to Environments.

  2. Click the Manage tab.

  3. Scroll to the environment that you want to delete.

  4. Click Delete Environment.

  5. Follow any on-screen instructions for confirming the deletion.

delete environments

Reset the superuser password

In case you get stuck, locked out of the Authoring environment, or simply need to reset the superuser password for your author environment(s), you can do that directly via the Cockpit. Once you reset the superuser password on the author environment, you can publish the new password to the public environment.

You must have administrator privileges to perform this action.

Instructions

  1. Go to Environments.

  2. Click the Manage tab.

  3. Scroll to the environment where you want to reset the password.

  4. On the Authors instance, click the ellipsis to the right.

  5. Choose Reset superuser password. A dialog will pop up

    1. Enter the new password under Create new superuser password.

    2. Confirm the new password under Confirm new superuser password.

    3. Click Reset superuser pass. to officially reset the password.

reset superuser password

Delete an index

You may want to completely delete the index for an environment. This can be done directly through the Cockpit.

Downtime varies depending on the amount of data associated with an index. To reduce the downtime, we use the rollingUpdate approach.

To delete the index folders:

  1. Go to Environments.

  2. Click the Manage tab.

  3. Click Delete indexes for the desired environment.

    delete index

Feedback