-
Notifications
You must be signed in to change notification settings - Fork 2.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[receiver/dockerstatsreceiver] refactor docker client (#4702)
Moving docker client into new shared internal/docker **Description:** The client in the docker stats receiver has useful functionality for use in other components, such as the docker observer. **Link to tracking Issue:** #4446
- Loading branch information
Mark Stumpf
authored
Sep 21, 2021
1 parent
ce2ec25
commit 95f5018
Showing
19 changed files
with
1,725 additions
and
101 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
include ../../Makefile.Common |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
// Copyright 2020, OpenTelemetry Authors | ||
// | ||
// Licensed 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 docker | ||
|
||
import ( | ||
"errors" | ||
"fmt" | ||
"time" | ||
) | ||
|
||
type Config struct { | ||
// The URL of the docker server. Default is "unix:///var/run/docker.sock" | ||
Endpoint string `mapstructure:"endpoint"` | ||
|
||
// The maximum amount of time to wait for docker API responses. Default is 5s | ||
Timeout time.Duration `mapstructure:"timeout"` | ||
|
||
// A list of filters whose matching images are to be excluded. Supports literals, globs, and regex. | ||
ExcludedImages []string `mapstructure:"excluded_images"` | ||
|
||
// Docker client API version. | ||
DockerAPIVersion float64 `mapstructure:"api_version"` | ||
} | ||
|
||
// NewConfig creates a new config to be used when creating | ||
// a docker client | ||
func NewConfig(endpoint string, timeout time.Duration, excludedImages []string, apiVersion float64) (*Config, error) { | ||
cfg := &Config{ | ||
Endpoint: endpoint, | ||
Timeout: timeout, | ||
ExcludedImages: excludedImages, | ||
DockerAPIVersion: apiVersion, | ||
} | ||
|
||
err := cfg.validate() | ||
return cfg, err | ||
} | ||
|
||
// NewDefaultConfig creates a new config with default values | ||
// to be used when creating a docker client | ||
func NewDefaultConfig() *Config { | ||
cfg := &Config{ | ||
Endpoint: "unix:///var/run/docker.sock", | ||
Timeout: 5 * time.Second, | ||
DockerAPIVersion: minimalRequiredDockerAPIVersion, | ||
} | ||
|
||
return cfg | ||
} | ||
|
||
// validate asserts that an endpoint field is set | ||
// on the config struct | ||
func (config Config) validate() error { | ||
if config.Endpoint == "" { | ||
return errors.New("config.Endpoint must be specified") | ||
} | ||
if config.DockerAPIVersion < minimalRequiredDockerAPIVersion { | ||
return fmt.Errorf("Docker API version must be at least %v", minimalRequiredDockerAPIVersion) | ||
} | ||
return nil | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.