Environments

The DX Cloud Environments section contains critical information about your deployment’s health, response times, and overall usage. The environments you see in this section of the Cockpit are those configured in your .gitlab-ci.yml file.

Select desired cluster

Select your desired cluster from the dropdown menu at the top of the Cockpit.

select cluster id

Statistics

The Statistics subsection reveals critical information about your DX Cloud deployment and are broken down in individual tabs on the Cockpit.

Select your Release and Range and apply the filters to display environment statistics.

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

Magnolia Database

The Magnolia Database section displays metrics related to your Magnolia PostgreSQL database and JCR workspaces. Use this dashboard to monitor database size, binary storage, cache performance, and per-workspace storage details.

Select your desired Release and Pod from the sidebar filters as the metrics displayed are specific to these selections.

magnolia database

In addition to the guidance here, there is embedded help available directly in the Cockpit.

Sidebar filters

The sidebar filters allow you to refine your view.

Filter Description

Date range

Select the time period for time series charts using preset ranges or the calendar picker for custom dates.

Memory unit

Choose how to display storage sizes: KB, MB, GB, or TB.

Release

Select the namespace (release) to analyze. Defaults to the first available option.

Pod

Select the specific pod instance to analyze. Defaults to the first available option.

Click Apply filters to update the view with your selected criteria.

Database

The Database tab provides an overview of your Magnolia database metrics from the mgnlDatabase metrics family.

Total size

View the total size of your Magnolia database.

  • Current size: The latest database size measurement.

  • Size over time: A time series chart showing how database size has changed over the selected period.

Binary size

View the total size of binaries (large records in Magnolia, typically assets and documents).

  • Current binary size: The latest measurement of binary storage.

  • Binary size over time: A time series chart showing binary storage trends.

Average binary size

View the average size of individual binary records.

  • Current average: The latest average binary size measurement.

  • Average over time: A time series chart showing how average binary size has changed.

Cache ratio

View the database cache hit ratio, which indicates how effectively the database cache is being utilized.

  • Current cache ratio: The latest cache hit ratio percentage.

  • Cache ratio over time: A time series chart showing cache performance trends.

A higher cache ratio indicates better performance as more queries are served from cache rather than disk.

Workspaces

The Workspaces tab provides detailed metrics for each JCR workspace from the mgnlWorkspace metrics family.

Workspace overview table

The table displays metrics for all workspaces, sorted alphabetically by workspace name.

Column Description

Workspace

The name of the JCR workspace (for example, website, dam, config).

Records

The total number of records in the workspace.

Total size

The complete size of everything PostgreSQL stores for that workspace table.

Table size

The size of table data pages, visibility map, and free space map (excludes indexes and TOAST data).

Index size

The size of indexes associated with the workspace.

Dead tuples

The number of dead tuples (row versions that are no longer visible to any transaction).
A high number of dead tuples may indicate that the database would benefit from a VACUUM operation. For more on the VACUUM command, see PostgreSQL VACUUM documentation.

Workspace details

Click any value in the workspace table to view a detailed time series chart for that specific metric.

  • Click Records to view record count over time.

  • Click Total size to view total workspace size over time.

  • Click Table size to view table size over time.

  • Click Index size to view index size over time.

  • Click Dead tuples to view dead tuple count over time.

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

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

  2. Choose your desired 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 committed.

    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

    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.

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

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

  2. Select your Release and Pod to display your Loggers.

    logger filters

  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 Manage. You can manage both your integration and production (prod) environments here. Within the environment, you are able to manage your DX Cloud 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 Indexes for instructions.

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

4

All containers

Display a list of all containers associated with the environment. Information such as the following is available:

  • State: The current state of the container (e.g., running, terminated)

  • Ready: Whether the container is ready or not. A signals the container is ready.

  • Name: The name of the container.

  • Started: The date and time when the container was started.

  • Finished: The date and time when the container finished.

  • Reason: The reason why the container stopped.

  • Message: A message about the container (if any messages were added).

environment all containers

5

See logs

Takes you directly to any applicable log information. See Logs for more details.

Delete an environment

You can delete an environment directly from the Cockpit.

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

What gets deleted

When you delete an environment, the following components are permanently removed:

Core infrastructure

  • Environment instance: The entire runtime environment

  • All deployed applications: Including Magnolia CMS instances and any custom applications

  • Database: All content, configurations, and user data stored in the environment’s database

  • File storage: All uploaded assets, documents, and media files

Network & security configuration

  • Ingresses: All traffic routing rules and load balancer configurations

  • Secrets: API keys, certificates, passwords, and other sensitive configuration data

  • SSL/TLS certificates: Custom certificates and Let’s Encrypt certificates

  • CDN configuration: Content delivery network settings and cached content

Instructions

  1. Go to Environments > Manage.

  2. Go to the environment that you want to delete.

  3. Click Delete environment.

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

Delete Indexes

You may want to completely delete the indexes 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 > Manage.

  2. Click Delete indexes for the desired environment.

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

PaaS

×

Location

This widget lets you know where you are on the docs site.

You are currently perusing through the DX Cloud docs.

Main doc sections

DX Core Headless PaaS Legacy Cloud Incubator modules