Autodiscover

Autodiscover allows you to watch for system changes and dynamically adapt settings to them, as they happen. This is specially useful when running your infrastructure on containers.

When you run an application on containers it becomes a moving target to the monitoring system. Autodiscover allows you to automatically detect what’s running and update settings to monitor it.

You can define configuration templates for different containers. Autodiscover subsystem will use them to monitor services as they start running.

You define autodiscover settings in the filebeat.autodiscover section of the filebeat.yml config file. To enable autodiscover, you specify a list of providers.

Autodiscover providers work by watching for events on the system and translating those events into internal autodiscover events with a common format. When you configure the provider, you can use fields from the autodiscover event to set conditions that, when met, launch specific configurations.

Docker autodiscover provider watches for Docker containers start and stop. These are the available fields on every event:

For example:

{
  "host": "10.4.15.9",
  "port": 6379,
  "docker": {
    "container": {
      "id": "382184ecdb385cfd5d1f1a65f78911054c8511ae009635300ac28b4fc357ce51"
      "name": "redis",
      "image": "redis:3.2.11",
      "labels": {
        "io.kubernetes.pod.namespace": "default"
        ...
      }
    }
  }
}

You can define a set of configuration templates to be applied when the condition matches an event. Templates define a condition to match on autodiscover events, together with the list of configurations to launch when this condition happens.

Conditions match events from the provider. Providers use the same format for Conditions that processors use.

Configuration templates can contain variables from the autodiscover event. They can be accessed under data namespace. For example, with the example event, "${data.port}" will resolves to 6379.

Filebeat supports templates for both prospectors and modules.

filebeat.autodiscover:
  providers:
    - type: docker
      templates:
        - condition:
            equals:
              docker.container.image: redis
          config:
            - type: docker
              containers.ids:
                - "${data.docker.container.id}"
              exclude_lines: ["^\\s+[\\-`('.|_]"]  # drop asciiart lines

This configuration launches a docker logs prospector for all containers running an image with redis in the name.

If you are using modules, you can override the default prospector and use the docker prospector instead.

filebeat.autodiscover:
  providers:
    - type: docker
      templates:
        - condition:
            equals:
              docker.container.image: "redis"
          config:
            - module: redis
              log:
                prospector:
                  type: docker
                  containers.ids:
                    - "${data.docker.container.id}"