SUMMARY.md

Table of contents

• 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 V2
  • 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 STY 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 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
  • StackState templating
    • Using StackState templating
    • Template functions
• 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