Health Checker 🔗

The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the Health Checker monitor type to check whether the configured JSON value is returned in the response body.

Benefits 🔗

After you configure the integration, you can access these features:

View metrics. You can create your own custom dashboards, and most monitors provide built-in dashboards as well. For information about dashboards, see View dashboards in Observability Cloud.
View a data-driven visualization of the physical servers, virtual machines, AWS instances, and other resources in your environment that are visible to Infrastructure Monitoring. For information about navigators, see Splunk Infrastructure Monitoring navigators.
Access the Metric Finder and search for metrics sent by the monitor. For information, see Use the Metric Finder.

Follow these steps to deploy this integration:

Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform:
Configure the monitor, as described in the Configuration section.
Restart the Splunk Distribution of OpenTelemetry Collector.

To use this integration of a Smart Agent monitor with the Collector:

Include the Smart Agent receiver in your configuration file.
Add the monitor type to the Collector configuration, both in the receiver and pipelines sections.

To activate this integration, add the following to your Collector configuration:

receivers:
  smartagent/health-checker:
    type: collectd/health-checker
    ...  # Additional config

Next, add the monitor to the service > pipelines > metrics > receivers section of your configuration file:

service:
 pipelines:
   metrics:
     receivers: [smartagent/health-checker]

The following table shows the configuration options for the Health Checker monitor:

Option	Required	Type	Description
`pythonBinary`	no	`string`	Path to a python binary that should be used to execute the Python code. If not set, a built-in runtime will be used. Can include arguments to the binary as well.
`host`	yes	`string`
`port`	yes	`integer`
`name`	no	`string`
`path`	no	`string`	The HTTP path that contains a JSON document to verify (default: `/`)
`jsonKey`	no	`string`	If `jsonKey` and `jsonVal` are given, the given endpoint will be interpreted as a JSON document and will be expected to contain the given key and value for the service to be considered healthy.
`jsonVal`	no	`any`	This can be either a string or numeric type
`useHTTPS`	no	`bool`	If `true`, the endpoint will be connected to on HTTPS instead of plain HTTP. It is invalid to specify this if `tcpCheck` is `true`. (default: `false`)
`skipSecurity`	no	`bool`	If `true`, and `useHTTPS` is `true`, the server’s SSL/TLS cert will not be verified. (default: `false`)
`tcpCheck`	no	`bool`	If `true`, the plugin will verify that it can connect to the given host/port value. JSON checking is not supported. (default: `false`)

The following metrics are available for this integration:

Name	Description	Sample value	Category
`gauge.service.health.status`	The HTTP response status code for the request made to the application being monitored. A `200` value means an HTTP 200 OK success status response was returned, so the application is healthy.	`200`	Default
`gauge.service.health.value`	`0` means an unhealthy state, and `1` means a healthy state.	`0` or `1`	Default

Learn more about the available metric types in Observability Cloud.
Default metrics are those metrics included in host-based subscriptions in Observability Cloud, such as host, container, or bundled metrics. Custom metrics are not provided by default and might be subject to charges. See more about metric categories.
To add additional metrics, see how to configure extraMetrics using the Collector.

If you are not able to see your data in Splunk Observability Cloud, try these tips:

Submit a case in the Splunk Support Portal
- Available to Splunk Observability Cloud customers
Call Splunk Customer Support
- Available to Splunk Observability Cloud customers
Ask a question and get answers through community support at Splunk Answers
- Available to Splunk Observability Cloud customers and free trial users
Join the Splunk #observability user group Slack channel to communicate with customers, partners, and Splunk employees worldwide
- Available to Splunk Observability Cloud customers and free trial users
- To learn how to join, see Get Started with Splunk Community - Chat groups

To learn about even more support options, see Splunk Customer Success.