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
  • Topology synchronization process
  • Troubleshooting steps
  • StackState Agent
  • StackState Receiver
  • Kafka
  • Synchronization
  • Relations
  • Synchronization logs
  • Useful CLI commands
  • List all topology synchronization streams
  • Show status of a stream
  • See also
  1. Configure
  2. Topology

Debug topology synchronization

StackState Self-hosted v5.1.x

PreviousTune topology synchronizationNextTelemetry

Last updated 1 year ago

Overview

This page explains several tools that can be used to troubleshoot a topology synchronization.

Topology synchronization process

A topology synchronized using StackState Agent follows the process described below:

  1. StackState Agent:

    • Connects to a data source to collect data.

    • Connects to the StackState Receiver to push collected data to StackState (in JSON format).

  2. StackState Receiver:

    • Extracts topology and telemetry payloads from the received JSON.

    • Puts messages on the Kafka bus.

  3. Kafka:

    • Stores received data in topics.

  4. Synchronization:

    • Reads data from a topic as it becomes available on the Kafka bus.

    • Processes retrieved data.

Troubleshooting steps

  1. Confirm that a custom synchronization is running:

    • The synchronization should be included in the list and have created components/relations.

StackState Agent

For integrations that run through StackState Agent, StackState Agent is a good place to start an investigation.

  • The integration can be triggered manually using the stackstate-agent check <check_name> -l debug command on your terminal. This command won't send any data to StackState. Instead, it will return the topology and telemetry collected to standard output along with any generated log messages.

StackState Receiver

The StackState Receiver receives JSON data from StackState Agent V3.

  • Check the StackState Receiver logs for JSON deserialization errors.

Kafka

Topology and telemetry are stored on Kafka on separate topics. The StackState topology synchronization reads data from a Kafka bus once it becomes available.

Use the stac CLI to list the topics on Kafka and check the messages on a topic:

  • List all topics present on Kafka: stac topology list-topics. A topic should be present where the name has the format sts_topo_<instance_type>_<instance url> where <instance_type> is the recognizable name of an integration and <instance_url> corresponds to the StackState Agent integration YAML (usually the URL of the data source).

  • Check messages on a Kafka topic: stac topic show <topic_name>. If there are recent messages on the Kafka bus, then the issue isn't in the data collection.

Synchronization

The StackState topology synchronization reads messages from a topic on the Kafka data bus. The Kafka topic used by a synchronization is defined in the Sts data source.

  • Check if the topic name defined in the Sts data source matches what is returned by the stackstate-agent check command. Note that topic names are case-sensitive.

  • Check the error counter for the synchronization on the StackState UI page Settings > Topology Synchronization > Synchronizations. Increasing numbers tell you that there was an error while processing received data.

  • Check the stackstate.log or, for Kubernetes, the stackstate-api pod.

    • If there is an issue with the ID extractor, an exception will be logged here on each received topology element. No topology will be synchronized, however, the synchronization’s error counter will not increase.

  • Check the synchronization’s specific log file or, for Kubernetes, the stackstate-sync pod for log messages that include the synchronization’s name.

    • Issues with a mapping function defined for a synchronization mapping will be reported here. The type is also logged to help determine which mapping to look at. The synchronization’s error counter will increase.

    • Issues with templates are also logged here. The synchronization’s error counter will increase.

Relations

It's possible that a relation references a source or target component that doesn't exist. Components are always processed before relations. If a component referenced by a relation isn't present in the synchronization’s topology, the relation won't be created. When this happens, a warning is logged to the synchronization’s specific log file or the stackstate-sync pod. The component external ID and relation external ID are logged to help.

Synchronization logs

When StackState is deployed on Kubernetes, logs about synchronization can be found in the stackstate-sync pod and the stackstate-api pod. The name of the synchronization is shown in the log entries.

  • The stackstate-sync pod has details of:

    • Template/mapping function errors.

    • Component types that don't have a mapping.

    • Relations connected to a non-existing component.

    • Messages that have been discarded due to a slow synchronization.

  • The stackstate-api pod has details of:

    • ID extractor errors.

    • StackPacks.

When StackState is deployed on Linux, logs about synchronization are stored in the directory:

<my_install_location>/var/log/sync/

