Docs » Available host and application monitors » Configure application receivers for hosts and servers » Telegraf Varnish

Telegraf Varnish 🔗

Description 🔗

The Splunk Distribution of OpenTelemetry Collector provides this integration as the telegraf/varnish monitor type using the Smart Agent Receiver.

Use this integration to collect Varnish metrics.

This monitor is available on Kubernetes and Linux.

Benefits 🔗

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

Requirements 🔗

This integration uses the varnishstat command. The Collector or Smart Agent must run on the same host as the Varnish server.

Run the following command to enable the Smart Agent to run the varnishstat command:

usermod -a -G varnish signalfx-agent

Installation 🔗

Follow these steps to deploy this integration:

  1. Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform:

  2. Configure the monitor, as described in the Configuration section.

  3. Restart the Splunk Distribution of OpenTelemetry Collector.

Configuration 🔗

This monitor type is available in the Smart Agent Receiver, which is part of the Splunk Distribution of OpenTelemetry Collector. You can use existing Smart Agent monitors as OpenTelemetry Collector metric receivers with the Smart Agent Receiver.

This monitor type requires a properly configured environment on your system in which you’ve installed a functional Smart Agent release bundle. The Collector provides this bundle in the installation paths for x86_64/amd64.

To activate this monitor type in the Collector, add the following lines to your configuration (YAML) file:

Note

Provide a Telegraf Varnish monitor entry in your Smart Agent or Collector configuration. Use the appropriate form for your agent type.

Splunk Distribution of OpenTelemetry Collector 🔗

To activate this monitor in the Splunk Distribution of OpenTelemetry Collector, add the following to your agent configuration:

receivers:
  smartagent/varnish:
    type: telegraf/varnish
    ...  # Additional config

To complete the monitor activation, you must also include the smartagent/varnish receiver item in a metrics pipeline. To do this, add the receiver item to the service > pipelines > metrics > receivers section of your configuration file. For example:

service:
  pipelines:
    metrics:
      receivers: [smartagent/varnish]

Smart Agent 🔗

To activate this monitor in the Smart Agent, add the following to your agent configuration:

monitors:  # All monitor config goes under this key
 - type: telegraf/varnish
   ...  # Additional config

See Install and configure the SignalFx Smart Agent for an autogenerated example of a YAML configuration file, with default values where applicable.

Configuration settings 🔗

The following table shows the configuration options for this monitor:

Option

Required

Type

Description

useSudo

No

bool

If running as a restricted user, enable this flag to use sudo. The default value is false.

binary

No

string

The location of the varnishstat binary. The default value is /usr/bin/varnishstat.

stats

No

list of strings

Which stats to gather. You can use glob matching. For example, stats = ["MAIN.*"]. The default value is [MAIN.*].

instanceName

No

string

Optional name for the Varnish instance to query. The setting has the same effect of passing the -n parameter value.

Metrics 🔗

The following metrics are available for this integration:

Get help 🔗

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

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