> For the complete documentation index, see [llms.txt](https://archivedocs.stackstate.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://archivedocs.stackstate.com/5.1/stackpacks/integrations/static_health.md).

# Static Health

## Overview

The Static Health integration is used to visualize static health information in StackState by reading from CSV files. The health consists of check states.

Static Health is a [StackState curated integration](/5.1/stackpacks/integrations/about_integrations.md#stackstate-curated-integrations).

## Setup

### Prerequisites

To set up the Static Health integration you will need to have:

* StackStateinstalled on a machine that can connect to StackState.

### Configure

To configure StackState to read CSV health files:

1. Edit the Agent integration configuration file `/etc/stackstate-agent/conf.d/static_health.d/conf.yaml` to include the following details:
   * **type** - set to `csv` for parsing CSV typed files.
   * **health\_file** - the absolute path to the CSV file containing health state information.
   * **delimiter** - the delimiter used in the CSV file.

     ```
     init_config:

     instances:
     - type: csv
      health_file: /path/to/health.csv
      delimiter: ';'
     ```
2. [Restart StackState ](/5.1/setup/agent/about-stackstate-agent.md#deployment)to apply the configuration changes.
3. Once the Agent has restarted, wait for the Agent to collect data from the specified [health CSV file](#csv-file-format) and send it to StackState.

{% hint style="info" %}
The configured `collection_interval` will be used as the [`repeat_interval` for the health synchronization](/5.1/configure/health/health-synchronization.md#repeat-interval). Make sure that the value set for the `collection_interval` matches the time that the check will take to run.
{% endhint %}

## CSV file format

### Fields

Static health is read from a CSV file with a header row, that specifies the fields that are included in the file. The available fields are listed in the table below.

| Field name                        | Mandatory | Description                                                                     |
| --------------------------------- | --------- | ------------------------------------------------------------------------------- |
| **check\_state\_id**              | yes       | Identification for the check state within the health stream.                    |
| **name**                          | yes       | The display name of the check state.                                            |
| **health**                        | yes       | The health state of the check state. Can be `CLEAR`, `DEVIATING` or `CRITICAL`. |
| **topology\_element\_identifier** | yes       | Identifier of the component or relation the check state will be attached to.    |
| **message**                       | no        | Additional descriptive message of the check state.                              |

{% tabs %}
{% tab title="Example health CSV file" %}

```
check_state_id,name,health,topology_element_identifier,message
check_1,Example check,critical,urn:component/some_component,Something went wrong
check_2,Another example check,clear,urn:component/some_component,This is going well
```

{% endtab %}
{% endtabs %}

### Delimiter

The delimiter used in the CSV file can be specified when you [configure the Static Health check](#configure) on StackState Agent V3.

## See also

* [StackState Agent V2](/5.1/setup/agent/about-stackstate-agent.md)
* [Health state in StackState](/5.1/use/concepts/health-state.md)
* [Health Synchronization](/5.1/configure/health/health-synchronization.md)
* [Debug Health Synchronization](/5.1/configure/health/debug-health-sync.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://archivedocs.stackstate.com/5.1/stackpacks/integrations/static_health.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.