Traefik 🔗

Description 🔗

The Splunk Distribution of OpenTelemetry Collector deploys this integration as the traefik monitor type for the Smart Agent Receiver.

Use this integration to collect metrics from Traefik.

This monitor is available on Kubernetes, Linux, and Windows.

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.

Installation 🔗

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.

Configuration 🔗

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.

Read more on how to Use Smart Agent monitors with the Collector.
See how to set up the Smart Agent receiver.
Learn about config options in Collector default configuration.

Note

Provide a Traefik 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 OpenTelemetry Collector, add the following to your agent configuration:

receivers:
  smartagent/traefik:
    type: traefik
    ...  # Additional config

To complete the monitor activation, you must also include the smartagent/traefik 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/traefik]

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: traefik
    ...  # 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 the traefik monitor:

Option	Required	Type	Description
`httpTimeout`	No	`int64`	HTTP timeout duration for both reads and writes. Must be a duration string accepted by `ParseDuration`. Default value is `10s`.
`username`	No	`string`	Username to use on each request.
`password`	No	`string`	Password to use on each request.
`useHTTPS`	No	`bool`	If true, the agent connects to the server using HTTPS instead of plain HTTP. Default value is `false`.
`httpHeaders`	No	`map of strings`	A map of HTTP header names to values. Comma-separated multiple values for the same message-header are supported.
`skipVerify`	No	`bool`	If both `useHTTPS` and `skipVerify` are `true`, the TLS certificate of the exporter is not verified. Default value is `false`.
`caCertPath`	No	`string`	Path to the CA certificate that has signed the TLS certificate, unnecessary if `skipVerify` is set to false.
`clientCertPath`	No	`string`	Path to the client TLS certificate to use for TLS required connections.
`clientKeyPath`	No	`string`	Path to the client TLS key to use for TLS required connections.
`host`	Yes	`string`	Host of the exporter.
`port`	Yes	`integer`	Port of the exporter.
`useServiceAccount`	No	`bool`	Use pod service account to authenticate. Default value is `false`.
`metricPath`	No	`string`	Path to the metrics endpoint on the exporter server. The default value is `/metrics`.
`sendAllMetrics`	No	`bool`	Send all the metrics that come out of the Prometheus exporter without any filtering. This option has No effect when using the Prometheus exporter monitor directly, since there is No built-in filtering. Default value is `false`.
The Collector or Smart Agent must have network access to Traefik.

Traefik configuration 🔗

Edit the Traefik configuration file, for example traefik.toml, to activate Traefik to expose Prometheus metrics at an endpoint. By default, the endpoint is on path /metrics. When running the Traefik binary, pass the path to the configuration file using the -c argument. For example, ./traefik -c traefik.toml.

When running the Traefik Docker image, use the /etc/traefik/traefik.toml volume. For example, docker run -d -p 8080:8080 -p 80:80 -v $PWD/traefik.toml:/etc/traefik/traefik.toml.

If the Traefik configuration file is not available, use the sample configuration file to get started. For more information, see the Traefik documentation.

Metrics 🔗

Traefik exports Prometheus metrics which can be categorized into Traefik, entrypoint, and back-end metrics.

Traefik-related metrics are for monitoring Traefik itself and are prefixed by go_ and process_. For instance, the go_memstats_sys_bytes metric can be used to plot Traefik memory usage.
Entrypoint and back-end metrics are the number and duration of requests measured at entrypoints and back ends. Entrypoint-related metrics are prefixed by traefik_entrypoint_. Backend-related metrics are prefixed by traefik_backend_.

The following table shows the metrics that 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:

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.

Related Topics