Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make proxy optional for k8s_metadata_decorator #239

Merged
merged 4 commits into from
Jan 4, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@ All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## Unreleased

### Fixed
- `k8s_metadata_decorator` using a proxy causes internal API timeout

## [0.13.8] - 2020-12-30
### Fixed
- `file_input` exclude processing could result in extra exclusions
Expand Down
1 change: 1 addition & 0 deletions docs/operators/k8s_metadata_decorator.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ The `k8s_metadata_decorator` operator adds labels and annotations to the entry u
| `pod_name_field` | `pod_name` | A [field](/docs/types/field.md) that contains the k8s pod name associated with the log entry |
| `cache_ttl` | 10m | A [duration](/docs/types/duration.md) indicating the time it takes for a cached entry to expire |
| `timeout` | 10s | A [duration](/docs/types/duration.md) indicating how long to wait for the API to respond before timing out |
| `allow_proxy` | false | Controls whether or not the agent will take into account [proxy](https://github.com/observIQ/stanza/blob/master/docs/proxy.md) configuration when communicating with the k8s metadata api |
| `if` | | An [expression](/docs/types/expression.md) that, when set, will be evaluated to determine whether this operator should be used for the given entry. This allows you to do easy conditional parsing without branching logic with routers. |

### Example Configurations
Expand Down
8 changes: 6 additions & 2 deletions operator/builtin/parser/syslog/syslog_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ import (
)

func TestSyslogParser(t *testing.T) {
now := func() time.Time {
return time.Date(2020, 06, 16, 3, 31, 34, 525, time.UTC)
}

basicConfig := func() *SyslogParserConfig {
cfg := NewSyslogParserConfig("test_operator_id")
cfg.OutputIDs = []string{"fake"}
Expand All @@ -35,7 +39,7 @@ func TestSyslogParser(t *testing.T) {
return cfg
}(),
"<34>Jan 12 06:30:00 1.2.3.4 apache_server: test message",
time.Date(time.Now().Year(), 1, 12, 6, 30, 0, 0, time.UTC),
time.Date(now().Year(), 1, 12, 6, 30, 0, 0, time.UTC),
map[string]interface{}{
"appname": "apache_server",
"facility": 4,
Expand All @@ -54,7 +58,7 @@ func TestSyslogParser(t *testing.T) {
return cfg
}(),
[]byte("<34>Jan 12 06:30:00 1.2.3.4 apache_server: test message"),
time.Date(time.Now().Year(), 1, 12, 6, 30, 0, 0, time.UTC),
time.Date(now().Year(), 1, 12, 6, 30, 0, 0, time.UTC),
map[string]interface{}{
"appname": "apache_server",
"facility": 4,
Expand Down
12 changes: 12 additions & 0 deletions operator/builtin/transformer/k8smetadata/k8s_metadata_decorator.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ import (
"context"
"sync"
"time"
"net/url"
"net/http"

"github.com/observiq/stanza/entry"
"github.com/observiq/stanza/errors"
Expand All @@ -29,6 +31,7 @@ func NewK8sMetadataDecoratorConfig(operatorID string) *K8sMetadataDecoratorConfi
NamespaceField: entry.NewResourceField("k8s.namespace.name"),
CacheTTL: helper.Duration{Duration: 10 * time.Minute},
Timeout: helper.Duration{Duration: 10 * time.Second},
AllowProxy: false,
}
}

Expand All @@ -39,6 +42,7 @@ type K8sMetadataDecoratorConfig struct {
NamespaceField entry.Field `json:"namespace_field,omitempty" yaml:"namespace_field,omitempty"`
CacheTTL helper.Duration `json:"cache_ttl,omitempty" yaml:"cache_ttl,omitempty"`
Timeout helper.Duration `json:"timeout,omitempty" yaml:"timeout,omitempty"`
AllowProxy bool `json:"allow_proxy,omitempty" yaml:"allow_proxy,omitempty"`
}

// Build will build a k8s_metadata_decorator operator from the supplied configuration
Expand All @@ -54,6 +58,7 @@ func (c K8sMetadataDecoratorConfig) Build(context operator.BuildContext) ([]oper
namespaceField: c.NamespaceField,
cacheTTL: c.CacheTTL.Raw(),
timeout: c.Timeout.Raw(),
allowProxy: c.AllowProxy,
}

return []operator.Operator{op}, nil
Expand All @@ -73,6 +78,7 @@ type K8sMetadataDecorator struct {
podCache MetadataCache
cacheTTL time.Duration
timeout time.Duration
allowProxy bool
}

// MetadataCacheEntry is an entry in the metadata cache
Expand Down Expand Up @@ -115,6 +121,12 @@ func (k *K8sMetadataDecorator) Start() error {
)
}

if ! k.allowProxy {
config.Proxy = func (*http.Request) (*url.URL, error) {
return nil, nil
}
}

clientset, err := kubernetes.NewForConfig(config)
if err != nil {
return errors.Wrap(err, "build client set")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ func TestK8sMetadataDecoratorBuildDefault(t *testing.T) {
namespaceField: entry.NewResourceField("k8s.namespace.name"),
cacheTTL: 10 * time.Minute,
timeout: 10 * time.Second,
allowProxy: false,
}

ops, err := cfg.Build(testutil.NewBuildContext(t))
Expand Down