Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.rootprint.io/llms.txt

Use this file to discover all available pages before exploring further.

The Settings → Indexes section gives admins a single place to inspect every index Quickwit knows about, configure how it is presented in the search UI, manage the data sources that feed it, and delete indexes that are no longer needed.
Index actions proxy directly to the Quickwit metastore. Reads (the index list, fields, and sources) are fetched live from Quickwit, and changes such as deleting an index or toggling a source apply to Quickwit itself, not just Rootprint’s local metadata.

Indexes list

Navigate to Settings → Indexes to see every index currently known to Quickwit. The list is read live from the metastore on each page load, so an index you create in Quickwit appears here on the next refresh with no restart required. Each row shows the index ID and its visibility (Public, Admins, or Hidden). Use the search box to filter by ID, and click any row to open its detail page.

Index detail page

The detail page header shows the index ID and a Delete action. Below it are three tabs: Configuration, Fields, and Sources.

Configuration tab

The Configuration tab holds the Rootprint-specific presentation settings for the index — a display name, search visibility, and the field-role mappings that tell Rootprint which fields carry the log level, message, stacktrace, and search context. These settings live in Rootprint, not Quickwit, and changing them never touches the underlying index data.

Display name

An optional human-readable label shown in the index selector and throughout the search UI. When left blank, Rootprint uses the raw Quickwit index ID. Use a display name to present friendlier names to your users (e.g. “Application Logs” instead of otel-logs-v0_9).

Visibility

Controls which users can see and query the index.
VisibilityWho can access
Public (all)Every signed-in user.
Admins (admin)Admin users only. Regular users cannot see or query the index.
Hidden (hidden)Hidden from the index selector and the search APIs. Admins can still manage the index here, and ingest API keys scoped to a hidden index continue to accept writes.

Field-role mappings

These settings tell Rootprint which fields in your index carry specific log data. The defaults match the OpenTelemetry log schema.
SettingDefaultWhat it controls
Level fieldseverity_textThe field carrying the log severity (e.g. INFO, ERROR, WARN). Drives row color-coding and the severity filter. Required.
Message fieldbody.messageThe primary human-readable message shown per row in the log list. Required.
Traceback fieldattributes.exception.stacktraceDot-notation path to stacktrace data. When set and a log entry contains it, a Traceback tab appears in the log detail drawer. Optional — clear it if your schema has none.
Context fields(none)Fields used for log-context search. Leave empty to search across all fields. Supports dot-notation; entered as tags (press Enter to add).
All field settings accept dot-notation paths to reach nested or JSON-object fields. Because the defaults match the OpenTelemetry log schema, the bundled otel-logs-v0_9 index — and any other index using the same field names — works without configuration. For custom-schema indexes, override the values here so the level, message, and traceback render correctly. If your OTel instrumentation captures exception stacktraces, the default traceback path (attributes.exception.stacktrace) enables the Traceback tab with syntax-highlighted stacktrace rendering.

Fields tab

Lists every field in the index schema with its type and a Fast indicator (whether the field is stored in column-oriented storage for efficient ranges, aggregations, and sorting). Filter by name to find a specific field. This is a read-only view of what Quickwit reports — to change field definitions you must recreate the index in Quickwit.

Sources tab

Data sources are the pipelines Quickwit uses to receive or pull documents for the index — for example the built-in _ingest-api-source that backs the HTTP ingest gateway, or a Kafka or file-based source you have configured in Quickwit. Each row shows the source ID, its type, an enable/disable toggle, and a delete action.
  • Toggle a source off to pause ingestion from it; toggle it back on to resume.
  • Delete removes the source from Quickwit (confirmation required). Ingestion from it stops; you can recreate it by re-ingesting.

Deleting an index

The Delete button in the index header permanently removes the index from Quickwit along with every document, split, and source configured on it. After the Quickwit delete succeeds, Rootprint also cleans up its own records for the index:
  • Field-role and visibility configuration.
  • Per-user preferences, saved queries, views, shared links, and search history tied to the index.
  • Ingest API keys — because each key is scoped to exactly one index, any key pointing at the deleted index is removed.
To prevent accidents, the modal requires you to type the exact index ID before the Delete button becomes active. There is no undo.
  • Indexes — schema details for the built-in OpenTelemetry index and custom index concepts.
  • Create a custom index — the YAML structure for non-OpenTelemetry schemas.
  • HTTP (NDJSON gateway) — how ingest API keys and the gateway interact with these sources.