OTLP: determine target data stream based on attributes and scope name #133903
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
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,141 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License | ||
| * 2.0; you may not use this file except in compliance with the Elastic License | ||
| * 2.0. | ||
| */ | ||
|
|
||
| package org.elasticsearch.xpack.oteldata.otlp.datapoint; | ||
|
|
||
| import io.opentelemetry.proto.common.v1.KeyValue; | ||
|
|
||
| import org.elasticsearch.cluster.metadata.DataStream; | ||
| import org.elasticsearch.core.Nullable; | ||
|
|
||
| import java.util.List; | ||
|
|
||
| /** | ||
| * Represents the target index for a data point, which can be either a specific index or a data stream. | ||
| * The index is determined based on attributes, scope name, and default values. | ||
| */ | ||
| public final class TargetIndex { | ||
|
|
||
| public static final String ELASTICSEARCH_INDEX = "elasticsearch.index"; | ||
| public static final String DATA_STREAM_DATASET = "data_stream.dataset"; | ||
| public static final String DATA_STREAM_NAMESPACE = "data_stream.namespace"; | ||
|
|
||
| private String index; | ||
| private String type; | ||
| private String dataset; | ||
| private String namespace; | ||
|
|
||
| /** | ||
| * Determines the target index for a data point. | ||
| * | ||
| * @param type The data stream type (e.g., "metrics", "logs"). | ||
| * @param attributes The attributes associated with the data point. | ||
| * @param receiverName The name of the receiver, which may influence the dataset (receiver-based routing). | ||
| * @param scopeAttributes Attributes associated with the scope. | ||
| * @param resourceAttributes Attributes associated with the resource. | ||
| * @return A TargetIndex instance representing the target index for the data point. | ||
| */ | ||
| public static TargetIndex route( | ||
felixbarny marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| String type, | ||
| List<KeyValue> attributes, | ||
| @Nullable String receiverName, | ||
| List<KeyValue> scopeAttributes, | ||
| List<KeyValue> resourceAttributes | ||
| ) { | ||
| // Order: | ||
| // 1. elasticsearch.index from attributes, scope.attributes, resource.attributes | ||
| // 2. read data_stream.* from attributes, scope.attributes, resource.attributes | ||
| // 3. receiver-based routing based on scope.name | ||
| // 4. use default hardcoded data_stream.* (<type>-generic-default) | ||
| TargetIndex target = new TargetIndex(); | ||
| target.populateFrom(attributes); | ||
| target.populateFrom(scopeAttributes); | ||
| target.populateFrom(resourceAttributes); | ||
| if (target.index == null) { | ||
| target.type = type; | ||
| if (target.dataset == null && receiverName != null) { | ||
| target.dataset = receiverName; | ||
| } | ||
| target.dataset = DataStream.sanitizeDataset(target.dataset); | ||
| if (target.dataset == null) { | ||
| target.dataset = "generic"; | ||
felixbarny marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| } | ||
| // add otel suffix to match OTel index template | ||
| target.dataset = target.dataset + ".otel"; | ||
| target.namespace = DataStream.sanitizeNamespace(target.namespace); | ||
|
|
||
| if (target.namespace == null) { | ||
| target.namespace = "default"; | ||
| } | ||
| target.index = target.type + "-" + target.dataset + "-" + target.namespace; | ||
| } | ||
| return target; | ||
| } | ||
|
|
||
| private void populateFrom(List<KeyValue> attributes) { | ||
| if (isPopulated()) { | ||
| return; | ||
| } | ||
| for (int i = 0, size = attributes.size(); i < size; i++) { | ||
|
There was a problem hiding this comment. I wonder if these should be ordered e.g. lexicographically, so that naming is deterministic in the presence of multiple matching attributes. There was a problem hiding this comment. Sorting may be pretty expensive. But I see what you mean. If both There was a problem hiding this comment. Wouldn't this still use the first match on There was a problem hiding this comment. I'm not sure I understand. The |
||
| KeyValue attr = attributes.get(i); | ||
| if (attr.getKey().equals(ELASTICSEARCH_INDEX)) { | ||
| index = attr.getValue().getStringValue(); | ||
felixbarny marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
| if (isPopulated() == false && dataset == null && attr.getKey().equals(DATA_STREAM_DATASET)) { | ||
| dataset = attr.getValue().getStringValue(); | ||
| } | ||
| if (isPopulated() == false && namespace == null && attr.getKey().equals(DATA_STREAM_NAMESPACE)) { | ||
| namespace = attr.getValue().getStringValue(); | ||
| } | ||
| if (isPopulated()) { | ||
| return; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private boolean isPopulated() { | ||
| return (dataset != null && namespace != null) || index != null; | ||
| } | ||
|
|
||
| public boolean isDataStream() { | ||
| return type != null && dataset != null && namespace != null; | ||
kkrik-es marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
|
|
||
| public String index() { | ||
| return index; | ||
| } | ||
|
|
||
| public String type() { | ||
| return type; | ||
| } | ||
|
|
||
| public String dataset() { | ||
| return dataset; | ||
| } | ||
|
|
||
| public String namespace() { | ||
| return namespace; | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| return index; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean equals(Object o) { | ||
| if (o == null || getClass() != o.getClass()) return false; | ||
|
|
||
| TargetIndex that = (TargetIndex) o; | ||
| return index.equals(that.index); | ||
| } | ||
|
|
||
| @Override | ||
| public int hashCode() { | ||
| return index.hashCode(); | ||
| } | ||
| } | ||
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
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.
Uh oh!
There was an error while loading. Please reload this page.