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

Rename kubernetes processor -> add_kubernetes_metadata #4473

Merged
merged 2 commits into from
Jun 15, 2017
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
2 changes: 2 additions & 0 deletions CHANGELOG.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ https://github.com/elastic/beats/compare/v6.0.0-alpha1...master[Check the HEAD d

*Affecting all Beats*

- Rename `kubernetes` processor to `add_kubernetes_metadata`. {pull}4473[4473]

*Filebeat*

*Heartbeat*
Expand Down
2 changes: 1 addition & 1 deletion filebeat/beater/filebeat.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import (
"github.com/elastic/beats/filebeat/spooler"

// Add filebeat level processors
_ "github.com/elastic/beats/filebeat/processor/kubernetes"
_ "github.com/elastic/beats/filebeat/processor/add_kubernetes_metadata"
)

var (
Expand Down
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
package kubernetes
package add_kubernetes_metadata

import (
"fmt"
"strings"

"github.com/elastic/beats/libbeat/common"
"github.com/elastic/beats/libbeat/logp"
"github.com/elastic/beats/libbeat/processors/kubernetes"
"github.com/elastic/beats/libbeat/processors/add_kubernetes_metadata"
)

func init() {
kubernetes.Indexing.AddMatcher(LogPathMatcherName, newLogsPathMatcher)
add_kubernetes_metadata.Indexing.AddMatcher(LogPathMatcherName, newLogsPathMatcher)
cfg := common.NewConfig()

//Add a container indexer config by default.
kubernetes.Indexing.AddDefaultIndexerConfig(kubernetes.ContainerIndexerName, *cfg)
add_kubernetes_metadata.Indexing.AddDefaultIndexerConfig(add_kubernetes_metadata.ContainerIndexerName, *cfg)

//Add a log path matcher which can extract container ID from the "source" field.
kubernetes.Indexing.AddDefaultMatcherConfig(LogPathMatcherName, *cfg)
add_kubernetes_metadata.Indexing.AddDefaultMatcherConfig(LogPathMatcherName, *cfg)
}

const LogPathMatcherName = "logs_path"
Expand All @@ -26,7 +26,7 @@ type LogPathMatcher struct {
LogsPath string
}

func newLogsPathMatcher(cfg common.Config) (kubernetes.Matcher, error) {
func newLogsPathMatcher(cfg common.Config) (add_kubernetes_metadata.Matcher, error) {
config := struct {
LogsPath string `config:"logs_path"`
}{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package kubernetes
package add_kubernetes_metadata

import (
"fmt"
Expand Down
2 changes: 1 addition & 1 deletion libbeat/beat/beat.go
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@ import (
_ "github.com/elastic/beats/libbeat/processors/actions"
_ "github.com/elastic/beats/libbeat/processors/add_cloud_metadata"
_ "github.com/elastic/beats/libbeat/processors/add_docker_metadata"
_ "github.com/elastic/beats/libbeat/processors/add_kubernetes_metadata"
_ "github.com/elastic/beats/libbeat/processors/add_locale"
_ "github.com/elastic/beats/libbeat/processors/kubernetes"

// Register default monitoring reporting
_ "github.com/elastic/beats/libbeat/monitoring/report/elasticsearch"
Expand Down
17 changes: 9 additions & 8 deletions libbeat/docs/processors-using.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ The supported processors are:
* <<drop-event,`drop_event`>>
* <<drop-fields,`drop_fields`>>
* <<include-fields,`include_fields`>>
* <<kubernetes,`kubernetes`>>
* <<add-kubernetes-metadata,`add_kubernetes_metadata`>>
* <<add-docker-metadata,`add_docker_metadata`>>

[[conditions]]
Expand Down Expand Up @@ -492,17 +492,18 @@ section.
NOTE: If you define an empty list of fields under `include_fields`, then only
the required fields, `@timestamp` and `type`, are exported.

[[kubernetes]]
[[add-kubernetes-metadata]]
=== Adding Kubernetes Metadata

The `kubernetes` processor annotates each event with relevant metadata based on
which Kubernetes pod the event originated from. Each event is annotated with:
The `add_kubernetes_metadata` processor annotates each event with relevant
metadata based on which Kubernetes pod the event originated from. Each event is
annotated with:

* Pod Name
* Namespace
* Labels

The `kubernetes` processor has two basic building blocks which are:
The `add_kubernetes_metadata` processor has two basic building blocks which are:

* Indexers
* Matchers
Expand All @@ -526,7 +527,7 @@ Kubernetes.
[source,yaml]
-------------------------------------------------------------------------------
processors:
- kubernetes:
- add_kubernetes_metadata:
in_cluster: true
-------------------------------------------------------------------------------

Expand All @@ -536,7 +537,7 @@ the Kubernetes node.
[source,yaml]
-------------------------------------------------------------------------------
processors:
- kubernetes:
- add_kubernetes_metadata:
in_cluster: false
host: <hostname>
kube_config: ${HOME}/.kube/config
Expand All @@ -548,7 +549,7 @@ enables ones that the user is interested in.
[source,yaml]
-------------------------------------------------------------------------------
processors:
- kubernetes:
- add_kubernetes_metadata:
in_cluster: false
host: <hostname>
kube_config: ~/.kube/config
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package kubernetes
package add_kubernetes_metadata

import (
"time"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package kubernetes
package add_kubernetes_metadata

import (
"fmt"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package kubernetes
package add_kubernetes_metadata

import (
"testing"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package kubernetes
package add_kubernetes_metadata

import (
"context"
Expand Down Expand Up @@ -30,7 +30,7 @@ type kubernetesAnnotator struct {
}

func init() {
processors.RegisterPlugin("kubernetes", newKubernetesAnnotator)
processors.RegisterPlugin("add_kubernetes_metadata", newKubernetesAnnotator)

// Register default indexers
Indexing.AddIndexer(PodNameIndexerName, NewPodNameIndexer)
Expand Down Expand Up @@ -208,7 +208,7 @@ func (k kubernetesAnnotator) Run(event common.MapStr) (common.MapStr, error) {
return event, nil
}

func (k kubernetesAnnotator) String() string { return "kubernetes" }
func (k kubernetesAnnotator) String() string { return "add_kubernetes_metadata" }

func validate(config kubeAnnotatorConfig) error {
if !config.InCluster && config.KubeConfig == "" {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package kubernetes
package add_kubernetes_metadata

import (
"context"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package kubernetes
package add_kubernetes_metadata

import (
"errors"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package kubernetes
package add_kubernetes_metadata

type ObjectMeta struct {
Annotations map[string]string `json:"annotations"`
Expand Down
2 changes: 1 addition & 1 deletion metricbeat/beater/metricbeat.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import (
"github.com/pkg/errors"

// Add metricbeat specific processors
_ "github.com/elastic/beats/metricbeat/processor/kubernetes"
_ "github.com/elastic/beats/metricbeat/processor/add_kubernetes_metadata"
)

// Metricbeat implements the Beater interface for metricbeat.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
package kubernetes
package add_kubernetes_metadata

import (
"fmt"
"strings"

"github.com/elastic/beats/libbeat/common"
"github.com/elastic/beats/libbeat/processors/kubernetes"
kubernetes "github.com/elastic/beats/libbeat/processors/add_kubernetes_metadata"
)

const (
Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
package kubernetes
package add_kubernetes_metadata

import (
"fmt"
"testing"

"github.com/elastic/beats/libbeat/common"
"github.com/elastic/beats/libbeat/processors/kubernetes"
"github.com/stretchr/testify/assert"

"github.com/elastic/beats/libbeat/common"
"github.com/elastic/beats/libbeat/processors/add_kubernetes_metadata"
)

var metagen = &kubernetes.GenDefaultMeta{}
var metagen = &add_kubernetes_metadata.GenDefaultMeta{}

func TestIpPortIndexer(t *testing.T) {
var testConfig = common.NewConfig()
Expand All @@ -22,19 +23,19 @@ func TestIpPortIndexer(t *testing.T) {
container := "container"
ip := "1.2.3.4"
port := int64(80)
pod := kubernetes.Pod{
Metadata: kubernetes.ObjectMeta{
pod := add_kubernetes_metadata.Pod{
Metadata: add_kubernetes_metadata.ObjectMeta{
Name: podName,
Namespace: ns,
Labels: map[string]string{
"labelkey": "labelvalue",
},
},
Spec: kubernetes.PodSpec{
Containers: make([]kubernetes.Container, 0),
Spec: add_kubernetes_metadata.PodSpec{
Containers: make([]add_kubernetes_metadata.Container, 0),
},

Status: kubernetes.PodStatus{
Status: add_kubernetes_metadata.PodStatus{
PodIP: ip,
},
}
Expand All @@ -53,10 +54,10 @@ func TestIpPortIndexer(t *testing.T) {
},
}

pod.Spec.Containers = []kubernetes.Container{
pod.Spec.Containers = []add_kubernetes_metadata.Container{
{
Name: container,
Ports: []kubernetes.ContainerPort{
Ports: []add_kubernetes_metadata.ContainerPort{
{
Name: container,
ContainerPort: port,
Expand Down