Sign In

Catalog Integration

Status pages automatically leverage your existing catalog entities, eliminating manual component creation and ensuring your public status always reflects reality.

Catalog-Driven Architecture

Traditional status page solutions force you to manually create and maintain “components” that duplicate your existing service definitions. This leads to drift, inconsistencies, and maintenance burden.

Upstat takes a fundamentally different approach: your status page directly references catalog entities. There’s no duplication, no drift, and no manual maintenance required.

Entity Selection and Display

Direct Entity Reference

When you create a status page, you select which catalog entities to display. The status page doesn’t create copies—it directly references your live catalog data.

This means:

  • Status updates automatically when monitors detect issues
  • Service relationships display correctly without configuration
  • New services appear as options immediately after catalog creation
  • Renamed entities update everywhere instantly
  • Deleted entities automatically remove themselves

Entity Selection Process

In the Content tab of your status page editor:

  1. Filter by Entity Type - Choose which types to display (Applications, Services, Infrastructure)
  2. Select Specific Entities - Pick individual entities or select entire categories
  3. Organize Display - Arrange entities in groups or hierarchies
  4. Preview Changes - See exactly how your selection appears to visitors

The interface shows “No entities found in catalog” if you haven’t created catalog entities yet—your first step is always to define your service architecture in the catalog.

Integration Workflow

Status Page Creation Process

  1. Select entities from your existing catalog
  2. Configure display options (grouping, ordering)
  3. Set visibility and access controls
  4. Preview and publish

Entity Management

  • Entity updates automatically reflect on status pages
  • Relationships between entities are preserved
  • Status changes propagate without manual intervention
  • New entities become available immediately

Setting Up Catalog Entities

Before creating status pages, establish your catalog:

1. Define Entity Types

Create categories that match your architecture:

  • Applications - Customer-facing services
  • Services - Backend APIs and microservices
  • Infrastructure - Databases, queues, cloud resources
  • External Dependencies - Third-party APIs and services

2. Create Entities

For each service or component:

  • Add descriptive name and identifier
  • Define relationships and dependencies
  • Configure monitoring and alerting
  • Set operational metadata

3. Establish Relationships

Map how entities connect:

  • Service dependencies
  • Infrastructure requirements
  • Team ownership
  • Escalation paths

Real-World Example

Consider a typical e-commerce platform:

Without Catalog Integration:

  1. Create “Website” component manually
  2. Create “API” component manually
  3. Create “Database” component manually
  4. Create “Payment Gateway” component manually
  5. Manually group components
  6. Update each component when architecture changes
  7. Hope documentation stays in sync

With Catalog Integration:

  1. Select “E-Commerce Platform” entity from catalog
  2. Automatically includes all related services
  3. Relationships display correctly
  4. Updates happen automatically
  5. Always matches production architecture

Advanced Features

Entity Filtering

Control which catalog entities appear on status pages:

  • Filter by entity type
  • Filter by tags or metadata
  • Include/exclude by relationship
  • Show only customer-impacting services

Automatic Grouping

Status pages can organize entities automatically:

  • Group by entity type
  • Group by service tier
  • Group by geographic region
  • Group by team ownership

Inheritance & Cascading

Status cascades through relationships:

  • Database issue affects dependent services
  • Infrastructure problems bubble up
  • Maintenance windows propagate correctly
  • Dependencies display accurate impact

Migration Strategy

Moving from traditional status pages:

  1. Catalog First - Build your complete service catalog
  2. Map Components - Match existing components to catalog entities
  3. Test Display - Preview how catalog entities appear
  4. Switch Over - Replace manual components with catalog selection
  5. Deprecate Manual - Remove duplicate component definitions

The catalog becomes your single source of truth, eliminating the maintenance burden of traditional status page solutions.

Performance Considerations

Catalog integration is optimized for speed:

  • Entity data cached at edge locations (<50ms response times)
  • Changes propagate globally within seconds
  • Relationship queries use pre-computed graphs
  • Status aggregation happens at data layer
  • No performance penalty vs manual components

Troubleshooting

“No entities found in catalog”

This message appears when:

  • Catalog hasn’t been configured yet
  • User lacks permission to view entities
  • Entity filters exclude all available options

Solution: Create catalog entities first, then return to status page configuration.

Entities not appearing on public page

Check:

  • Entity is selected in status page configuration
  • Entity visibility settings allow public display
  • Status page is published (not draft)
  • Cache has refreshed (wait 30 seconds)

Status not updating

Verify:

  • Monitors are attached to catalog entities
  • Monitor checks are running successfully
  • Event system is processing status changes
  • Live connections are established

Learn more