// Licensed to Elasticsearch B.V. under one or more contributor // license agreements. See the NOTICE file distributed with // this work for additional information regarding copyright // ownership. Elasticsearch B.V. licenses this file to you under // the Apache License, Version 2.0 (the "License"); you may // not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, // software distributed under the License is distributed on an // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY // KIND, either express or implied. See the License for the // specific language governing permissions and limitations // under the License. package image import ( "context" "github.com/docker/docker/api/types" "github.com/docker/docker/client" "github.com/elastic/beats/libbeat/common" "github.com/elastic/beats/metricbeat/mb" "github.com/elastic/beats/metricbeat/module/docker" ) // init registers the MetricSet with the central registry. // The New method will be called after the setup of the module and before starting to fetch data func init() { mb.Registry.MustAddMetricSet("docker", "image", New, mb.WithHostParser(docker.HostParser), ) } // MetricSet type defines all fields of the MetricSet // As a minimum it must inherit the mb.BaseMetricSet fields, but can be extended with // additional entries. These variables can be used to persist data or configuration between // multiple fetch calls. type MetricSet struct { mb.BaseMetricSet dockerClient *client.Client dedot bool } // New create a new instance of the MetricSet // Part of new is also setting up the configuration by processing additional // configuration entries if needed. func New(base mb.BaseMetricSet) (mb.MetricSet, error) { config := docker.DefaultConfig() if err := base.Module().UnpackConfig(&config); err != nil { return nil, err } client, err := docker.NewDockerClient(base.HostData().URI, config) if err != nil { return nil, err } return &MetricSet{ BaseMetricSet: base, dockerClient: client, dedot: config.DeDot, }, nil } // Fetch methods implements the data gathering and data conversion to the right format // It returns the event which is then forward to the output. In case of an error, a // descriptive error must be returned. func (m *MetricSet) Fetch() ([]common.MapStr, error) { images, err := m.dockerClient.ImageList(context.TODO(), types.ImageListOptions{}) if err != nil { return nil, err } return eventsMapping(images, m.dedot), nil }