What is StatsHouse?

StatsHouse is an open-source monitoring system that is highly available, scalable, and multitenant. One can hardly overload it—due to aggregation and sampling. It allows your applications to send metric data without limitations, and you can view statistics on a graph in a live mode.

tip

• View the conceptual TLDR.
• Start using StatsHouse in 10 minutes.
• Proceed to User guide or Administrator guide.

Find StatsHouse on GitHub.

What you can do with StatsHouse

Here is what the StatsHouse user interface looks like and what it basically allows you to do:

You have three options to use StatsHouse:

• run StatsHouse locally,
• get access to a StatsHouse cluster deployed in your organization,
• or deploy your own StatsHouse cluster.

What you can find in the docs

Use the 🔍 Search bar in the upper-left corner, or check the table of contents below.

TLDR

Quick start

• Run StatsHouse locally or access the deployed one
• Send metrics from a demo web server
• Create your own metric
• Send data to your metric
• Check basic viewing options

User guide

• Get access to StatsHouse
• Design your metric ← understand what you want from your metric
• Create a metric
• Send metric data
• View data on a graph ← the detailed UI description is here
• Edit a metric
• Create and view dashboards
• Query with PromQL
• Find OpenAPI specification

Administrator guide

• Check system requirements
• Find packages
• Install components
• Monitor StatsHouse
• Ensure security
• Use host metrics
• Manage budgets
• Maintain and upgrade
• Migrate from the other monitoring system
• Integrate the external systems

Overview

• Find more about StatsHouse features.
• Understand the underlying concepts.
• Learn how the StatsHouse components implement all of the above.

Support