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 for 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:

  • 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.

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 activate 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 🔗

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

  1. Include the Smart Agent receiver in your configuration file.

  2. Add the monitor type to the Collector configuration, both in the receiver and pipelines sections.

Note

Provide a Telegraf Varnish monitor entry in your Collector or Smart Agent (deprecated) 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, activate 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:

Notes 🔗

  • 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.

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.