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
  • Note on StackPack V2 and Agent V3
  • Setup
  • Prerequisites
  • Install
  • Configure
  • Status
  • Upgrade
  • Integration details
  • Data retrieved
  • Troubleshooting
  • Uninstall
  • Release notes
  • See also
  1. StackPacks
  2. Integrations

StackState Agent V2

StackState Self-hosted v5.1.x

PreviousAbout integrationsNextAWS

Last updated 1 year ago

Overview

The StackState Agent V2 StackPack works with to synchronize topology, metrics, events and traces data from external systems with StackState. A number of integrations are automatically enabled when the StackState Agent V2 StackPack is installed, however, integration with some systems will require an additional StackPack and configuration.

StackState Agent V2 is a .

Note on StackPack V2 and Agent V3

The StackState Agent V3 has been released with feature parity and full backwards-compatibility with the StackState Agent V2 StackPack. Agent V2 has been sunsetted, and no new features will be added to it. The core difference between V2 and V3 is the bundled Python runtime, and therefore Python support for custom StackPacks and integrations.

Please note that V3 refers only to the agent, and V2 is the version of the Agent StackPack. The StackState Agent V2 StackPack is compatible with StackState Agent V3.

Setup

Prerequisites

  • installed on a machine that can connect to StackState and any system you will integrate with.

Install

Install the StackState Agent V2 StackPack from the StackState UI StackPacks > Integrations screen.

Configure

The integrations included in the StackState Agent V2 StackPack are listed below. Refer to the integration pages to find configuration details for each integration:

Status

Upgrade

When a new version of the StackState Agent V2 StackPack is available in your instance of StackState, you will be prompted to upgrade in the StackState UI on the page StackPacks > Integrations > StackState Agent V3.

Integration details

Data retrieved

When installed and running, StackState Agent V3 will synchronize the following data with StackState from the host it's running on:

Linux:

  • Hosts, processes and containers

  • Network connections between processes and containers including network traffic telemetry

  • Telemetry for hosts, processes and containers

Docker:

  • Hosts, processes, and containers

  • Network connections between processes, containers and services including network traffic telemetry

  • Telemetry for hosts, processes, and containers

  • Trace Agent support

When additional checks have been enabled on the Agent, data from other external systems will be integrated. Refer to the individual integration pages for details of the data retrieved from each system.

Troubleshooting

Uninstall

Uninstall the StackState Agent V2 StackPack from the StackState UI StackPacks > Integrations screen.

Release notes

Agent V2 StackPack v4.5.2 (2022-06-10)

  • Improvement: Added CPU throttled metrics for containers.

Agent V2 StackPack v4.5.1 (2022-04-08)

  • Improvement: Added a Deprovisioning screen when uninstalling the StackState Agent V2 StackPack.

Agent V2 StackPack v4.5.0 (2022-03-02)

  • Feature: Automatically add OpenTelemetry HTTP health checks

    • Error count (sum) check

    • Request count (sum) check

    • Response Time (milliseconds) check

  • Feature: Add Container integration DataSource and Sync

Agent V2 StackPack v4.4.14 (2022-02-18)

  • Feature: Health check added for HTTP error (5xx) rate over total rate ratio

Agent V2 StackPack v4.4.13 (2022-02-03)

  • Improvement: Documentation updated - added documentation for OpenMetrics integration.

    • HTTP Success response time (s) (95th percentile) AAD Check

    • HTTP 5xx error response time (s) (95th percentile) AAD Check

    • HTTP total response time (s) (95th percentile) AAD Check

    • HTTP Success rate (req/s) AAD Check

    • HTTP 5xx error rate (req/s) AAD Check

Agent V2 StackPack v4.4.12 (2021-12-15)

  • Improvement: Supported additional identifiers for Disk component

See also

To find the status of an installed Agent, use the status commands provided in the .

For an overview of recent StackPack updates, check the shipped with each StackState release.

To upgrade StackState Agent V3, see the .

Troubleshooting steps for any known issues can be found in the .

To uninstall StackState Agent V3, see the .

Feature: Automatically add for

🧩
💠
Apache TomCat
AWS ECS
AWS Xray
DotNet APM
Java APM
JMX
MySQL
OpenMetrics
PostgreSQL
Static Health
WMI
StackState Agent documentation
StackPack versions
StackState Agent documentation
StackState support knowledge base
StackState Agent documentation
anomaly health checks
golden signals
StackState Agent documentation
StackState Agent V3
StackState Agent V3
StackState core integration