Table of Contents

Manager

The Manager is a frontend-only cluster that the Neos development server proxy automatically launches alongside your cluster. It provides a centralized development dashboard to monitor and interact with all running services: your business cluster, Neos Studio, the Stimulsoft report server, Tenant Management, License Management, Task Scheduler, Neos AI, and Jaeger.

The Manager is accessible from your browser during development at the URL displayed in the terminal when starting the Neos development server proxy.

Dashboard

The Manager dashboard is composed of three areas:

  • A services table listing every running service, with state indicators and action buttons.
  • A set of real-time pie charts providing at-a-glance statistics on backend activity: API requests, background methods, SQL queries, lazy loadings, and database migrations. Clicking a slice in a chart opens the corresponding detailed monitoring view inline below.
  • A list of the latest successful requests, their nested server event rules executions and database queries, along with the durations (in ms) of each of those processes.

Monitored services

The Manager tracks the following services. Some services are optional and only appear in the Manager when explicitly started via a neos run option:

Service neos run option Description
Business cluster (always started) The application you are developing
Neos Studio --studio (default: true) The designer cluster used to edit your cluster's metadata
Tenant Management --multitenant (-mt) The cluster for managing tenants
License Management --license-management (-l) The cluster for managing licenses
Task Scheduler --task-scheduler (-ts) The cluster for scheduling and executing background tasks
Neos AI --neos-ai (-i) The cluster providing AI features
Report service --reporting (-r) The Stimulsoft report server
Jaeger --dapr (-dp) Distributed tracing tool, accessible at http://localhost:16686

Server states

Each service backend, frontend, and Task Runner process is individually tracked. The possible states are:

State Color
Starting Warning (orange)
Started Positive (green)
Broken Danger (red)
Stopping Gray
Stopped Gray

Controlling services

For each service, the Manager provides inline buttons to start, restart, or stop the backend server, the frontend server, and the Task Runner independently.

Viewing server logs

For each business cluster service, a More (⋯) menu provides access to three log views:

  • Backend server logs: Displays the server-side console output. Useful for diagnosing startup errors and runtime exceptions.
  • Task runner logs: Displays the output of the Task Runner service.
  • Frontend server logs: Displays the client-side console output captured from the generated frontend application.

Monitoring REST API calls

Clicking a slice in the Requests pie chart opens the Backend monitoring view, which displays all recorded API calls as a tree. For each call, you can inspect the request hierarchy, its duration (or lazy loading count), and navigate between parent and child operations.

When hovering over a node in the tree, a Jaeger icon appears. Clicking it opens the corresponding distributed trace in Jaeger, where you can see all services involved, the rules executed, the time spent on each step, and the SQL queries run.

Tip

The Jaeger icon always appears on hover, but clicking it only works if Jaeger is running. You can start Jaeger from the services table in the Manager dashboard.

The Full screen action opens the detail panel in a full-size modal for easier reading.

Opening interactive OpenAPI documentation for REST APIs (Swagger)

Each service row that runs a Neos backend (business cluster, Neos Studio, Tenant Management, License Management, Task Scheduler, and Neos AI) has a Swagger button. Clicking it opens the interactive Swagger UI for that service in your browser, where you can explore and test all available REST endpoints. The Report service and Jaeger do not expose a Swagger UI and therefore have no Swagger button.

Note

The Swagger button is disabled when the service backend is not in the Started state.

Note

In multitenant mode, clicking the Swagger button for the business cluster first opens the tenant selection page before redirecting to the Swagger UI.

Opening the started application

Clicking the name of a service in the services table opens that application in your browser. The Manager resolves the correct URL for each service automatically:

Service URL path
Business cluster /
Neos Studio /designer
Tenant Management /tenants
License Management /licenses
Task Scheduler /scheduler
Neos AI /ai
Jaeger http://localhost:16686