LogoLogo
StackState.comDownloadSupportExplore playground
StackState v5.1
StackState v5.1
  • Welcome to the StackState docs!
  • StackState self-hosted v5.1 docs
  • Getting Started
  • 🚀Setup
    • Install StackState
      • Requirements
      • Kubernetes / OpenShift
        • Kubernetes install
        • OpenShift install
        • Required Permissions
        • Non-high availability setup
        • Override default configuration
        • Configure storage
        • Configure Ingress
        • Install from custom image registry
        • Migrate from Linux install
      • Linux
        • Before you install
        • Download
        • Install StackState
        • Install with production configuration
        • Install with development configuration
        • Install with POC configuration
        • Set up a reverse proxy
        • Set up TLS without reverse proxy
      • Initial run guide
      • Troubleshooting
    • Upgrade StackState
      • Steps to upgrade
      • Version specific upgrade instructions
      • StackPack versions
      • StackState release notes
    • StackState Agent
      • About StackState Agent V3
      • Docker
      • Kubernetes / OpenShift
      • Linux
      • Windows
      • Advanced Agent configuration
      • Use an HTTP/HTTPS proxy
      • Agent V1 (legacy)
      • Migrate Agent V1 to Agent V2
        • Linux
        • Docker
    • StackState CLI
      • CLI: sts
      • CLI: stac (deprecated)
      • Comparison between CLIs
    • Data management
      • Backup and Restore
        • Kubernetes backup
        • Linux backup
        • Configuration backup
      • Data retention
      • Clear stored data
  • 👤Use
    • Concepts
      • The 4T data model
      • Components
      • Relations
      • Health state
      • Layers, Domains and Environments
      • Perspectives
      • Anomaly detection
      • StackState architecture
    • StackState UI
      • Explore mode
      • Filters
      • Views
        • About views
        • Configure the view health
        • Create and edit views
        • Visualization settings
      • Perspectives
        • Topology Perspective
        • Events Perspective
        • Traces Perspective
        • Metrics Perspective
      • Timeline and time travel
      • Analytics
      • Keyboard shortcuts
    • Checks and monitors
      • Checks
      • Add a health check
      • Anomaly health checks
      • Monitors
      • Manage monitors
    • Problem analysis
      • About problems
      • Problem lifecycle
      • Investigate a problem
      • Problem notifications
    • Metrics
      • Telemetry streams
      • Golden signals
      • Top metrics
      • Add a telemetry stream
      • Browse telemetry
      • Set telemetry stream priority
    • Events
      • About events
      • Event notifications
      • Manage event handlers
    • Glossary
  • 🧩StackPacks
    • About StackPacks
    • Add-ons
      • Autonomous Anomaly Detector
      • Health Forecast
    • Integrations
      • About integrations
      • 💠StackState Agent V2
      • 💠AWS
        • AWS
        • AWS ECS
        • AWS X-ray
        • StackState/Agent IAM role: EC2
        • StackState/Agent IAM role: EKS
        • Policies for AWS
        • AWS (legacy)
        • Migrate AWS (legacy) to AWS
      • 💠Dynatrace
      • 💠Kubernetes
      • 💠OpenShift
      • 💠OpenTelemetry
        • About instrumentations
        • AWS NodeJS Instrumentation
        • Manual Instrumentation
          • Prerequisites
          • Tracer and span mappings
          • Relations between components
          • Span health state
          • Merging components
          • Code examples
      • 💠ServiceNow
      • 💠Slack
      • 💠Splunk
        • Splunk
        • Splunk Events
        • Splunk Health
        • Splunk Metrics
        • Splunk Topology
      • 💠VMWare vSphere
      • Apache Tomcat
      • Azure
      • Cloudera
      • Custom Synchronization
      • DotNet APM
      • Elasticsearch
      • Humio
      • Java APM
      • JMX
      • Logz.io
      • MySQL
      • Nagios
      • OpenMetrics
      • PostgreSQL
      • Prometheus
      • SAP
      • SCOM
      • SolarWinds
      • Static Health
      • Static Topology
      • Traefik
      • WMI
      • Zabbix
    • Develop your own StackPacks
  • 🔧Configure
    • Topology
      • Component actions
      • Identifiers
      • Topology naming guide
      • Topology sources
      • Create a topology manually
      • Configure topology synchronizations
      • Enable email event notifications
      • Send topology data over HTTP
      • Set the topology filtering limit
      • Use a proxy for event handlers
      • Use tags
      • Tune topology synchronization
      • Debug topology synchronization
    • Telemetry
      • Add telemetry during topology synchronization
      • Data sources
        • Elasticsearch
        • Prometheus mirror
      • Send events over HTTP
      • Send metrics data over HTTP
      • Set the default telemetry interval
      • Debug telemetry synchronization
    • Traces
      • Set up traces
      • Advanced configuration for traces
    • Health
      • Health synchronization
      • Send health data over HTTP
        • Send health data
        • Repeat Snapshots JSON
        • Repeat States JSON
        • Transactional Increments JSON
      • Debug health synchronization
    • Anomaly Detection
      • Export anomaly feedback
      • Scale the AAD up and down
      • The AAD status UI
    • Security
      • Authentication
        • Authentication options
        • File based
        • LDAP
        • Open ID Connect (OIDC)
        • KeyCloak
        • Service tokens
      • RBAC
        • Role-based Access Control
        • Permissions
        • Roles
        • Scopes
        • Subjects
      • Secrets management
      • Self-signed certificates
      • Set up a security backend for Linux
      • Set up a security backend for Windows
    • Logging
      • Kubernetes logs
      • Linux logs
      • Enable logging for functions
  • 📖Develop
    • Developer guides
      • Agent checks
        • About Agent checks
        • Agent check API
        • Agent check state
        • How to develop Agent checks
        • Connect an Agent check to StackState
      • Custom functions and scripts
        • StackState functions
        • Check functions
        • Component actions
        • Event handler functions
        • ID extractor functions
        • Mapping functions
        • Monitor functions
        • Propagation functions
        • Template functions
        • View health state configuration functions
      • Custom Synchronization StackPack
        • About the Custom Synchronization StackPack
        • How to customize elements created by the Custom Synchronization StackPack
        • How to configure a custom synchronization
      • Integrate external services
      • Mirroring Telemetry
      • Monitors
        • Create monitors
        • Monitor STJ file format
      • StackPack development
        • How to create a StackPack
        • Packaging
        • How to get a template file
        • How to make a multi-instance StackPack
        • Prepare a multi-instance provisioning script
        • Upload a StackPack file
        • Prepare a shared template
        • Customize a StackPack
        • Prepare instance template files
        • Prepare a StackPack provisioning script
        • Resources in a StackPack
        • StackState Common Layer
      • Synchronizations and templated files
    • Reference
      • StackState OpenAPI docs
      • StackState Template JSON (STJ)
        • Using STJ
        • Template functions
      • StackState Markup Language (STML)
        • Using STML
        • STML Tags
      • StackState Query Language (STQL)
      • StackState Scripting Language (STSL)
        • Scripting in StackState
        • Script result: Async
        • Script result: Streaming
        • Time in scripts
        • Script APIs
          • Async - script API
          • Component - script API
          • HTTP - script API
          • Prediction - script API
          • StackPack - script API
          • Telemetry - script API
          • Time - script API
          • Topology - script API
          • UI - script API
          • View - script API
    • Tutorials
      • Create a simple StackPack
      • Push data to StackState from an external system
      • Send events to StackState from an external system
      • Set up a mirror to pull telemetry data from an external system
