> ## Documentation Index
> Fetch the complete documentation index at: https://otel.fyi/llms.txt
> Use this file to discover all available pages before exploring further.

# Icmpcheck

> OpenTelemetry receiver for Icmpcheck

# Icmpcheck Receiver

![Status](https://img.shields.io/badge/status-development-orange)

**Maintainers:** [@atoulme](https://github.com/atoulme), [@jkoronaAtCisco](https://github.com/jkoronaAtCisco)

**Source:** [opentelemetry-collector-contrib](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/icmpcheckreceiver)

## Supported Telemetry

![Metrics](https://img.shields.io/badge/metrics-development-green)

## Overview

## Configuration

The following configuration settings are available:

* `targets` (required): The list of targets to be pinged.
* `collection_interval` (optional, default = `60s`): This receiver collects metrics on an interval. Valid time units are `ns`, `us` (or `µs`), `ms`, `s`, `m`, `h`.
* `initial_delay` (optional, default = `1s`): Defines how long this receiver waits before starting.

### Target Configuration

Each target has the following properties:

* `host` (required): A hostname or IP address to be pinged.
* `ping_count` (optional, default = `3`): The number of packets after which the pinger is stopped.
* `ping_interval` (optional, default = `1s`): The wait time between each packet send.
* `ping_timeout` (optional, default = `5s`): Specifies a timeout before ping exits, regardless of how many packets have been received.

### Optional Metrics Configuration

Each metric can be enabled or disabled individually. By default, all metrics are enabled. Example:

```yaml theme={null}
receivers:
  icmpcheck:
    metrics:
      ping.rtt.min:
        enabled: false
```

## Metrics

Details about the metrics produced by this receiver can be found in [documentation.md](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/icmpcheckreceiver/documentation.md)

## Resource Attributes

The following attributes are added to all reported resources:

* `net.peer.ip` - the IP address of the host being pinged.
* `net.peer.name` - the string address of the host being pinged.

## Example Configuration

```yaml theme={null}
receivers:
  icmpcheck:
    collection_interval: 30s
    metrics:
      ping.rtt.min:
        enabled: false
    targets:
      - host: "https://opentelemtry.io"
        ping_count: 4
      - host: "192.168.101.25"
        ping_interval: 2s
        ping_timeout: 3s
processors:
  batch:
    send_batch_max_size: 1000
    send_batch_size: 100
    timeout: 10s
exporters:
  debug:
    verbosity: detailed
service:
  pipelines:
    metrics:
      receivers: [ icmpcheck ]
      processors: [ batch ]
      exporters: [ debug ]
```

## Metrics

| Metric Name         | Description                                            | Unit | Type  | Attributes |
| ------------------- | ------------------------------------------------------ | ---- | ----- | ---------- |
| ✅ `ping.loss.ratio` | The percentage of lost packets.                        | %    | Gauge |            |
| ✅ `ping.rtt.avg`    | Average round-trip time in milliseconds.               | ms   | Gauge |            |
| ✅ `ping.rtt.max`    | Maximum round-trip time in milliseconds.               | ms   | Gauge |            |
| ✅ `ping.rtt.min`    | Minimum round-trip time in milliseconds.               | ms   | Gauge |            |
| ✅ `ping.rtt.stddev` | Standard deviation of round-trip time in milliseconds. | ms   | Gauge |            |

## Resource Attributes

| Attribute Name  | Description                              | Type   | Enabled |
| --------------- | ---------------------------------------- | ------ | ------- |
| `net.peer.ip`   | The IP address of the host being pinged. | string | ✅       |
| `net.peer.name` | The hostname of the host being pinged.   | string | ✅       |

***

*Last generated: 2026-07-06*