Cruncher Config File

Cruncher uses a YAML configuration file to define which adapters and data sources are available. This file tells Cruncher how to connect to your data and what options to use for each adapter.

Location

The config file should be placed at:

~/.config/cruncher/cruncher.config.yaml

Basic Structure

A typical config file looks like this:

# Cruncher configuration file

# Profiles group adapter instances by purpose or environment
profiles:
  default:
    connectors: [grafana, docker]
  production:
    connectors: [grafana]
  testing:
    connectors: [mocked]

# Connectors define individual adapter instances
connectors:
  - type: grafana_browser
    name: grafana
    params:
      grafanaUrl: "https://grafana.example.com"
      uid: "loki-data-source-uid"
      filter:
        - key: "job"
          value: "my-app"
          operator: "="
      querySuffix: []

  - type: loki
    name: loki_direct
    enabled: true
    params:
      url: "http://loki.example.com:3100"
      listenPort: 3100
      filter: []
      querySuffix: []

  - type: docker
    name: docker
    params:
      # Docker-specific params

  - type: mocked_data
    name: mocked
    params:
      # Mocked data has no required params

# UI settings (optional)
ui:
  theme: nord

Field Definitions

profiles object Optional

Named groups of adapter instances. The default profile is used on startup. Each profile contains a connectors array listing adapter instance names to include.

connectors array Required

List of adapter instances. Each item must contain type, name, and params.

type string Required

Adapter type. Supported values: grafana_browser, loki, k8s, docker, coralogix, mocked_data.

name string Required

Unique identifier for this connector instance. Used to reference this connector in profiles.

enabled boolean Optional

Default: true

Whether this connector is active and available for use.

params object Required

Adapter-specific parameters. See each adapter’s documentation for required and optional fields.

ui.theme string Optional

Default: midnight

The colour theme used across the entire UI. Supported values: midnight, nord, dracula, catppuccin.

ui.liveInterval string Optional

Default: 5s

Interval between Live Mode refresh ticks. Must be one of 1s, 3s, 5s, or 10s.

ui.maxLogs number Optional

Default: 100000

Maximum number of log records kept in memory during a session. Oldest records are discarded when the limit is exceeded. Minimum: 1000.

ui.liveAutoStopMinutes number Optional

Default: 30

Minutes after which Live Mode turns itself off automatically. Set to 0 to never auto-stop.

ui.timezone string Optional

Default: local

Controls how all timestamps are displayed across the UI — calendar selector, log rows, histogram, and charts. local uses the machine’s local timezone; utc displays all times in UTC. Both values also affect how times typed in the calendar input are interpreted.

Profiles

Cruncher supports the concept of profiles, allowing you to define multiple sets of connectors and settings in the same config file. Each profile can represent a different environment, use case, or set of data sources.

• The default profile is used automatically when starting Cruncher.
• You can switch profiles to quickly inside the Cruncher platform.

UI Settings

The optional ui section controls appearance preferences:

ui:
  theme: nord                # midnight | nord | dracula | catppuccin
  liveInterval: 5s           # 1s | 3s | 5s | 10s
  maxLogs: 100000
  liveAutoStopMinutes: 30    # 0 to disable auto-stop
  timezone: local            # local | utc

See the Themes documentation for a full description of each theme. See Live Mode for details on liveInterval and maxLogs.

Tip

• Use profiles to easily switch between production, development, or test data sources without editing your main config file each time.
• You can define multiple connectors in the same config file.
• Each adapter may require different parameters—see the adapter documentation for details.
• After editing the config file, restart Cruncher to apply changes.

---

For more details, see the Adapters documentation.