Powered by GitBook
LogoLogo

Legal notices

  • Privacy
  • Cookies
  • Responsible disclosure
  • SOC 2/SOC 3
On this page
  • Overview
  • Health sources
  • StackState health checks
  • StackState monitors
  • External monitoring systems
  • Health state types
  • Element own health state
  • Element propagated health state
  • View health state
  • Run state
  • Propagation
  • See also
  1. Use
  2. Concepts

Health state

StackState Self-hosted v5.1.x

PreviousRelationsNextLayers, Domains and Environments

Last updated 2 years ago

Overview

StackState calculates and reports the health state for elements (components and relations) and views. The following health state types are reported:

  • - indicates the current health state of an element based on configured health sources.

  • - highlights potential impact resulting from other unhealthy elements in the topology.

  • - summarizes the health states and propagated health states of all elements in a view.

Changes to a health state will generate that can be used to trigger .

Health sources

Health data in StackState can be derived from a number of health sources.

StackState health checks

StackState health checks calculate a health state based on the telemetry or log streams that are defined for a topology element. This approach opens up the possibility to use the Autonomous Anomaly Detector (AAD) for anomaly health checks.

Existing StackPacks offer StackState health checks out of the box.

StackState monitors

StackState monitors compute a health state based on a configured algorithm that combines and processes the 4T data collected by StackState. Health states computed this way are bound to topology elements using health synchronization.

Existing StackPacks will offer StackState monitors out of the box.

External monitoring systems

