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
  • Legend
  • Components
  • Component context menu
  • Actions
  • Shortcuts
  • Relations
  • Filters
  • Visualization settings
  • Problems
  • Navigation
  • Zoom in and out
  • Find component
  • Show root cause
  • List mode
  • Export as CSV
  1. Use
  2. StackState UI
  3. Perspectives

Topology Perspective

StackState Self-hosted v5.1.x

PreviousPerspectivesNextEvents Perspective

Last updated 2 years ago

Overview

The Topology Perspective displays the components in your IT landscape and their relationships.

Legend

Click on the Legend button (?) in the bottom right of the screen to display an explanation of the icons and colors used in the topology visualization.

Components

Component context menu

When you hover the mouse pointer over a component, the component context menu is displayed. This gives you information about the component, this includes:

  • The component name and type

Actions

Actions can be used to expand the topology selection to show all dependencies for the selected component. Other actions may be available for specific components, such as component actions that are installed as part of a StackPack.

A list of the available Actions is included in the right panel details tab when you select a component - Component details. Actions are also listed in the component context menu, which is displayed when you hover the mouse pointer over a component.

Shortcuts

Shortcuts give you direct access to detailed information about the specific component:

  • Show properties - Opens the properties popup for the component. This is the same as clicking SHOW ALL PROPERTIES in the right panel details tab when detailed information about a component is displayed - Component details.

  • Investigate in subview - Opens a subview containing only this component. The subview allows you to investigate a single component in all perspectives without needing to adjust the view filters. This is the same as clicking INVESTIGATE IN SUBVIEW in the right panel details tab when detailed information about a component is displayed - Component details.

Relations

Select a relation to open detailed information about it in the right panel details tab - Direct relation details, Indirect relation details or Grouped relation details depending on the relation type that has been selected.

Filters

The components and events displayed in the topology visualization can be customized by adding filters.

Click the View Filters icon in the left menu to open the view filters. Here you can edit the filters applied to the displayed topology and events:

  • Topology filters - filter the components displayed in the topology visualization.

  • Events filters - filter the events shown in the Events list in the right panel View summary and details tabs - Component details and Direct relation details.

Select an element to show detailed information about it in the right panel details tab. Click a label under Properties in the details tab to add this to the topology filter. The displayed topology will be expanded to include all components and relations with the selected label. To undo a label selection, click the back button in the browser or edit the topology filter in the view filters.

Visualization settings

The visualization of components and relations in the topology perspective can be customized in the visualization settings. Click the Visualization Settings icon in the left menu to open the visualization settings menu. Here you can edit:

  • Root cause display - to what extent the view should be expanded when an element in the view reports a DEVIATING or CRITICAL health state or propagated health state.

Problems

Navigation

Zoom in and out

There are zoom buttons located in the bottom right corner of the topology visualizer. The plus button zooms in on the topology, the minus button zooms out. In between both buttons is the fit to screen button which zooms out so the complete topology becomes visible.

Find component

You can locate a specific component in the topology by clicking CTRL + SHIFT + F and typing the first few letters of the component name. Alternatively, you can select the Find component magnifying glass icon in the bottom right corner of the topology visualizer.

Show root cause

It's possible that a view can contain components that have a DEVIATING propagated health state caused by a component that's not included in the view itself. The Topology Perspective allows you to configure whether the view should be expanded to automatically show root cause components that are outside the currently displayed view:

  • Don't show root cause - Don't show the root causes of components shown by the current topology filters.

  • Show root cause only - Only show the root causes of components shown by the current topology filters that have a CRITICAL or DEVIATING propagated health. Indirect relations are visualized if a component directly depends on at least one invisible component that leads to the root cause.

  • Show full root cause tree - Show all paths from components shown by the current topology filters that have a CRITICAL or DEVIATING propagated health to their root causes.

List mode

The components in the topology visualization can also be shown in a list instead of a graph:

Export as CSV

From list mode, the component list can be exported as a CSV file. The CSV file includes name, state, type and updated details for each component in the view.

  1. From the topology perspective, click the List mode icon on the top right to open the topology in list mode.

  2. Click Download as CSV from the top of the page.

    • The component list will be downloaded as a CSV file named <view_name>.csv.

The Topology Perspective shows the filtered components and relations in a selected or the entire, unfiltered topology in . Components that have one or more health checks configured will report a calculated .

Select a component to display in the right panel details tab - Component details.

Hover over a component to open the .

➡️

and of the component.

for the component.

specific to the component.

specific to the component.

You can configure in the Settings page or create .

Relations show how components in the topology are connected together. They're represented by a dashed or solid line and have an arrowhead showing the direction of dependency between the components they link. from one component to the next, from dependencies to dependent components. Relations that have one or more health checks configured will report a calculated health state.

➡️

The view filters are saved together with the View. For details, see the page .

Grouping - should all components be displayed individually or should like components be grouped. For details, see .

Grid - should components be organized by .

Indirect relations - should relations between components be shown if these connect through other components that aren't displayed in the view. For details, see .

The Visualization Settings are saved together with the View. For details, see the page .

If one or more components in a view have a CRITICAL state, StackState will show the related components and their states as a Problem in the .

See the full list of .

If there are components with and in your view, the Topology Perspective will calculate a health state and propagate this state throughout the graph. The propagated health state will help you to see the risk of affecting other components. When an element has an unhealthy , this will be shown as an outer color in the topology visualization.

You can configure or develop your own .

👤
view
explore mode
health state
Top metrics
component actions
custom component actions
Learn more about relations
filters
layer and domain
relations
Visualization settings
StackState keyboard shortcuts
propagation functions
component context menu
Shortcuts
Actions
component grouping
Health state
telemetry streams
health checks
propagated health state
Health state will propagate
propagated health state
detailed component information
Learn more about components
View summary
Topology Perspective
Topology Perspective - legend
Component context menu
Actions
Indirect relation path
Root cause
Filtering(list format)