Skip to content

LOG-1400: elasticsearch output should add app- prefix to index names #1039

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jun 23, 2021
Merged

LOG-1400: elasticsearch output should add app- prefix to index names #1039

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 10 additions & 10 deletions manifests/5.2/logging.openshift.io_clusterlogforwarders_crd.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,13 +137,13 @@ spec:
specified here will be used as default values for Elasticsearch
Output spec"
properties:
structuredIndexKey:
description: StructuredIndexKey specifies the metadata key
structuredTypeKey:
description: StructuredTypeKey specifies the metadata key
to be used as name of elasticsearch index It takes precedence
over StructuredIndexName
over StructuredTypeName
type: string
structuredIndexName:
description: StructuredIndexName specifies the name of elasticsearch
structuredTypeName:
description: StructuredTypeName specifies the name of elasticsearch
schema
type: string
type: object
Expand All @@ -158,13 +158,13 @@ spec:
properties:
elasticsearch:
properties:
structuredIndexKey:
description: StructuredIndexKey specifies the metadata key
structuredTypeKey:
description: StructuredTypeKey specifies the metadata key
to be used as name of elasticsearch index It takes precedence
over StructuredIndexName
over StructuredTypeName
type: string
structuredIndexName:
description: StructuredIndexName specifies the name of elasticsearch
structuredTypeName:
description: StructuredTypeName specifies the name of elasticsearch
schema
type: string
type: object
Expand Down
10 changes: 5 additions & 5 deletions pkg/apis/logging/v1/output_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,14 +125,14 @@ type Kafka struct {

type FluentdForward struct{}
type Elasticsearch struct {
// StructuredIndexKey specifies the metadata key to be used as name of elasticsearch index
// It takes precedence over StructuredIndexName
// StructuredTypeKey specifies the metadata key to be used as name of elasticsearch index
// It takes precedence over StructuredTypeName
//
// +optional
StructuredIndexKey string `json:"structuredIndexKey,omitempty"`
StructuredTypeKey string `json:"structuredTypeKey,omitempty"`

// StructuredIndexName specifies the name of elasticsearch schema
// StructuredTypeName specifies the name of elasticsearch schema
//
// +optional
StructuredIndexName string `json:"structuredIndexName,omitempty"`
StructuredTypeName string `json:"structuredTypeName,omitempty"`
}
4 changes: 2 additions & 2 deletions pkg/generators/forwarding/fluentd/fluent_conf.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,10 +163,10 @@ func (conf *outputLabelConf) IsElasticSearchOutput() bool {
return conf.Target.Type == logging.OutputTypeElasticsearch
}

func (conf *outputLabelConf) NeedChangeElasticsearchStructuredIndexName() bool {
func (conf *outputLabelConf) NeedChangeElasticsearchStructuredType() bool {
return conf.Target.Type == logging.OutputTypeElasticsearch &&
conf.Target.OutputTypeSpec.Elasticsearch != nil &&
(conf.Target.OutputTypeSpec.Elasticsearch.StructuredIndexKey != "" || conf.Target.OutputTypeSpec.Elasticsearch.StructuredIndexName != "")
(conf.Target.OutputTypeSpec.Elasticsearch.StructuredTypeKey != "" || conf.Target.OutputTypeSpec.Elasticsearch.StructuredTypeName != "")
}

func generateRubyDigArgs(path string) string {
Expand Down
40 changes: 40 additions & 0 deletions pkg/generators/forwarding/fluentd/fluent_conf_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -564,6 +564,10 @@ var _ = Describe("Generating fluentd config", func() {

# Ship logs to specific outputs
<label @APPS_ES_1>
<filter **>
@type record_modifier
remove_keys structured
</filter>
#flatten labels to prevent field explosion in ES
<filter ** >
@type record_transformer
Expand Down Expand Up @@ -674,6 +678,10 @@ var _ = Describe("Generating fluentd config", func() {
</match>
</label>
<label @APPS_ES_2>
<filter **>
@type record_modifier
remove_keys structured
</filter>
#flatten labels to prevent field explosion in ES
<filter ** >
@type record_transformer
Expand Down Expand Up @@ -1279,6 +1287,10 @@ var _ = Describe("Generating fluentd config", func() {

# Ship logs to specific outputs
<label @APPS_ES_1>
<filter **>
@type record_modifier
remove_keys structured
</filter>
#flatten labels to prevent field explosion in ES
<filter ** >
@type record_transformer
Expand Down Expand Up @@ -1381,6 +1393,10 @@ var _ = Describe("Generating fluentd config", func() {
</match>
</label>
<label @APPS_ES_2>
<filter **>
@type record_modifier
remove_keys structured
</filter>
#flatten labels to prevent field explosion in ES
<filter ** >
@type record_transformer
Expand Down Expand Up @@ -1982,6 +1998,10 @@ var _ = Describe("Generating fluentd config", func() {

# Ship logs to specific outputs
<label @APPS_ES_1>
<filter **>
@type record_modifier
remove_keys structured
</filter>
#flatten labels to prevent field explosion in ES
<filter ** >
@type record_transformer
Expand Down Expand Up @@ -2084,6 +2104,10 @@ var _ = Describe("Generating fluentd config", func() {
</match>
</label>
<label @APPS_ES_2>
<filter **>
@type record_modifier
remove_keys structured
</filter>
#flatten labels to prevent field explosion in ES
<filter ** >
@type record_transformer
Expand Down Expand Up @@ -3105,6 +3129,10 @@ var _ = Describe("Generating fluentd config", func() {

# Ship logs to specific outputs
<label @INFRA_ES>
<filter **>
@type record_modifier
remove_keys structured
</filter>
#flatten labels to prevent field explosion in ES
<filter ** >
@type record_transformer
Expand Down Expand Up @@ -3209,6 +3237,10 @@ var _ = Describe("Generating fluentd config", func() {
</match>
</label>
<label @APPS_ES_1>
<filter **>
@type record_modifier
remove_keys structured
</filter>
#flatten labels to prevent field explosion in ES
<filter ** >
@type record_transformer
Expand Down Expand Up @@ -3313,6 +3345,10 @@ var _ = Describe("Generating fluentd config", func() {
</match>
</label>
<label @APPS_ES_2>
<filter **>
@type record_modifier
remove_keys structured
</filter>
#flatten labels to prevent field explosion in ES
<filter ** >
@type record_transformer
Expand Down Expand Up @@ -3417,6 +3453,10 @@ var _ = Describe("Generating fluentd config", func() {
</match>
</label>
<label @AUDIT_ES>
<filter **>
@type record_modifier
remove_keys structured
</filter>
#flatten labels to prevent field explosion in ES
<filter ** >
@type record_transformer
Expand Down
8 changes: 8 additions & 0 deletions pkg/generators/forwarding/fluentd/output_conf_es_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,10 @@ var _ = Describe("Generating fluentd config blocks", func() {
results, err := generator.generateOutputLabelBlocks(outputs, nil, forwarderSpec)
Expect(err).To(BeNil())
Expect(results[0]).To(EqualTrimLines(`<label @ONCLUSTER_ELASTICSEARCH>
<filter **>
@type record_modifier
remove_keys structured
</filter>
#flatten labels to prevent field explosion in ES
<filter ** >
@type record_transformer
Expand Down Expand Up @@ -186,6 +190,10 @@ var _ = Describe("Generating fluentd config blocks", func() {
results, err := generator.generateOutputLabelBlocks(outputs, nil, forwarderSpec)
Expect(err).To(BeNil())
Expect(results[0]).To(EqualTrimLines(`<label @OTHER_ELASTICSEARCH>
<filter **>
@type record_modifier
remove_keys structured
</filter>
#flatten labels to prevent field explosion in ES
<filter ** >
@type record_transformer
Expand Down
12 changes: 12 additions & 0 deletions pkg/generators/forwarding/fluentd/output_fluentd_buffer_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,10 @@ var _ = Describe("Generating fluentd config", func() {
It("should provide a default buffer configuration", func() {
esConf := `
<label @OTHER_ELASTICSEARCH>
<filter **>
@type record_modifier
remove_keys structured
</filter>
#flatten labels to prevent field explosion in ES
<filter ** >
@type record_transformer
Expand Down Expand Up @@ -182,6 +186,10 @@ var _ = Describe("Generating fluentd config", func() {
It("should provide a default buffer configuration", func() {
esConf := `
<label @OTHER_ELASTICSEARCH>
<filter **>
@type record_modifier
remove_keys structured
</filter>
#flatten labels to prevent field explosion in ES
<filter ** >
@type record_transformer
Expand Down Expand Up @@ -287,6 +295,10 @@ var _ = Describe("Generating fluentd config", func() {
It("should override buffer configuration for given tuning parameters", func() {
esConf := `
<label @OTHER_ELASTICSEARCH>
<filter **>
@type record_modifier
remove_keys structured
</filter>
#flatten labels to prevent field explosion in ES
<filter ** >
@type record_transformer
Expand Down
15 changes: 10 additions & 5 deletions pkg/generators/forwarding/fluentd/templates.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -617,15 +617,20 @@ const pipelineToOutputCopyTemplate = `{{- define "pipelineToOutputCopyTemplate"

const outputLabelConfTemplate = `{{- define "outputLabelConf" -}}
<label {{.LabelName}}>
{{- if (.NeedChangeElasticsearchStructuredIndexName)}}
{{- if (.NeedChangeElasticsearchStructuredType)}}
<filter **>
@type record_modifier
<record>
indexFromKey ${record.dig({{.GetKeyVal .Target.OutputTypeSpec.Elasticsearch.StructuredIndexKey}})}
hasStructuredIndexName "{{.Target.OutputTypeSpec.Elasticsearch.StructuredIndexName}}"
viaq_index_name ${if !record['indexFromKey'].nil?; record['indexFromKey']; elsif record['hasStructuredIndexName'] != ""; record['hasStructuredIndexName']; else record['viaq_index_name']; end;}
typeFromKey ${record.dig({{.GetKeyVal .Target.OutputTypeSpec.Elasticsearch.StructuredTypeKey}})}
hasStructuredTypeName "{{.Target.OutputTypeSpec.Elasticsearch.StructuredTypeName}}"
viaq_index_name ${ if !record['structured'].nil? && record['structured'] != {}; if !record['typeFromKey'].nil?; "app-"+record['typeFromKey']+"-write"; elsif record['hasStructuredTypeName'] != ""; "app-"+record['hasStructuredTypeName']+"-write"; else record['viaq_index_name']; end; else record['viaq_index_name']; end;}
</record>
remove_keys indexFromKey, hasStructuredIndexName
remove_keys typeFromKey, hasStructuredTypeName
</filter>
{{- else}}
<filter **>
@type record_modifier
remove_keys structured
</filter>
{{- end}}
{{- if .IsElasticSearchOutput}}
Expand Down
8 changes: 4 additions & 4 deletions pkg/k8shandler/forwarding_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -326,7 +326,7 @@ var _ = Describe("Normalizing forwarder", func() {
request.ForwarderSpec = logging.ClusterLogForwarderSpec{
OutputDefaults: &logging.OutputDefaults{
Elasticsearch: &logging.Elasticsearch{
StructuredIndexKey: "kubernetes.labels.mylabel",
StructuredTypeKey: "kubernetes.labels.mylabel",
},
},
Pipelines: []logging.PipelineSpec{
Expand All @@ -340,7 +340,7 @@ var _ = Describe("Normalizing forwarder", func() {
_, _ = request.generateCollectorConfig()

Expect(len(request.ForwarderSpec.Outputs) == 1).To(BeTrue())
Expect(request.ForwarderSpec.Outputs[0].Elasticsearch.StructuredIndexKey).To(Equal("kubernetes.labels.mylabel"))
Expect(request.ForwarderSpec.Outputs[0].Elasticsearch.StructuredTypeKey).To(Equal("kubernetes.labels.mylabel"))

})
It("should setup values for elasticsearch output", func() {
Expand All @@ -357,7 +357,7 @@ var _ = Describe("Normalizing forwarder", func() {
request.ForwarderSpec = logging.ClusterLogForwarderSpec{
OutputDefaults: &logging.OutputDefaults{
Elasticsearch: &logging.Elasticsearch{
StructuredIndexKey: "kubernetes.labels.mylabel",
StructuredTypeKey: "kubernetes.labels.mylabel",
},
},
Outputs: []logging.OutputSpec{
Expand All @@ -378,7 +378,7 @@ var _ = Describe("Normalizing forwarder", func() {
_, _ = request.generateCollectorConfig()

Expect(len(request.ForwarderSpec.Outputs) == 1).To(BeTrue())
Expect(request.ForwarderSpec.Outputs[0].Elasticsearch.StructuredIndexKey).To(Equal("kubernetes.labels.mylabel"))
Expect(request.ForwarderSpec.Outputs[0].Elasticsearch.StructuredTypeKey).To(Equal("kubernetes.labels.mylabel"))

})
})
Expand Down
Loading