Skip to main content
Sumo Logic

Collect Logs and Metrics for Kubernetes environments

This page assists to collect Logs and Metrics for Kubernetes environments.

In a Kubernetes environment, we use the Telegraf Operator, which is packaged with our Kubernetes collection. You can learn more about it here.The diagram below illustrates how data is collected from HAProxy in Kubernetes environments. In the architecture shown below, there are four services that make up the metric collection pipeline: Telegraf, Prometheus, Fluentd and FluentBit.

The first service in the pipeline is Telegraf. Telegraf collects metrics from HAProxy. Note that we’re running Telegraf in each pod we want to collect metrics from as a sidecar deployment for example, Telegraf runs in the same pod as the containers it monitors. Telegraf uses the HAProxy input plugin to obtain metrics. (For simplicity, the diagram doesn’t show the input plugins.) The injection of the Telegraf sidecar container is done by the Telegraf Operator. We also have Fluentbit that collects logs written to standard out and forwards them to FluentD, which in turn sends all the logs and metrics data to a Sumo Logic HTTP Source.

Follow the below instructions to set up the metric collection:

  1. Configure Metrics Collection

    1. Setup Kubernetes Collection with the Telegraf operator

    2. Add annotations on your HAProxy pods

  2. Configure Logs Collection

    1. Configure logging in HAProxy.

    2. Add labels on your HAProxy pods to capture logs from standard output.

    3. Collecting HAProxy Logs from a Log file.

Prerequisites

It’s assumed that you are using the latest helm chart version if not upgrade using the instructions here.

Step 1 Configure Metrics Collection

This section explains the steps to collect HAProxy metrics from a Kubernetes environment.

In a Kubernetes environment, we use the Telegraf Operator, which is packaged with our Kubernetes collection. You can learn more on this here. Follow the steps listed below to collect metrics from a Kubernetes environment:

  1. Set up Kubernetes Collection with the Telegraf Operator.

  2. Add annotations on your HAProxy pods.

On your HAProxy Pods, add the following annotations:.

annotations:
   telegraf.influxdata.com/class: sumologic-prometheus
   prometheus.io/scrape: "true"
   prometheus.io/port: "9273"
   telegraf.influxdata.com/inputs: |+
       [[inputs.haproxy]]
         servers = ["http://127.0.0.1:1024/stats"]
         [inputs.haproxy.tags]
           environment="kubernetes"
           component="proxy"
           proxy_system="haproxy"
           proxy_cluster="haproxy_on_k8s"


Enter in values for the following parameters (marked in bold above):

  • telegraf.influxdata.com/inputs. This contains the required configuration for the Telegraf HAProxy Input plugin. See this doc for more information on configuring the HAProxy input plugin for Telegraf.  As telegraf will be run as a sidecar, the host should always be localhost.

    • In the input plugins section: 

      • servers. The URL to the HAProxy server. This can be a comma-separated list to connect to multiple HAProxy servers. See this doc for more information on additional parameters for configuring the HAProxy input plugin for Telegraf.

    • In the tags section [inputs.haproxy.tags]

      • environment. This is the deployment environment where the HAProxy cluster identified by the value of servers resides. For example: dev, prod or qa. While this value is optional we highly recommend setting it. 

      • proxy_cluster. Enter a name to identify this HAProxy cluster. This cluster name will be shown in the Sumo Logic dashboards. 

Here’s an explanation for additional values set by this configuration that we request you do not modify as they will cause the Sumo Logic apps to not function correctly.

  • telegraf.influxdata.com/class sumologic-prometheus - This instructs the Telegraf operator what output to use. This should not be changed.

  • prometheus.io/scrape "true" - This ensures our Prometheus will scrape the metrics.

  • prometheus.io/port "9273" - This tells prometheus what ports to scrape on. This should not be changed.

  • telegraf.influxdata.com/inputs

    • In the tags section, for example  [inputs.haproxy.tags]

      • component: “proxy” - This value is used by Sumo Logic apps to identify application components. 

      • proxy_system: “haproxy” - This value identifies the proxy system.

For all other parameters please see this doc for more properties that can be configured in the Telegraf agent globally.

  1. Kubernetes collection will start collecting metrics from the pods having the labels and annotations defined in the previous step. 

  2. Verify metrics in Sumo Logic.

Step 2 Configure Logs Collection

This section explains the steps to collect HAProxy logs from a Kubernetes environment.

  1. Add labels on your HAProxy pods to capture logs from standard output.

Follow the instructions below to capture HAProxy logs from stdout on Kubernetes.

  1. Apply following labels to the HAProxy pods:

labels:
    environment: "prod"
    component: "proxy"
    proxy_system: "haproxy"    
    proxy_cluster: "haproxy_prod_cluster01

Enter in values for the following parameters (marked in bold above):

  • environment. This is the deployment environment where the HAProxy cluster identified by the value of servers resides. For example: dev, prod or qa. While this value is optional we highly recommend setting it.

  • proxy_cluster. Enter a name to identify this HAProxy cluster. This cluster name will be shown in the Sumo Logic dashboards.

Here’s an explanation for additional values set by this configuration that we request you do not modify as they will cause the Sumo Logic apps to not function correctly.

  • component: “proxy”. This value is used by Sumo Logic apps to identify application components. 

  • proxy_system: “haproxy”. This value identifies the proxy system.

For all other parameters see this doc for more properties that can be configured in the Telegraf agent globally.

  1. Collecting HAProxy Logs from a Log File (Optional)

Follow the steps below to capture HAProxy logs from a log file on Kubernetes.

  1. Determine the location of the HAProxy log file on Kubernetes. This can be determined from the HAProxy.conf for your HAProxy cluster along with the mounts on the HAProxy pods.

  2. Install the Sumo Logic tailing sidecar operator.

  3. Add the following annotation in addition to the existing annotations.

annotations:
  tailing-sidecar: sidecarconfig;<mount>:<path_of_Haproxy_log_file>/<Haproxy_log_file_name>

Example:

annotations:
  tailing-sidecar: sidecarconfig;data:/var/log//haproxy.log
  1. Make sure that the HAProxy pods are running and annotations are applied by using the command: kubectl describe pod <haproxy_pod_name>

  2. Sumo Logic Kubernetes collection will automatically start collecting logs from the pods having the annotations defined above. 

3. Add an FER to normalize the fields in Kubernetes environments

Labels created in Kubernetes environments automatically are prefixed with pod_labels. To normalize these for our app to work, we need to create a Field Extraction Rule if not already created for Proxy Application Components. To do so:

  1. Go to Manage Data > Logs > Field Extraction Rules.

  2. Click the + Add button on the top right of the table.

  3. The following form appears:


  1. Enter the following options:

  • Rule Name. Enter the name as App Observability - Proxy.
  • Applied At. Choose Ingest Time
  • Scope. Select Specific Data
    • Scope: Enter the following keyword search expression: 
      pod_labels_environment=* pod_labels_component=proxy pod_labels_proxy_system=* pod_labels_proxy_cluster=*
  • Parse Expression.Enter the following parse expression:
| if (!isEmpty(pod_labels_environment), pod_labels_environment, "") as environment
| pod_labels_component as component
| pod_labels_proxy_system as proxy_system
| pod_labels_proxy_cluster as proxy_cluster 
  1. Click Save to create the rule.