> ## Documentation Index
> Fetch the complete documentation index at: https://docs.molesignal.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Console tour

> Sign in, choose a workspace, find a page, keep the time context, and use the controls that every page shares.

Every page of MoleSignal sits in the same frame: the top bar, the sidebar, and the content. This
page explains the controls they share. The rest of this manual describes the pages of each product
area.

## Sign in

Open the address of the MoleSignal instance and sign in with one of these methods:

| Method | How |
| - | - |
| Email and password | Enter the email and the password of the MoleSignal account. |
| Single sign-on | Select the button of an enabled provider. For an LDAP provider, enter the directory user name and password in the form first. See [Single sign-on](https://docs.molesignal.com/en-US/identity/sso.md). |
| Sign up | **Sign up →** appears only when the instance allows self-registration. A new account either enters at once or waits for an administrator to approve it. |

To reset a forgotten password, select **Forgot password?** and enter the email of the account. The
page answers the same way whether or not the email exists. The link in the email expires after 30
minutes and works once. A new password needs at least 8 characters.

After sign-in, MoleSignal opens the page chosen under **Open after entering workspace** in the personal
[preferences](https://docs.molesignal.com/en-US/account.md#preferences), which is **Home** unless changed.

## Choose a workspace

The UI calls the selected organization a **workspace**. The workspace switcher in the top bar shows
its name, next to the user avatar. Select it to switch to another organization that the account
is a member of.

The dot before the name is the system status light: green while the core API answers, yellow while
the API reports itself degraded, and red while the console cannot reach the API. The console checks
about every 30 seconds, and sooner after a failure.

Switching the workspace loads the permissions of the account in that organization. Pages that the
new role cannot use disappear from the navigation.

> [!NOTE]
>
> The UI says **workspace**. API fields and permission keys say `organization` and `org_id`.

## The top bar

| Control | Purpose |
| - | - |
| **MoleSignal** logo | Opens the personal start page. |
| Sidebar toggle | Collapses the sidebar to icons, or expands it. |
| Search box | Opens the [command palette](#search-with-the-command-palette). |
| Mole Agent | Opens the [Mole Agent](https://docs.molesignal.com/en-US/agent) panel on any page. Shown when the account may use Mole Agent. |
| **NOC Wallboard** | Opens the wallboard mode for a large screen. See [NOC wallboard](https://docs.molesignal.com/en-US/dashboards#noc-wallboard). |
| **Notifications** | Lists sign-ups that wait for approval, status page drafts that wait for approval, and status page automations that need attention. |
| **Help** | Opens this documentation, the keyboard shortcuts, and **About** with the version of the instance. |
| Theme | Switches between the dark and the light theme, and keeps the choice with the account. |
| Workspace switcher | Shows the current workspace and the system status light, and switches the workspace. |
| User avatar | Opens **Account settings**, **Preferences**, **Notify**, **Language**, and **Sign out**. **Sign out** ends the session in every tab of the browser. |

## The sidebar

The sidebar groups the product areas the same way as this manual.

| Group | Area | Purpose |
| - | - | - |
| Home | [**Home**](https://docs.molesignal.com/en-US/home.md) | Intake health, active alerts, on-call, and the quick start. |
| Observe | [**Dashboards**](https://docs.molesignal.com/en-US/dashboards) | Panels and variables that a team watches together. |
| | [**Metrics**](https://docs.molesignal.com/en-US/metrics.md) | PromQL, series, cardinality, and data quality. |
| | [**Logs**](https://docs.molesignal.com/en-US/logs) | Search events, explore fields, and open the context of an event. |
| | [**Traces**](https://docs.molesignal.com/en-US/traces.md) | Find traces, inspect spans, and compare two traces. |
| | [**APM**](https://docs.molesignal.com/en-US/apm) | Service health, endpoints, dependencies, errors, SLOs, and deployments. |
| | [**RUM**](https://docs.molesignal.com/en-US/rum) | Sessions, replays, frontend errors, Web Vitals, and analytics. |
| | [**Profiles**](https://docs.molesignal.com/en-US/profiles.md) | CPU, memory, and contention flame graphs. |
| Reliability | [**Alerts**](https://docs.molesignal.com/en-US/alerting) | Incidents, rules, on-call schedules, escalations, and silences. |
| | [**Synthetics**](https://docs.molesignal.com/en-US/synthetics.md) | Scheduled checks from probe locations. |
| | [**Status pages**](https://docs.molesignal.com/en-US/status-pages) | Incidents and maintenance published for customers. |
| AI ops | [**Mole Agent**](https://docs.molesignal.com/en-US/agent) | Chats, investigations, automations, knowledge, and skills. |
| Data | [**Datasource**](https://docs.molesignal.com/en-US/intake) | Connect a source and verify that data arrives. |
| | [**Streams**](https://docs.molesignal.com/en-US/streams.md) | Schemas, retention, and search jobs. |
| | [**Pipelines**](https://docs.molesignal.com/en-US/pipelines) | Transform, route, and backfill data. |
| | [**Functions**](https://docs.molesignal.com/en-US/functions.md) | Reusable VRL and JavaScript transforms. |
| | [**Extend tables**](https://docs.molesignal.com/en-US/extend-tables.md) | Lookup tables that enrich events. |
| Collaboration | [**Reports**](https://docs.molesignal.com/en-US/reports.md) | Scheduled and shared reports. |
| Admin | [**Identity & Access**](https://docs.molesignal.com/en-US/identity) | Users, roles, groups, teams, tokens, and single sign-on. |
| | [**Settings**](https://docs.molesignal.com/en-US/settings) | Workspace, notification, data, security, and platform settings. |

The sidebar shows only the areas that the permissions of the account allow. Hiding an area never
replaces the check on the server.

Hover over an entry and select its pin to keep it under **Pinned** at the top of the sidebar. Drag
pinned entries to reorder them, and select the pin again to unpin one. The browser keeps the pinned
entries.

## Keep the time context

The time picker in the head of a query page sets the time range of the page.

* The foot of the picker shows the timezone of the times on the page: the personal default until
  another zone is chosen with **Change**. A chosen zone holds for the page, or for the query tab
  on Logs, Traces, and Metrics. **Set as my default timezone** makes it the personal default.
* A jump to another signal keeps the time range and adds the identifiers of the source. For
  example, a jump from a trace to its logs keeps the window of the trace and adds the `trace_id`
  filter.
* Pin the current time as an anchor, and copy a link to the current investigation with its time
  range, from the command palette or with the [shortcuts](#keyboard-shortcuts).

## Search with the command palette

Press `⌘K` or `Ctrl+K`, or select the search box. Type to find:

* pages, streams, services, dashboards, saved views, alert rules, and incidents;
* actions: go to a page, run SQL or PromQL, set the time range to the last 5 minutes up to the
  last 7 days, pin the current time, copy the investigation link, switch the theme or the density,
  open the settings, create a dashboard, an alert, or a pipeline, connect a data source, show the
  keyboard shortcuts, and sign out.

Press `Enter` to open a result. The footer of the palette shows the keys that open a result in a new
[investigation stack](https://docs.molesignal.com/en-US/correlation.md#the-investigation-stack-in-the-ui) or stack it on top of the
current one.

## Keyboard shortcuts

Press `⌘/` or `Ctrl+/`, or open **Help → Keyboard shortcuts**, to list the shortcuts. On Windows and
Linux, `Ctrl` stands for `⌘` and `Alt` for `⌥`.

| Shortcut | Action |
| - | - |
| `⌘K` | Open the command palette. |
| `⌘/` | Show the keyboard shortcuts. |
| `⌘J` | Open or close the Mole Agent panel. |
| `⌘⌥E` | Open the time picker. |
| `⌘⌥P` | Pin or unpin the time anchor. |
| `⌘⌥Y` | Copy the investigation link. |
| `⌘[` / `⌘]` | Move back or forward in the investigation stack. |
| `⌘⌥S` | Go to APM services. |
| `⌘⌥A` | Go to alert incidents. |
| `⌘⌥D` | Go to dashboards. |
| `⌘⌥T` / `⌘⌥L` | Open the investigation stack with a trace or a log search. |
| `⌘⌥R` | Go to the RUM overview. |
| `⌘⌥F` | Go to functions. |
| `⌘⌥I` | Go to Identity & Access. |
| `⌘Esc` | Close the topmost overlay. |

Turn the shortcuts off with **Enable keyboard shortcuts** in the personal
[preferences](https://docs.molesignal.com/en-US/account.md#preferences).

## Investigate a problem

A typical investigation moves through these steps:

**1. Start from the symptom**

Open an incident, a dashboard panel, a slow trace, a frontend error, or a hot profile.

**2. Narrow the time and the resource**

Choose the smallest useful time range, and filter by service, stream, environment, or session.

**3. Move across signals**

Use the correlation actions to open the related traces, logs, metrics, profiles, or RUM
sessions. See [Cross-signal correlation](https://docs.molesignal.com/en-US/correlation.md).

**4. Keep what was learned**

Save the query as a view, add a dashboard panel, create an alert rule, or ask Mole Agent to
investigate and keep the result.

## Language and personal settings

Choose the interface language under **Language** in the user menu. The choice applies at once and
stays with the account, so another browser opens in the same language.

The profile, the theme and the density, the timezone and the date format, the start page, the
personal notifications, and the sessions are under **Account settings**. See
[Account settings](https://docs.molesignal.com/en-US/account.md).

## Next steps

> **[Home](https://docs.molesignal.com/en-US/home.md)**
>
> Read intake health, active alerts, and on-call at a glance.

> **[Connect data](https://docs.molesignal.com/en-US/intake)**
>
> Send logs, metrics, traces, and profiles to the workspace.

> **[Explore logs](https://docs.molesignal.com/en-US/logs)**
>
> Search, filter, inspect context, and save a view.

> **[Account settings](https://docs.molesignal.com/en-US/account.md)**
>
> Set the profile, the preferences, and personal notifications.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.