Docs » Available host and application monitors in Splunk Observability Cloud » Configure application receivers for networks » Traefik

Traefik 🔗

The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the traefik monitor type 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:

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.

Example 🔗

To activate this integration, add the following to your Collector configuration:

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

Next, add the monitor to the service.pipelines.metrics.receivers section of your configuration file:

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

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 🔗

  • To learn more about the available in Observability Cloud see Metric types.

  • In host-based subscription plans, 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 Metric categories for more information.

  • In MTS-based subscription plans, all metrics are custom.

  • To add additional metrics, see how to configure extraMetrics in Add additional metrics.

Troubleshooting 🔗

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

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