LOG-4812: Refactor metrics templates and helper functions #2244
There are no files selected for viewing
This file contains hidden or 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 hidden or 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,21 @@ | ||
| package helpers | ||
|
|
||
| import ( | ||
| log "github.com/ViaQ/logerr/v2/log/static" | ||
| logging "github.com/openshift/cluster-logging-operator/apis/logging/v1" | ||
| "github.com/openshift/cluster-logging-operator/internal/constants" | ||
| corev1 "k8s.io/api/core/v1" | ||
| ) | ||
|
|
||
| func GetOutputSecret(o logging.OutputSpec, secrets map[string]*corev1.Secret) *corev1.Secret { | ||
| if s, ok := secrets[o.Name]; ok { | ||
| log.V(9).Info("Using secret configured in output: " + o.Name) | ||
| return s | ||
| } | ||
| if s := secrets[constants.LogCollectorToken]; s != nil { | ||
| log.V(9).Info("Using secret configured in " + constants.LogCollectorToken) | ||
| return s | ||
| } | ||
| log.V(9).Info("No Secret found in " + constants.LogCollectorToken) | ||
| return nil | ||
| } |
This file contains hidden or 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,16 @@ | ||
| package helpers | ||
|
|
||
| import ( | ||
| logging "github.com/openshift/cluster-logging-operator/apis/logging/v1" | ||
| "github.com/openshift/cluster-logging-operator/internal/generator/framework" | ||
| ) | ||
|
|
||
| func SetTLSProfileOptions(o logging.OutputSpec, op framework.Options) { | ||
| op[framework.MinTLSVersion], op[framework.Ciphers] = func() (string, string) { | ||
| if o.Name == logging.OutputNameDefault && o.Type == logging.OutputTypeElasticsearch { | ||
| return "", "" | ||
| } else { | ||
| return op.TLSProfileInfo(o, ",") | ||
| } | ||
| }() | ||
| } | ||
This file contains hidden or 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 hidden or 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 hidden or 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,17 @@ | ||
| package common | ||
|
|
||
| import ( | ||
| "fmt" | ||
| logging "github.com/openshift/cluster-logging-operator/apis/logging/v1" | ||
| "github.com/openshift/cluster-logging-operator/internal/generator/framework" | ||
| "github.com/openshift/cluster-logging-operator/internal/generator/vector/normalize" | ||
| ) | ||
|
|
||
| const ( | ||
| UserDefinedSinkThrottle = `sink_throttle_%s` | ||
| ) | ||
|
|
||
| func AddThrottleForSink(spec *logging.OutputSpec, inputs []string) []framework.Element { | ||
| id := fmt.Sprintf(UserDefinedSinkThrottle, spec.Name) | ||
| return normalize.NewThrottle(id, inputs, spec.Limit.MaxRecordsPerSecond, "") | ||
| } |
This file contains hidden or 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,77 @@ | ||
| package metrics | ||
|
|
||
| import ( | ||
| "github.com/openshift/cluster-logging-operator/internal/generator/framework" | ||
| "github.com/openshift/cluster-logging-operator/internal/generator/vector/helpers" | ||
| ) | ||
|
|
||
| const ( | ||
| AddNodenameToMetricTransformName = "add_nodename_to_metric" | ||
| PrometheusOutputSinkName = "prometheus_output" | ||
| PrometheusExporterListenPort = `24231` | ||
| ) | ||
|
|
||
| type PrometheusExporter struct { | ||
| ID string | ||
| Inputs string | ||
| Address string | ||
| TlsMinVersion string | ||
| CipherSuites string | ||
| } | ||
|
|
||
| func (p PrometheusExporter) Name() string { | ||
| return "PrometheusExporterTemplate" | ||
| } | ||
|
|
||
| func (p PrometheusExporter) Template() string { | ||
| return `{{define "` + p.Name() + `" -}} | ||
| [sinks.{{.ID}}] | ||
| type = "prometheus_exporter" | ||
| inputs = {{.Inputs}} | ||
| address = "{{.Address}}" | ||
| default_namespace = "collector" | ||
| [sinks.{{.ID}}.tls] | ||
| enabled = true | ||
| key_file = "/etc/collector/metrics/tls.key" | ||
| crt_file = "/etc/collector/metrics/tls.crt" | ||
| min_tls_version = "{{.TlsMinVersion}}" | ||
| ciphersuites = "{{.CipherSuites}}" | ||
| {{end}}` | ||
| } | ||
|
|
||
| type AddNodenameToMetric struct { | ||
|
There was a problem hiding this comment. AddNodeNameToMetric is only used in one place, together with the PrometheusOutput, may be we could just inline it into There was a problem hiding this comment. And even merge There was a problem hiding this comment. sounds like a future refactoring |
||
| ID string | ||
| Inputs string | ||
| } | ||
|
|
||
| func (a AddNodenameToMetric) Name() string { | ||
| return AddNodenameToMetricTransformName | ||
| } | ||
|
|
||
| func (a AddNodenameToMetric) Template() string { | ||
| return `{{define "` + a.Name() + `" -}} | ||
| [transforms.{{.ID}}] | ||
| type = "remap" | ||
| inputs = {{.Inputs}} | ||
| source = ''' | ||
| .tags.hostname = get_env_var!("VECTOR_SELF_NODE_NAME") | ||
| ''' | ||
| {{end}}` | ||
| } | ||
|
|
||
| func PrometheusOutput(id string, inputs []string, minTlsVersion string, cipherSuites string) framework.Element { | ||
| return PrometheusExporter{ | ||
| ID: id, | ||
| Inputs: helpers.MakeInputs(inputs...), | ||
| Address: helpers.ListenOnAllLocalInterfacesAddress() + `:` + PrometheusExporterListenPort, | ||
| TlsMinVersion: minTlsVersion, | ||
| CipherSuites: cipherSuites, | ||
| } | ||
| } | ||
|
|
||
| func AddNodeNameToMetric(id string, inputs []string) framework.Element { | ||
| return AddNodenameToMetric{ | ||
| ID: id, | ||
| Inputs: helpers.MakeInputs(inputs...), | ||
| } | ||
| } | ||
This file contains hidden or 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How 'bout