Skip to content

How uup is organized

Everything you set up sits inside something else. This is the whole picture:

  • Organization: what pays. It holds your Plan, billing and credits.

    • Members: the people in it, each with a Role and the Projects they reach.
    • Projects: each one product or website, such as acme.com.

      • Monitors: each one thing we watch, such as a website, an API, a port on a server, or a scheduled job that calls us.

        • Checks: each one question asked of a Monitor, such as whether it answers, how fast, and when its certificate or domain runs out.

          • Incidents: each a confirmed failure on one Check, open until it recovers.
      • Channels: where alerts arrive, such as an email list, Slack, a phone number or the Inbox in the dashboard.
      • Notification rules: which news goes to which Channels, for the Monitors each rule is given to.
      • Status page: one public page that shows your own customers how its Monitors are doing.

Your Organization is made when you sign up, and you are its owner. You pay for it, and its Plan sets how many Projects, Monitors and Members it can have. You can also be a Member of other people’s Organizations, by Invitation.

A Project is one product or one website. A subdomain such as shop.acme.com is a Monitor inside the acme.com Project, not a Project of its own. The switcher at the top of the dashboard’s sidebar moves you between Projects. Organizations and Projects says how to create, rename and delete them.

A Monitor watches one thing, and what it watches never changes: watching another address is a new Monitor. Each Monitor asks one or more questions, its Checks, and each Check has its own status.

An Incident opens when we have made sure a Check is failing, and closes when it recovers. Each Check has at most one open Incident at a time. How a failure is confirmed says how we make sure, and Incidents what opens and ends one.

Channel, Notification rule and Status page

Section titled “Channel, Notification rule and Status page”

A Channel is one place an alert can arrive. A Notification rule says which news goes to which Channels, and you give each Monitor the rules it should follow. The Status page shows the Monitors you place on it to anyone with its address.

Every person in an Organization has a Role, which says what they may do, and a set of Projects, which says where. Members and Roles has the full table.