Catalog Overview
The Catalog is your central inventory for key entities within your business ecosystem. It provides shared understanding and crucial context for operations by organizing services, customers, features, and infrastructure into a connected model.
What the Catalog Provides
The Catalog serves as the backbone of operational context in Upstat. It allows you to:
- Define entities representing services, customers, products, or any system component
- Map relationships showing how entities depend on or connect to each other
- Link monitors to track the health of specific entities
- Surface context during incidents by showing related services and dependencies
- Visualize dependencies through an interactive graph view
Entity Types
The Catalog organizes entities by type. Each entity type groups similar items together.
Built-in Types
Upstat includes several default entity types:
| Type | Purpose |
|---|---|
| Services | Systems and applications within your organization |
| Customers | Individuals or organizations consuming your services |
| Features | Specific capabilities of your services |
| Products | Goods or services you offer |
Custom Types
You can create additional entity types to model anything relevant to your operations. Custom types support:
- Custom name and plural name
- Optional description
- Custom fields for metadata
Entity Details
Each entity in the Catalog displays:
- Name and description identifying the entity
- Custom field values for any fields defined on the entity type
- Escalation policy for progressive notifications
- Operational metrics including counts of active incidents, linked monitors, heartbeats, related services, runbooks, and automations
- Active incidents currently affecting the entity
- Linked monitors tracking the entity’s health
- Entity relationships showing connections to other entities
- Linked runbooks with operational procedures
- Activity log with recent events
How Relationships Work
Relationships define how entities connect. When you create a relationship between two entities, Upstat:
- Displays the relationship on both entities with appropriate labels
- Shows the connection in the dependency graph
- Provides context during incident investigation
Relationship types include:
| Type | Description |
|---|---|
| Depends on | Entity A requires Entity B to function |
| Parent of | Hierarchical container relationship |
| Child of | Inverse of parent relationship |
| Related to | General association |
| Backed by | Service powered by infrastructure |
| Supports | Infrastructure supports a service |
Integration Points
The Catalog connects to other areas of Upstat:
- Monitors - Link monitors to entities to track their health
- Incidents - Associate incidents with affected entities
- Status Pages - Select entities to display on public status pages
- Automations - Trigger workflows based on entity events
- Runbooks - Attach operational procedures to entities
Related Guides
- Custom Types and Fields - Create custom entity types
- Entity Relationships - Map dependencies between entities
- Linking Entities - Connect entities to monitors and incidents