-
Notifications
You must be signed in to change notification settings - Fork 2.4k
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
[exporter/elasticsearch] route based on data stream attributes #33755
Closed
andrzej-stencel
wants to merge
4
commits into
open-telemetry:main
from
andrzej-stencel:route-on-data-stream-attributes
Closed
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
27 changes: 27 additions & 0 deletions
27
.chloggen/elasticsearch-exporter-attribute-based-data-stream-routing.yaml
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,27 @@ | ||
# Use this changelog template to create an entry for release notes. | ||
|
||
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' | ||
change_type: enhancement | ||
|
||
# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver) | ||
component: exporter/elasticsearch | ||
|
||
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). | ||
note: Add data stream routing | ||
|
||
# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. | ||
issues: [33755] | ||
|
||
# (Optional) One or more lines of additional information to render under the primary note. | ||
# These lines will be padded with 2 spaces and then inserted directly into the document. | ||
# Use pipe (|) for multiline entries. | ||
subtext: | ||
|
||
# If your change doesn't affect end users or the exported elements of any package, | ||
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label. | ||
# Optional: The change log or logs in which this entry should be included. | ||
# e.g. '[user]' or '[user, api]' | ||
# Include 'user' if the change is relevant to end users. | ||
# Include 'api' if there is a change to a library API. | ||
# Default: '[user]' | ||
change_logs: [] |
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
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,67 @@ | ||||||||||
// Copyright The OpenTelemetry Authors | ||||||||||
// SPDX-License-Identifier: Apache-2.0 | ||||||||||
|
||||||||||
package elasticsearchexporter // import "github.com/open-telemetry/opentelemetry-collector-contrib/exporter/elasticsearchexporter" | ||||||||||
|
||||||||||
import ( | ||||||||||
"fmt" | ||||||||||
|
||||||||||
"go.opentelemetry.io/collector/pdata/pcommon" | ||||||||||
"go.opentelemetry.io/collector/pdata/plog" | ||||||||||
"go.opentelemetry.io/collector/pdata/pmetric" | ||||||||||
"go.opentelemetry.io/collector/pdata/ptrace" | ||||||||||
) | ||||||||||
|
||||||||||
// routeLogRecord returns the name of the index to send the log record to according to data stream routing attributes. | ||||||||||
// It searches for the routing attributes on the log record, scope, and resource. | ||||||||||
// It creates missing routing attributes on the log record if they are not found. | ||||||||||
func routeLogRecord( | ||||||||||
record *plog.LogRecord, | ||||||||||
scope pcommon.InstrumentationScope, | ||||||||||
resource pcommon.Resource, | ||||||||||
) string { | ||||||||||
dataSet := ensureAttribute(dataStreamDataset, defaultDataStreamDataset, record.Attributes(), scope.Attributes(), resource.Attributes()) | ||||||||||
namespace := ensureAttribute(dataStreamNamespace, defaultDataStreamNamespace, record.Attributes(), scope.Attributes(), resource.Attributes()) | ||||||||||
dataType := ensureAttribute(dataStreamType, defaultDataStreamTypeLogs, record.Attributes(), scope.Attributes(), resource.Attributes()) | ||||||||||
return fmt.Sprintf("%s-%s-%s", dataType, dataSet, namespace) | ||||||||||
Comment on lines
+25
to
+26
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Not blocking this PR but the type should be fixed based on the record type. Similar story for metrics and spans.
Suggested change
|
||||||||||
} | ||||||||||
|
||||||||||
// routeDataPoint returns the name of the index to send the data point to according to data stream routing attributes. | ||||||||||
// It searches for the routing attributes on the data point, scope, and resource. | ||||||||||
// It creates missing routing attributes on the data point if they are not found. | ||||||||||
func routeDataPoint( | ||||||||||
dataPoint pmetric.NumberDataPoint, | ||||||||||
scope pcommon.InstrumentationScope, | ||||||||||
resource pcommon.Resource, | ||||||||||
) string { | ||||||||||
dataSet := ensureAttribute(dataStreamDataset, defaultDataStreamDataset, dataPoint.Attributes(), scope.Attributes(), resource.Attributes()) | ||||||||||
namespace := ensureAttribute(dataStreamNamespace, defaultDataStreamNamespace, dataPoint.Attributes(), scope.Attributes(), resource.Attributes()) | ||||||||||
dataType := ensureAttribute(dataStreamType, defaultDataStreamTypeMetrics, dataPoint.Attributes(), scope.Attributes(), resource.Attributes()) | ||||||||||
return fmt.Sprintf("%s-%s-%s", dataType, dataSet, namespace) | ||||||||||
} | ||||||||||
|
||||||||||
// routeSpan returns the name of the index to send the span to according to data stream routing attributes. | ||||||||||
// It searches for the routing attributes on the span, scope, and resource. | ||||||||||
// It creates missing routing attributes on the span if they are not found. | ||||||||||
func routeSpan( | ||||||||||
span ptrace.Span, | ||||||||||
scope pcommon.InstrumentationScope, | ||||||||||
resource pcommon.Resource, | ||||||||||
) string { | ||||||||||
dataSet := ensureAttribute(dataStreamDataset, defaultDataStreamDataset, span.Attributes(), scope.Attributes(), resource.Attributes()) | ||||||||||
namespace := ensureAttribute(dataStreamNamespace, defaultDataStreamNamespace, span.Attributes(), scope.Attributes(), resource.Attributes()) | ||||||||||
dataType := ensureAttribute(dataStreamType, defaultDataStreamTypeTraces, span.Attributes(), scope.Attributes(), resource.Attributes()) | ||||||||||
return fmt.Sprintf("%s-%s-%s", dataType, dataSet, namespace) | ||||||||||
} | ||||||||||
|
||||||||||
func ensureAttribute(attributeName string, defaultValue string, recordAttributes, scopeAttributes, resourceAttributes pcommon.Map) string { | ||||||||||
// Try to retrieve the attribute value from an existing attribute. | ||||||||||
value := getFromAttributesNew(attributeName, "", recordAttributes, scopeAttributes, resourceAttributes) | ||||||||||
|
||||||||||
// If the value is not found, set the default value on the record. | ||||||||||
if value == "" { | ||||||||||
value = defaultValue | ||||||||||
recordAttributes.PutStr(attributeName, value) | ||||||||||
} | ||||||||||
return value | ||||||||||
} |
Oops, something went wrong.
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.
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.
metrics prefix_suffix precedence is different to logs and traces. Is this deliberate?
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.
I see that you've created #33725 but the question remains: is it worth it to have this exception / inconsistency for metrics prefix_suffix mode? Otherwise, does it make sense to break all of them at once when a decision is made in #33725 ?
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.
Yes, I created #33725 because I think the current setting for prefix_suffix should be changed.
When introducing metrics, my thinking was to introduce the
prefix_suffix
mode for metrics using the correct precedence, to prevent a breaking change at least in metrics behavior.I do see value in having those consistent between signals though. If you think we should rather keep
prefix_suffix
mode precedence consistent with other signals, I can change that.