Skip to main content

​
Bigip Receiver

Status Source: opentelemetry-collector-contrib

​
Overview

Status
Stabilitybeta
Supported pipeline typesmetrics
Distributionscontrib
This receiver fetches stats from a F5 Big-IP node using F5’s iControl REST API.

​
Prerequisites

This receiver supports Big-IP versions 11.6.5+

​
Configuration

The following settings are required:
  • username
  • password
The following settings are optional:
  • endpoint (default: https://localhost:443): The URL of the Big-IP environment.
  • collection_interval (default = 10s): This receiver collects metrics on an interval. Valid time units are ns, us (or µs), ms, s, m, h.
  • tls (defaults defined here): TLS control. By default insecure settings are rejected and certificate verification is on.

​
Example Configuration

receivers:
  bigip:
    collection_interval: 10s
    endpoint: https://localhost:443
    username: otelu
    password: ${env:BIGIP_PASSWORD}
    tls:
      insecure_skip_verify: true
The full list of settings exposed for this receiver are documented here with detailed sample configurations here. TLS config is documented further under the opentelemetry collector’s configtls package.

​
Metrics

Details about the metrics produced by this receiver can be found in documentation.md

​
Metrics

Metric NameDescriptionUnitTypeAttributes
✅ bigip.virtual_server.data.transmittedAmount of data transmitted to and from the virtual server.ByCounterdirection
✅ bigip.virtual_server.connection.countCurrent number of connections to the virtual server.{connections}UpDownCounter
✅ bigip.virtual_server.request.countNumber of requests to the virtual server.{requests}Counter
✅ bigip.virtual_server.packet.countNumber of packets transmitted to and from the virtual server.{packets}Counterdirection
✅ bigip.virtual_server.availabilityAvailability of the virtual server.1Gaugeavailability.status
✅ bigip.virtual_server.enabledEnabled state of of the virtual server.1Gaugeenabled.status
✅ bigip.pool.data.transmittedAmount of data transmitted to and from the pool.ByCounterdirection
✅ bigip.pool.connection.countCurrent number of connections to the pool.{connections}UpDownCounter
✅ bigip.pool.request.countNumber of requests to the pool.{requests}Counter
✅ bigip.pool.packet.countNumber of packets transmitted to and from the pool.{packets}Counterdirection
✅ bigip.pool.member.countTotal number of pool members.{members}UpDownCounteractive.status
✅ bigip.pool.availabilityAvailability of the pool.1Gaugeavailability.status
✅ bigip.pool.enabledEnabled state of of the pool.1Gaugeenabled.status
✅ bigip.pool_member.data.transmittedAmount of data transmitted to and from the pool member.ByCounterdirection
✅ bigip.pool_member.connection.countCurrent number of connections to the pool member.{connections}UpDownCounter
✅ bigip.pool_member.request.countNumber of requests to the pool member.{requests}Counter
✅ bigip.pool_member.packet.countNumber of packets transmitted to and from the pool member.{packets}Counterdirection
✅ bigip.pool_member.session.countCurrent number of sessions for the pool member.{sessions}UpDownCounter
✅ bigip.pool_member.availabilityAvailability of the pool member.1Gaugeavailability.status
✅ bigip.pool_member.enabledEnabled state of of the pool member.1Gaugeenabled.status
✅ bigip.node.data.transmittedAmount of data transmitted to and from the node.ByCounterdirection
✅ bigip.node.connection.countCurrent number of connections to the node.{connections}UpDownCounter
✅ bigip.node.request.countNumber of requests to the node.{requests}Counter
✅ bigip.node.packet.countNumber of packets transmitted to and from the node.{packets}Counterdirection
✅ bigip.node.session.countCurrent number of sessions for the node.{sessions}UpDownCounter
✅ bigip.node.availabilityAvailability of the node.1Gaugeavailability.status
✅ bigip.node.enabledEnabled state of of the node.1Gaugeenabled.status

​
Attributes

Attribute NameDescriptionTypeValues
directionThe direction of data.stringsent, received
statusThe availability status.stringoffline, unknown, available
statusThe enabled status.stringdisabled, enabled
statusThe active status.stringactive, inactive

​
Resource Attributes

Attribute NameDescriptionTypeEnabled
bigip.virtual_server.nameThe name of the Big-IP Virtual Server.string✅
bigip.virtual_server.destinationThe destination for the Big-IP Virtual Server.string✅
bigip.pool.nameThe name of the Big-IP Pool.string✅
bigip.pool_member.nameThe name of the Big-IP Pool Member.string✅
bigip.pool_member.ip_addressThe IP Address of the Big-IP Pool Member.string✅
bigip.node.nameThe name of the Big-IP Node.string✅
bigip.node.ip_addressThe IP Address of the Big-IP Node.string✅

​
Configuration

​
Example Configuration

bigip:
  collection_interval: 10s
  endpoint: https://localhost:443
  username: otelu
  password: ${env:BIGIP_PASSWORD}
  tls:
    insecure_skip_verify: true
Last generated: 2026-04-14