There are two log files for each synchronization:

  • exttopo.<DataSource_name>.log has information about ID extraction and the building of an external topology. Here you will find details of:

    • ID extractor errors.

    • Relations connected to a non-existing component.

    • Messages that have been discarded due to a slow synchronization.

  • sync.<Synchronization_name>.log has information about mapping, templates and merging. Here you will find details of:

    • Template/mapping function errors.

    • Component types that don't have a mapping.

Logs about StackPacks are stored in the directory:

<my_install_location>/var/log/stackpacks/

There is a log file for each StackPack. The name of the log file is set to the StackPack’s internal name. Information about the StackPack lifecycle can be found here.

Useful CLI commands

List all topology synchronization streams

Returns a list of all current topology synchronization streams.

# List streams
stac topology list

        Node Id  Identifier                                                                               Status      Created Components    Deleted Components    Created Relations    Deleted Relations    Errors
---------------  ---------------------------------------------------------------------------------------  --------  --------------------  --------------------  -------------------  -------------------  --------
245676427469735                                                                                           Running                      0                     0                    0                    0         0
154190823099122  urn:stackpack:stackstate-agent-v2:shared:sync:agent                                      Running                 761818                763870              1517959              1519490         0
144667609743389  urn:stackpack:stackstate:instance:44a9ce1e-413c-4c4c-819d-2095c1229dda:sync:stackstate   Running                  13599                  5496                    0                    0       329

⚠️ From StackState v5.0, the old sts CLI is called stac. The old CLI is now deprecated.

The new sts CLI replaces the stac CLI. It's advised to install the new sts CLI and upgrade any installed instance of the old sts CLI to stac. For details see:

Command not currently available in the new sts CLI. Use the stac CLI.

Show status of a stream

Shows the data of a specific topology synchronization stream, including detailed latency of the data being processed. The id might be either a node id or the identifier of a topology synchronization. The search gives priority to the node id.

# Show a topology synchronization status
stac topology show urn:stackpack:stackstate:instance:44a9ce1e-413c-4c4c-819d-2095c1229dda:sync:stackstate

        Node Id  Identifier                                                                               Status      Created Components    Deleted Components    Created Relations    Deleted Relations    Errors
---------------  ---------------------------------------------------------------------------------------  --------  --------------------  --------------------  -------------------  -------------------  --------
144667609743389  urn:stackpack:stackstate:instance:44a9ce1e-413c-4c4c-819d-2095c1229dda:sync:stackstate   Running                  13599                  5496                    0                    0       329

metric               value between now and 500 seconds ago  value between 500 and 1000 seconds ago    value between 1000 and 1500 seconds ago
-----------------  ---------------------------------------  ----------------------------------------  -----------------------------------------
latency (Seconds)                                   35.754  ---                                       ---

⚠️ From StackState v5.0, the old sts CLI is called stac. The old CLI is now deprecated.

The new sts CLI replaces the stac CLI. It's advised to install the new sts CLI and upgrade any installed instance of the old sts CLI to stac. For details see:

Command not currently available in the new sts CLI. Use the stac CLI.

See also

Read the .

Read the .

Read the .

Read the .

Use the stac CLI to .

If a custom synchronization isn't listed, you will need to .

If no components appear after making changes to a synchronization, or the data isn't as expected, follow the steps described in the sections below to check each step in the .

If relations are missing from the topology, read the note on .

Check the for hints that it has problems connecting to StackState.

To troubleshoot processing errors, refer to the relevant StackState log files. The provided log messages will help you to resolve the issue. For details on working with the StackState log files on Kubernetes and Linux see the pages under .

➡️

➡️

🔧
recreate the synchronization
Configure > Logging
Learn more about StackState log files on Kubernetes
Learn more about StackState log files on Linux
Comparison between the CLIs
Comparison between the CLIs
Working with StackState log files
Configure topology synchronizations
Tune topology synchronization
troubleshooting steps for StackState Agent
troubleshooting steps for StackState Receiver
troubleshooting steps for Kafka
troubleshooting steps for synchronization
list all topology synchronization streams
topology synchronization process
troubleshooting synchronization of relations
Which version of the sts CLI am I running?
Which version of the sts CLI am I running?
Install the new sts CLI and upgrade the old sts CLI to stac
Install the new sts CLI and upgrade the old sts CLI to stac
StackState Agent log
Topology synchronization with StackState Agent
Synchronization errors