Sign In

Custom Types & Fields

Define your own entity types and lightweight fields to model your system.

Upstat’s Catalog supports a flexible model where you can create Custom Entity Types and define simple title/value pairs to capture useful metadata.

Built-In Entity Types

Out of the box, Upstat provides a few default entity types:

  • Services – Systems within your organization
  • Customers – Individuals or organizations that consume your services
  • Features – Specific capabilities of your services
  • Products – Goods or services you offer

You can create as many additional entity types as you need.

![Placeholder: Catalog Entity Type Grid Screenshot]

Creating a Custom Entity Type

To create your own:

  1. Go to the Catalog
  2. Click + Custom Entity Type
  3. Give it a name and (optionally) a description
  4. Start adding custom fields (key/value style)

These types are project-scoped and will show up alongside the default types in the Catalog interface.

Defining Custom Fields

Each custom field is:

  • A title and value pair
  • Editable inline per item
  • Optional and order-independent

Fields are intentionally lightweight—no complex field types, constraints, or validation. They’re meant for operational metadata, not structured schemas.

Examples:

  • Team Owner → "SRE"
  • Last Review Date → "2024-10-01"
  • Status Page Label → "Public-facing"
  • Slack Channel → "#alerts-support"

Use Cases

  • Tag customers by account tier
  • Track owners of features or products
  • Annotate services with notes like deprecation plans, links, or tags
  • Add searchable metadata to make filtering easier

Summary

  • You can define your own Catalog entity types
  • All fields are plain key/value strings
  • Useful for documentation, filtering, automation, and search
  • Default types include Services, Products, Features, and Customers
  • Everything is project-scoped and lightweight by design

Learn more