Components

StackState Self-hosted v5.0.x

This page describes StackState version 5.0.

Go to the documentation for the latest StackState release.

Overview

A component is anything that has a run-time state and some relation with other components. Some component examples are a load balancer, a database server, a network switch, or a business service. It is possible to define custom components, and they can be anything - the granularity and range can be defined according to the needs. Each component is of a specific type. Types can be configured.

A component consists of:

  1. The name of the component.

  2. An icon in the middle that represents either the component itself or the component type.

  3. The component color represents the component's own health state.

  4. An outer color indicates an unhealthy propagated health state (DEVIATING or CRITICAL). The propagated health state is calculated based on the health state of components or relations that the component depends upon.

Detailed component information

When a component is selected by clicking on it, detailed information about the component is shown in the right panel Selection details tab. This includes:

Click SHOW ALL PROPERTIES to open a pop-up with all details of the component, including the YAML definition.

Grouping

Components of the same type and/or state can optionally be grouped together into a single element. Grouped components are represented by a circle in the topology visualization. The component group will be named <COMPONENT_TYPE> group. For example a group of components with type pod will be named pod group.

The size of the component group's circle in the topology visualization represents the number of components in the group:

  • Less than 100 components = small circle

  • 100 to 150 components = medium circle

  • More than 150 components = large circle

The way in which components are grouped can be customized in the view visualization settings.

Run state

Some components in StackState will report a Run state, for example, AWS EC2 instances. This is different to the health state and indicates the component’s operational state. The run state can be DEPLOYING, DEPLOYED, STARTING, STARTED, STOPPING, STOPPED or UNKNOWN. It is not used in the calculation of a component's health state.

For every change in run state, a Run state changed event is generated. These events are visible in the Events Perspective and can help to correlate changes in the deployment state of components with problems in an environment.

Last updated