Skip to content

Wiki

Preview feature

The wiki is switched off by default — menu entry, page, API and the wiki buttons on checks are locked until a super admin enables the area under Admin → System → Preview features. While it is off, the AI does not use the wiki as a source either. The area is not finished yet. Instances that already had self-written articles before the update keep the wiki switched on.

The wiki is the central place for "how we do things", runbooks, service docs, and notes.

Concept

  • Folders (categories) group articles — each tenant has its own. Anyone with access to several tenants switches between them in the wiki; an article can only be placed in a folder of its own tenant. Folder names and article titles are unique per tenant — a duplicate name is rejected with a message.
  • Articles are written in a rich-text editor and stored as Markdown — with a full-text index and, if an embedding model is set up, vector embeddings.
  • Built-in guides: Vesana creates a few articles and folders in every tenant. They can be edited but not deleted.
  • Service linking — an article can be attached to a check type, individual hosts or specific profile checks.
  • AI RAG source — the AI chat and the AI analysis draw from the wiki first.

Create an article

/wiki → New Article.

Field Meaning
Title required, unique per tenant
Category from the list of folders, or "none"
Tags optional, comma-separated
Content rich-text editor

Editor tools: bold, italic, heading, bullet list, numbered list, quote, inline code, link, horizontal rule, undo/redo.

Service linking

An article can be linked to:

  • a check type in general (e.g. all agent_disk checks, regardless of host)
  • a single host (for quirks that only apply to one specific machine)
  • a specific profile check

In the UI, a link is created when you create an article from a check: Create article for this service in a check's wiki suggestion, or Save as Wiki Article in the AI analysis, links the new article to the check type; with Only for host: … additionally only to that host. Editing the article later leaves the links unchanged. Links to individual profile checks and later changes go through the API.

Effect: the wiki suggestion on the check shows linked articles first; the AI analysis uses the wiki as context.

Example: an article "Disk-full runbook" is bound to the check type agent_disk — as soon as a disk-full alert arrives, the runbook is directly reachable, regardless of the specific host.

The article list under /wiki pages in 50 articles at a time and shows a text preview per article. The search field uses full-text search over title and content; every word you type is matched as a word prefix ("postgr" finds "PostgreSQL"). It does not find fragments in the middle of a word.

Semantic search via embeddings is used by the AI (chat and analysis), not by the list's search field.

Embeddings

When an article is saved, an embedding is computed in the background (asynchronously, it doesn't block saving):

  • model: the embedding model configured under AI provider (e.g. nomic-embed-text via Ollama); if none is set, the chat model
  • The vector length adapts to the respective model (e.g. 768 for nomic-embed-text). After switching the embedding model, old and new vectors don't match; the AI then falls back to full-text search for the affected articles instead of failing the request.

Missing embeddings (e.g. after a bulk import or when no provider was configured at save time) are caught up periodically by a background job. While the wiki preview feature is switched off, this job is paused.

Wiki suggestion on a check

On the error overview, the host detail page and in the check detail, a check's wiki button opens a list of matching articles — without an LLM call, purely deterministic:

  1. direct hit via linked articles (check type, profile check, or host)
  2. fallback: full-text search on the service name

If nothing is found, the list offers Create article for this service.

Soft delete

Articles are soft-deleted (see Trash) — deleted means hidden first and gone from the list, physically removed after 30 days. Service links survive a soft delete and are fully back after a restore. "Empty trash" leaves wiki articles in place while the wiki is switched off.

URL Effect
/wiki overview
/wiki?article=<id> open an article directly
/wiki?new=1 new article with an empty modal

Permissions

Permission Effect
wiki.view view articles
wiki.edit edit
wiki.create create new
wiki.delete soft delete

Restoring from the trash needs wiki.create; permanently deleting goes through the general trash permissions.

Next