OrbVis — a NagVis successor candidate (developer preview, feedback welcome)

My wish would be to run it independent locally on the remote site configuration and all variable data also stored locally. omd backup needs to cover all config and data. As we dont have setup enabled on the remote site it would be necessary that the code is installed centrally via MKP so that it is transported to the remote site via activate changes.
No worries we will only test it in an isolated env.
Pls. let me know if we can help here.

regards

Mike

2 Likes

Hi,

i can’t create a connection. No matter what i enter, i always get the error “Not Found” (orbvis 0.2.0, checkmk Community 2.5.0p2)

I tried with a fresh 2.5.0p2 and version 0.2.0.
Can create multiple connections without errors.

  • the built-in (default) connection is available?
  • can you post a screenshot of the create dialog with the error message?
  • anything in ~var/log/orbvis.log within the site?

Thanks for the update! Our problems regarding the failing backend connection in Checkmk 2.3 have been resolved by version 0.2.0.

1 Like

Thanks for the answer. I figured out the “Not Found” issue. I reinstalled Orbvis several times, and now the connection is created without any problems. However, after the connection is established, I still cannot retrieve my hosts/servisec (No hosts available).

I’m using https with a self-signed certificate. Could this be the cause of the problem?

  • did you run orbvis-setup as site user after installation of the mkp?
  • can you post a screenshot of your connection settings (hide sensible parts)?
  • do you get hosts/services with the default connection?

In the connection settings, I removed the IP address and port, and I can see all my devices. Thanks for the answer.

1 Like

Version 0.2.0 is now also available on the Checkmk Exchange (2.5 only)

1 Like

Release 0.3.0 is now out for testing.

Why not 0.2.1?

This isn’t just bug fixes — it’s a step closer to feeling like a native part of Checkmk. Settings, dialogs and the connection editor now follow the same patterns you already know from WATO.

There’s also one structural change worth highlighting: OrbVis no longer stores its user data under local/. (More on that below.)

What changed?

Try it yourself. Version 0.3.0 is already live on play.checkmk.com.
Highlights — among many others:

  • Settings redesigned in WATO style, with a “modified” badge per group and one-click reset to factory defaults on every field
  • Reworked connection editor with the OMD socket prefilled
  • Board editor: dedicated “+” button to add objects, action bar follows the selected object, draggable properties popup
  • Image library with separate tabs for built-in and uploaded images, search, and drag-and-drop upload for board backgrounds
  • Slimmer detail drawer — easier to keep open while you work
  • Bulk-acknowledge in BI aggregations
  • Board filter now accepts the same prefixes as Checkmk’s quicksearch (h:, s:, hg:, sg:, id:)
  • Polished light theme

Full list in the changelog. :melting_face:

Where does OrbVis live now?

Up to 0.2.0, OrbVis stored everything under $OMD_ROOT/local/share/orbvis/ — boards, the SQLite database, the Python venv, the htdocs bundle and the .env. That worked, but everything under local/ is replicated by Activate Changes to every remote site in a distributed Checkmk cluster — which blew up every snapshot with data that doesn’t belong there.

Starting with 0.3.0:

  • Boards, SQLite DB, venv and htdocs → $OMD_ROOT/var/orbvis/
  • Config (.env) → $OMD_ROOT/etc/orbvis/
  • The only thing that stays under local/ are the small Checkmk GUI bridge plugins (local/lib/python3/cmk/gui/plugins/...) — those are meant to be replicated by Activate Changes, so the OrbVis sidebar entry shows up on remote sites too.

orbvis-setup migrates your existing boards/DB/.env automatically on first run. No manual steps required.

What about my feedback?

I tried to tackle all mentioned problems again — please check if your problem is fixed. Otherwise, reply in this thread.

Where can i find it?

Checkmk Exchange: Checkmk Exchange (2.5 only)
Github: Release OrbVis 0.3.0 · makanakoeln/orbvis · GitHub

How to update?

OMD[SITENAME]:~$ orbvis-setup uninstall && mkp disable orbvis && mkp remove orbvis && mkp add /tmp/orbvis-cmk-2.X.mkp && mkp enable orbvis && orbvis-setup