Health data from external monitoring systems can be sent to StackState using health synchronization. In this case, the health state is calculated by an external system based on its own rules. The calculated health state is then sent to StackState as a health stream and bound to the associated topology element. This approach is useful if you have existing health calculations defined externally, or if it isn't viable to send telemetry or events data to StackState and translate the health calculation rules.

Existing StackPacks offer health synchronization out of the box.

Health state types

Element own health state

In the StackState UI, the color of an element represents its own health state. A topology element can have any of the following health states:

  • Green - CLEAR - There is nothing to worry about.

  • Orange - DEVIATING - Something may require your attention. A badge on the component shows the number of health checks that are currently failing.

  • Red - CRITICAL - Attention is needed right now, because something is broken. A badge on the component shows the number of health checks that are currently failing.

  • Gray - UNKNOWN - No health state available.

Element propagated health state

In addition to the own health state, StackState calculates a propagated health state for each topology element (components, component groups and relations). The propagated health state is derived from the own health state of components and relations that the element depends upon.

A topology element can have any of the propagated health states listed below:

  • Orange - DEVIATING - Potential impact from another DEVIATING topology element. May require your attention.

  • Red - CRITICAL - Potential impact from another CRITICAL topology element. May require your attention.

  • UNKNOWN - No propagated health state. There is nothing to worry about.

In the StackState UI, an outer color will be shown when an element's propagated health state is calculated as unhealthy - orange for DEVIATING or red for CRITICAL.

The propagated health state of an element can also be found in the following places:

View health state

When view health state is enabled for a view, it will report a health state. The view health state is calculated based on the health of components and relations within in the view.

In the StackState UI, the view health state is reported as a one of four colors:

  • Green - CLEAR - There is nothing to worry about.

  • Orange - DEVIATING - Something may require your attention.

  • Red - CRITICAL - Attention is needed right now, because something is broken.

  • Gray - UNKNOWN - View health state reporting is disabled.

You can check the view health state in the following places in the StackState UI:

  • Starred views - Starred views are listed in the StackState main menu together with their health state.

  • All views - The health state of all views is visible on the view overview screen. Click Views from the StackState main menu.

Run state

Propagation

The propagated health state of an element is calculated using a propagation function. Health state will propagate from one element to the next, from dependencies to dependent elements. Note that this is the opposite direction to the arrows shown on relations in the topology visualization. A CLEAR (green) or UNKNOWN (gray) health state won't propagate.

Dependency and propagated state
Description

Component A depends on component B. Health state will propagate from B to A.

Component B depends on component A. Health state will propagate from A to B.

Dependency in both directions. Health state will propagate from A to B and from B to A. In other words, it's a circular dependency.

No dependency. Health state doesn't propagate.

See also

You can set up a to integrate with external monitoring systems that aren't supported out of the box.

StackState tracks a single own health state for each topology element (components, component groups and relations) based on information available from all of the attached to it. The own health state is calculated as the most severe state reported by all health sources configured the element. If no health sources are present, an UNKNOWN health state will be reported.

The element will also have an outer color if it has an unhealthy .

You can find details of the calculated element own health state and all configured monitors and health checks in the StackState UI right panel details tab when information about a topology element is displayed - or depending on the element type that you selected.

➡️

The color of the element itself (the inner color) represents the .

In the right panel details tab when information about a topology element is displayed - or depending on the element type that you selected.

In the when you hover the mouse pointer over a component in the topology visualization.

➡️

Current view - The health state of the current view is visible in the top bar of the StackState UI and also next to the view name in the right panel View summary tab. Historical health state information for a view can be seen in the line at the bottom of the screen.

Some components in StackState will report a Run state, for example, AWS EC2 instances. This is different to the and indicates the component’s operational state. The run state can be DEPLOYING, DEPLOYED, STARTING, STARTED, STOPPING, STOPPED or UNKNOWN. It isn't 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 and can help to correlate changes in the deployment state of components with problems in an environment.

You can configure to customize how health state affects the overall health of your systems.

👤
How to manage monitors
About StackState monitors
custom health synchronization
Learn how to configure view health state reporting
health state
Events Perspective
custom propagation functions
Add a health check based on telemetry streams available in StackState
Manage monitors
Add Static Health from a CSV file
Set up a health synchronization
Configure the view health
events
event notifications
How to add a health check
How to set up anomaly health checks
About StackState checks
Element own health state
Element propagated health state
View health state
health sources
propagated health state
Learn how health state propagates in StackState
element own health state
Component details
Component details
timeline Health
component context menu
Direct relation details
Direct relation details
Health states
Health states
Health states
View health state in main menu