Environments

Your Magnolia PaaS Environments section contains critical information about your deployment’s health, response times, and overall usage.

You can:

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 in individual tabs on 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

Requests

The Requests tab displays the following information:

  • Ingress request rate

  • Magnolia request rate

The number of HTTP requests per second and per service at the ingress level.

request ingressLevel

The number of HTTP requests per second and per service at the Magnolia level.

request magnoliaLevel

Responses

The Responses tab displays the following information:

  • Ingress response time

  • Magnolia response time

The average HTTP response time per service at the ingress level.

response ingressLevel

The average HTTP response time per service at the Magnolia level.

response magnoliaLevel

Errors

The Errors tab displays the following information:

  • Application errors (non-503)

  • Service errors (503)

The number of HTTP requests returning an application error (non 503) per service.

The number of HTTP requests returning a service error (503) per service.

Threads

The Threads tab displays the following information:

  • JVM dead locks

  • Tomcat thread pool

The number of thread deadlocks at the JVM level per backend instance.

threads deadLock

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

The size of the Tomcat thread pool per backend instance.

threads threadPool

Memory

The Memory tab displays the following information:

  • Heap size

  • Heap usage

  • Memory

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

Hover over an item to see more details.

heap size

The percentage of JVM currently used by the Magnolia instance.

Hover over an item to see more details.

heap usage

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

CPU

The CPU tab displays CPU Usage:

The CPU usage over time per pod including backend, frontend, and databases.

Storage

The Storage tab displays Storage Usage:

The Storage usage over time per pod including backend, frontend, and databases.

Cache

The Cache tab displays the following information:

  • Last flush

  • Cache hits

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

The date and time reflect your current time zone.

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 count 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.

Vacuum database

If you want to vacuum your database and keep things running a little tighter, you can do that by simply clicking the accordion symbol to the right of your chosen database and clicking the Vacuum button. You’ll be prompted to be sure that’s what you want to do before officially hoovering up that unwanted space.

For more on the VACUUM command, see here.

vacuum database command

Publications

The Publications tab under Environments lets you view publishing operations from the Cockpit. Publishing operations consist of publishing content from Author to Public.

publications tab

View Publications

  1. From your Cockpit, go to Environments > Publications (tab).

  2. Choose your desired Cluster ID and Release from the dropdown menus.

  3. Choose your desired actions from the available tabs.

    • Overview

    • Repartition

    • Logs

    • Error logs

    View the publication operations in this tab.

    1. publishing requests when content is published from Author to Public.

    2. unpublishing requests when content is unpublished.

    3. errors when a publishing error occurs.

    4. committed transactions when content is commited.

    5. rolled back transactions when content is rolled back from Public back to Author.

    6. published content size shows in bytes the total value for publish content

    7. published content time shows in milliseconds how much time it took to publish content

    publications overview

    View Repartition requests per workspace and subscriber in this tab.

    View all Log entries in this tab.

    View all Error Log entries in this tab.

Loggers

The Loggers tab under Environments lets you add Loggers from the Cockpit as opposed to doing it in admincentral within Magnolia itself.

For more on Loggers in Magnolia, see Log Tools app.

Manage Loggers

You can add, adjust levels, and delete Loggers from the Cockpit.

  1. First, in your Cockpit go to Environments > Loggers (tab).

  2. Select your Cluster ID, Release, and Pod to display your Loggers.

  3. Now, you can add, adjust, or delete Loggers.

    • Add Logger

    • Adjust Logger level

    • Delete Logger

    At the top of the page:

    1. Enter a Name and Level for your Logger.

    2. Click Add.

    add logger

    1. Scroll to your desired Logger.

    2. In the Level dropdown menu, select your desired log level[1].

    adjust logger

    1. Scroll to your desired Logger.

    2. Click Delete.

    delete logger

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.

What happens when I delete an index? 🤔

After deleting an index, the system restarts and rebuilds them based on the data found in the persistence database.

Downtime varies depending on the amount of data associated with an index. This duration ranges from seconds to hours depending. To help reduce this 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

1. The levels available are standard Log4J log levels: ALL; TRACE; DEBUG; INFO; WARN; ERROR; FATAL; OFF.
Feedback

PaaS