or

via extension packages

* upload
* disable v.0.2.0
* enable v.0.3.0
* "orbvis-setup" as site user on command line

:red_exclamation_mark: in both cases Str+Shift+R might be needed in the browser :red_exclamation_mark:

Hope you enjoy

6 Likes

Hi _rb,

First, many thanks for all the work you already spent and you will spend in the future in this very welcome project :clap:.

I tried the standalone version 0.3.0 on REL9 against a checkmk 2.3.0p47 remote site.
The connection is successful but I dont see any hosts:

The user has meanwhile admin rights

No hosts available:

Any idea?

Thanks

Michael

Hi Michael,

i think for now you would have to disable Livestatus TCP TLS in the site:

image

At least that way it worked for me after a quick test

1 Like

TLS Support for the standalone version will be available with the next release

2 Likes

Release 0.4.0 is now out for testing.

Why not 0.3.1?

This release goes well beyond bug fixes. Two things stand out: boards learned to build themselves from your monitoring (dynamic groups), and editing a board is now a live, side-by-side experience instead of a blind form. Under the hood, OrbVis also got noticeably lighter — more on that below.

What changed?

Try it yourself. Version 0.4.0 is already live on play.checkmk.com.

Highlights — among many others:

  • Dynamic groups (dyngroup): a new board object that resolves its members live from a Livestatus filter. Type the filter, pick the object type, and the board fills itself — no more hand-placing every host.

  • NagVis classic render mode: render boards 1:1 the way NagVis drew them, for faithful .cfg imports. Selectable per board and globally.

  • Board settings, reworked: a side-by-side live-preview pane reflects every change as you make it, with section jump-navigation, host/group autocomplete, quick clone & export, a keyboard save shortcut, and Checkmk-style confirm/discard dialogs. Flow topology is now edited as a FormSpec.

  • Board overview: a table view, bulk edit/export, bulk-delete via hover checkboxes, and per-board permission gating that hides the columns and actions you can’t use.

  • Better navigation on static boards: wheel-zoom without holding Ctrl, drag-to-pan, and a sticky search bar. The Checkmk quicksearch prefixes (h:, s:, hg:, sg:, id:) now work on flow and radar boards too.

  • Connections: TLS for TCP Livestatus, a transport dropdown, and client-side validation. Invalid entries are now skipped at startup instead of taking the service down with them.

  • Importer fidelity: NagVis textbox font size/weight/alignment, HTML-entity decoding, [name] macros and label_width now carry over.

Full list in the changelog. :melting_face:

One structural change worth highlighting

Up to 0.3.0, OrbVis pushed live state over a WebSocket. Inside Checkmk that meant the site’s double-Apache proxy had to be taught to pass the WebSocket upgrade through — a fiddly per-site bit of config that occasionally bit people.

Starting with 0.4.0, live updates use Server-Sent Events (SSE) instead, with an automatic polling fallback. SSE is just a long-lived HTTP GET, so it rides through the proxy with no upgrade handling at all. You don’t need to do anything — the frontend negotiates the transport on its own.

While we were in there, the backend also dropped SQLAlchemy, Alembic and the websockets library in favour of the Python standard library (sqlite3, a built-in JWT implementation, env parsing). The result is fewer moving parts, a smaller offline wheelhouse for air-gapped MKP installs, and a leaner service overall. One consequence: the local store is now SQLite-only — PostgreSQL is no longer supported. Existing SQLite installs keep working unchanged.

What about my feedback?

I tried to tackle the reported problems again — please check whether yours is fixed. Otherwise, reply in this thread.

Where can I find it?

How to update?

OMD[SITENAME]:~$ orbvis-setup uninstall && mkp disable orbvis && mkp remove orbvis && mkp add /tmp/orbvis-cmk-2.X.mkp && mkp enable orbvis && orbvis-setup

or

via extension packages

  • upload
  • disable v.0.3.0
  • enable v.0.4.0
  • “orbvis-setup” as site user on command line

:exclamation: in both cases Ctrl+Shift+R might be needed in the browser :exclamation:

Hope you enjoy

5 Likes

Hi @_rb,

