Links

Components and Groups

Understand Components and Groups, their distinctions, and leverage their capabilities. Discover actionable insights and take control with ease.
Components are the functional units of your service or IT infrastructure. For instance, your websites, API endpoints, databases, and mobile applications, are all components.
🔹 Best Practice Tip 🔹 We recommend creating a component for every functional or architectural division of your infrastructure. Resources or services used by the end user can be helpful additions.
Some more examples of components include:
  • Authentication and Authorization Services
  • Messaging Services
  • Payment Gateway
  • Cloud Services
  • Knowledge Base/ Support Portal
  • External Dependencies/ Third-party Services

What components should you add?

The answer is almost always, "It depends". However, a helpful guideline is to include a component for each significant functional or architectural division within your service.

Status of a Component

To convey the current state of each component, they are assigned one of the five following statuses:
Status
Description
Operational
This status indicates that the component is functioning as expected and in a timely manner. It is also the default state.
Under Maintenance
This status indicates that the component is currently undergoing maintenance work.
Degraded
When a component's performance is impacted in a minor way, such as being slower than usual due to high traffic, it is considered degraded. In this case, all or most components may be affected, leading to a severe impact on the overall experience.
Partial Outage
If only some components are down, resulting in an impact on a subset of customers, it is considered a minor or partial outage. For example, if a specific data center is down and only affects a subset of customers, while the rest are unaffected, it would be categorized as a partial outage.
Major Outage
A component is marked as a major outage when it becomes completely unavailable. If many components are down, it can significantly impact the overall experience.

Components & Component Groups

If a Component is a single resource necessary to your operations, Component Groups are related resources grouped together to make it easy for visitors to inspect.
By grouping similar functional services or resources, you can establish a component group, which contributes to a more organized and comprehensible appearance of the status page.

Edit Components and Component Groups

To edit components and groups,
  1. 1.
    Navigate to Status Page -> select or search for your desired status page.
  2. 2.
    Click on the status page to navigate to the Status Page Details page.
  3. 3.
    In the top right, click More -> Page Components.
  4. 4.
    Click Add Components, to add individual components.
    1. 1.
      Enter the Component name
    2. 2.
      Check to Allow users to subscribe to the component
    3. 3.
      Enter an optional Description
    4. 4.
      You can add this component to a group by clicking Add Component to a Group -> select the component group.
  5. 5.
    Click Add Component Group, to add a component group.
    1. 1.
      Enter the Component Group name
    2. 2.
      Click Save
  6. 6.
    Once you have entered your preferred components and groups, click Save.
Note: Please note that you have the flexibility to reorder the list of Components and Component Groups by simply dragging and rearranging them.

Delete Component and Component Group

To delete a component,
  1. 1.
    Navigate to Status Page -> select or search for your desired status page.
  2. 2.
    Click on the status page to navigate to the Status Page Details page.
  3. 3.
    In the top right, click More -> Page Components.
  4. 4.
    On hovering over any component group, click Delete Group
  5. 5.
    A confirmation modal will open, click Delete
  6. 6.
    You have to reassign the components of this group before deleting the component group and selecting the component group to assign the components.
  7. 7.
    Click Reassign and Delete.
Note: Kindly note that it is advisable to reassign the components before deleting them.
Have any questions? Ask the community.