thanks again for the great work and the quick improvements. Version 0.4.0 works great in our environment.

Currently we’re importing more NagVis maps to migrate to OrbVis, and we noticed that OrbVis stretches map backgrounds automatically to fit the browser window size. For some maps, we would love to disable the stretching and just display the backgrounds in their original resolution. Is there any way to do so (or could it be implemented)?

This should already be possible in the board settings:

image

This is the default for imported nagvis maps (since 0.4.0)

Already tried this new option :slight_smile: But the background still it looks stretched in OrbVis compared to NagVis.

NagVis:

Orbvis:

could reproduce it.
Should be fixed in the next release

Release OrbVis 0.4.1 is now out for testing.

Why a point release?

0.4.1 is all about polish and reliability on top of 0.4.0. There’s no big new headline feature to learn — instead it’s a solid round of fixes that make everyday use smoother: actions land where they should, the live view recovers on its own, large sites stay snappy, and boards read cleanly in both light and dark mode. If you’re already on 0.4.0, this is a safe, low-risk update.

What’s better?

Commands you can trust in distributed setups

Acknowledgements and downtimes now always reach the site the host actually lives on — no more actions quietly going to the wrong place. What you see and what you act on stay in sync, and in replicated setups, activating changes no longer disturbs the running OrbVis service.

A live view that heals itself

If the connection hiccups, the board now reconnects on its own instead of getting stuck waiting. And when something odd happens on the wire, it’s noted in the log rather than silently swallowed — so issues are easier to track down.

Stays fast on large sites

On big installations the host search no longer tries to pull in every hostname at once. It stays responsive even with tens of thousands of hosts.

Flow board

Nodes now carry the familiar acknowledged / in-downtime / notifications-off markers, like the rest of the boards. Next check and “overdue” update live instead of needing a page reload, and the detail drawer and hover tooltip stay current while they’re open. Layouts no longer break or disappear in edge cases, the “showing top N” hint can be dismissed and stays clear of the zoom controls, and the search filters behave as you’d expect.

Easier on the eyes (light & dark)

Tooltips, gauges, graph panels, the search bar and various labels all stay readable in both themes. Board icons keep their contrast on any background, and there are 12 new built-in icons for common kit (switch, load balancer, Docker, firewall, mail, …).

Smoother editing

Background images preview live before you save, the size field shows the right default, and you can no longer accidentally create two boards whose names differ only in capitalization.

Login & safety

Users with Checkmk two-factor authentication can no longer get in with just a password, and the bundled dependencies were refreshed.

A quiet preview: the Folder board

0.4.1 also includes an early, opt-in Folder board — a board that builds itself from your Checkmk SETUP folder structure and rolls the worst status up the tree, so a single glance tells you where the trouble is. It’s experimental and off by default; flip it on under System Settings → Features if you’d like to try it. Early feedback is very welcome — a proper write-up will follow once it’s ready.

How to update?

OMD[SITENAME]:~$ orbvis-setup uninstall && mkp disable orbvis && mkp remove orbvis && mkp add /tmp/orbvis-cmk-2.X.mkp && mkp enable orbvis && orbvis-setup

or

via extension packages

  • upload
  • disable v.0.4.0
  • enable v.0.4.1
  • “orbvis-setup” as site user on command line

:exclamation: in both cases Ctrl+Shift+R might be needed in the browser :exclamation:

Where can I find it?

As always, feedback welcome in this thread.

4 Likes

GeoMap is now working for us. We added for testing a few hundred Hosts with Long/Lat values. Hosts are placed correct. For a better overview following would make sence on Geomap:

  • Show Hosts with Alerts on Top if you have 20 Hosts at the same location.
  • Quickfilter: show only Down Hosts; Show only Hosts with Service Alerts
  • If you start typing in search a hostname show only mathcing hosts on the MAP.
  • If you have many hosts at the same location (long/lat) spread them on the MAP if you are on max zoom. Place arround (long/lat)

nice :slight_smile:

Other board types already had the option to “Show only problems” (icon in the search bar).
This will be available for all board types with the next release.

This should already work if you use the search bar. Non-matching hosts are grayed out.

I will have a look. Thanks for the ideas