Added IndexSpanAlias and IndexServiceAlias for explicit aliases #7550
Conversation
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
![graphite-app[bot]](https://avatars.githubusercontent.com/in/158384?s=60&v=4){kind=small}
Comment on lines
129
to
133
| if p.SpanAlias != "" || p.ServiceAlias != "" { | ||
| return func(_ time.Time) (string, string) { | ||
| return spanIndexPrefix, serviceIndexPrefix | ||
| } | ||
| } |
Contributor
There was a problem hiding this comment.
There's a logical issue in this conditional block. When either p.SpanAlias or p.ServiceAlias is set (but not both), the function will return both indices without date suffixes. This creates inconsistent behavior where an index without an explicit alias will lose its date suffix.
Consider refactoring to handle each index type independently:
return func(date time.Time) (string, string) {
spanIndex := spanIndexPrefix
serviceIndex := serviceIndexPrefix
// Only apply date suffix to indices without explicit aliases
if p.SpanAlias == "" {
spanIndex = indexWithDate(spanIndexPrefix, p.SpanIndex.DateLayout, date)
}
if p.ServiceAlias == "" {
serviceIndex = indexWithDate(serviceIndexPrefix, p.ServiceIndex.DateLayout, date)
}
return spanIndex, serviceIndex
}This ensures that date suffixes are only omitted for indices with explicit aliases configured.
Spotted by Graphite Agent
Is this helpful? React 👍 or 👎 to let us know.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #7550 +/- ##
==========================================
- Coverage 96.59% 96.58% -0.02%
==========================================
Files 384 384
Lines 19404 19431 +27
==========================================
+ Hits 18744 18767 +23
- Misses 477 480 +3
- Partials 183 184 +1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Metrics Comparison SummaryTotal changes across all snapshots: 53 Detailed changes per snapshotsummary_metrics_snapshot_cassandra📊 Metrics Diff SummaryTotal Changes: 53
🆕 Added Metrics
View diff sample+http_server_request_body_size_bytes{http_request_method="GET",http_response_status_code="503",le="+Inf",network_protocol_name="http",network_protocol_version="1.1",otel_scope_name="go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp",otel_scope_schema_url="",otel_scope_version="0.63.0",server_address="localhost",server_port="13133",url_scheme="http"}
+http_server_request_body_size_bytes{http_request_method="GET",http_response_status_code="503",le="0",network_protocol_name="http",network_protocol_version="1.1",otel_scope_name="go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp",otel_scope_schema_url="",otel_scope_version="0.63.0",server_address="localhost",server_port="13133",url_scheme="http"}
+http_server_request_body_size_bytes{http_request_method="GET",http_response_status_code="503",le="10",network_protocol_name="http",network_protocol_version="1.1",otel_scope_name="go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp",otel_scope_schema_url="",otel_scope_version="0.63.0",server_address="localhost",server_port="13133",url_scheme="http"}
+http_server_request_body_size_bytes{http_request_method="GET",http_response_status_code="503",le="100",network_protocol_name="http",network_protocol_version="1.1",otel_scope_name="go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp",otel_scope_schema_url="",otel_scope_version="0.63.0",server_address="localhost",server_port="13133",url_scheme="http"}
+http_server_request_body_size_bytes{http_request_method="GET",http_response_status_code="503",le="1000",network_protocol_name="http",network_protocol_version="1.1",otel_scope_name="go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp",otel_scope_schema_url="",otel_scope_version="0.63.0",server_address="localhost",server_port="13133",url_scheme="http"}
+http_server_request_body_size_bytes{http_request_method="GET",http_response_status_code="503",le="10000",network_protocol_name="http",network_protocol_version="1.1",otel_scope_name="go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp",otel_scope_schema_url="",otel_scope_version="0.63.0",server_address="localhost",server_port="13133",url_scheme="http"}
+http_server_request_body_size_bytes{http_request_method="GET",http_response_status_code="503",le="25",network_protocol_name="http",network_protocol_version="1.1",otel_scope_name="go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp",otel_scope_schema_url="",otel_scope_version="0.63.0",server_address="localhost",server_port="13133",url_scheme="http"}
...View diff sample+http_server_request_duration_seconds{http_request_method="GET",http_response_status_code="503",le="+Inf",network_protocol_name="http",network_protocol_version="1.1",otel_scope_name="go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp",otel_scope_schema_url="",otel_scope_version="0.63.0",server_address="localhost",server_port="13133",url_scheme="http"}
+http_server_request_duration_seconds{http_request_method="GET",http_response_status_code="503",le="0.005",network_protocol_name="http",network_protocol_version="1.1",otel_scope_name="go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp",otel_scope_schema_url="",otel_scope_version="0.63.0",server_address="localhost",server_port="13133",url_scheme="http"}
+http_server_request_duration_seconds{http_request_method="GET",http_response_status_code="503",le="0.01",network_protocol_name="http",network_protocol_version="1.1",otel_scope_name="go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp",otel_scope_schema_url="",otel_scope_version="0.63.0",server_address="localhost",server_port="13133",url_scheme="http"}
+http_server_request_duration_seconds{http_request_method="GET",http_response_status_code="503",le="0.025",network_protocol_name="http",network_protocol_version="1.1",otel_scope_name="go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp",otel_scope_schema_url="",otel_scope_version="0.63.0",server_address="localhost",server_port="13133",url_scheme="http"}
+http_server_request_duration_seconds{http_request_method="GET",http_response_status_code="503",le="0.05",network_protocol_name="http",network_protocol_version="1.1",otel_scope_name="go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp",otel_scope_schema_url="",otel_scope_version="0.63.0",server_address="localhost",server_port="13133",url_scheme="http"}
+http_server_request_duration_seconds{http_request_method="GET",http_response_status_code="503",le="0.075",network_protocol_name="http",network_protocol_version="1.1",otel_scope_name="go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp",otel_scope_schema_url="",otel_scope_version="0.63.0",server_address="localhost",server_port="13133",url_scheme="http"}
+http_server_request_duration_seconds{http_request_method="GET",http_response_status_code="503",le="0.1",network_protocol_name="http",network_protocol_version="1.1",otel_scope_name="go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp",otel_scope_schema_url="",otel_scope_version="0.63.0",server_address="localhost",server_port="13133",url_scheme="http"}
...View diff sample+http_server_response_body_size_bytes{http_request_method="GET",http_response_status_code="503",le="+Inf",network_protocol_name="http",network_protocol_version="1.1",otel_scope_name="go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp",otel_scope_schema_url="",otel_scope_version="0.63.0",server_address="localhost",server_port="13133",url_scheme="http"}
+http_server_response_body_size_bytes{http_request_method="GET",http_response_status_code="503",le="0",network_protocol_name="http",network_protocol_version="1.1",otel_scope_name="go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp",otel_scope_schema_url="",otel_scope_version="0.63.0",server_address="localhost",server_port="13133",url_scheme="http"}
+http_server_response_body_size_bytes{http_request_method="GET",http_response_status_code="503",le="10",network_protocol_name="http",network_protocol_version="1.1",otel_scope_name="go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp",otel_scope_schema_url="",otel_scope_version="0.63.0",server_address="localhost",server_port="13133",url_scheme="http"}
+http_server_response_body_size_bytes{http_request_method="GET",http_response_status_code="503",le="100",network_protocol_name="http",network_protocol_version="1.1",otel_scope_name="go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp",otel_scope_schema_url="",otel_scope_version="0.63.0",server_address="localhost",server_port="13133",url_scheme="http"}
+http_server_response_body_size_bytes{http_request_method="GET",http_response_status_code="503",le="1000",network_protocol_name="http",network_protocol_version="1.1",otel_scope_name="go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp",otel_scope_schema_url="",otel_scope_version="0.63.0",server_address="localhost",server_port="13133",url_scheme="http"}
+http_server_response_body_size_bytes{http_request_method="GET",http_response_status_code="503",le="10000",network_protocol_name="http",network_protocol_version="1.1",otel_scope_name="go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp",otel_scope_schema_url="",otel_scope_version="0.63.0",server_address="localhost",server_port="13133",url_scheme="http"}
+http_server_response_body_size_bytes{http_request_method="GET",http_response_status_code="503",le="25",network_protocol_name="http",network_protocol_version="1.1",otel_scope_name="go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp",otel_scope_schema_url="",otel_scope_version="0.63.0",server_address="localhost",server_port="13133",url_scheme="http"}
... |
Comment on lines
122
to
121
| if p.UseReadWriteAliases { | ||
| return func(_ time.Time) (string, string) { | ||
| return spanIndexPrefix + writeAlias, serviceIndexPrefix + writeAlias | ||
| } | ||
| } |
Contributor
There was a problem hiding this comment.
When both UseReadWriteAliases and explicit aliases are configured, the current implementation will append the write alias suffix to the explicit aliases. This behavior may be inconsistent with the purpose of explicit aliases, which are typically intended to be used exactly as provided.
Consider one of these approaches:
- Check for explicit aliases before checking
UseReadWriteAliasesto prioritize the explicit alias behavior - Add logic to handle the combination of both settings explicitly
- Document the current behavior in the configuration comments to clarify that explicit aliases will still receive the write suffix when
UseReadWriteAliasesis enabled
This would ensure the behavior is either consistent with user expectations or clearly documented.
Suggested change
| if p.UseReadWriteAliases { | |
| return func(_ time.Time) (string, string) { | |
| return spanIndexPrefix + writeAlias, serviceIndexPrefix + writeAlias | |
| } | |
| } | |
| if p.SpanIndexAlias != "" && p.ServiceIndexAlias != "" { | |
| return func(_ time.Time) (string, string) { | |
| return p.SpanIndexAlias, p.ServiceIndexAlias | |
| } | |
| } | |
| if p.UseReadWriteAliases { | |
| return func(_ time.Time) (string, string) { | |
| return spanIndexPrefix + writeAlias, serviceIndexPrefix + writeAlias | |
| } | |
| } |
Spotted by Graphite Agent
Is this helpful? React 👍 or 👎 to let us know.
Contributor
Author
|
Hii @yurishkuro, |
Contributor
Author
|
Hii @yurishkuro, |
Contributor
Author
|
Hii @yurishkuro , |
yurishkuro
reviewed
Oct 12, 2025
Signed-off-by: Somil Jain <[email protected]>
…ndices Signed-off-by: Somil Jain <[email protected]>
Signed-off-by: Somil Jain <[email protected]>
Signed-off-by: Somil Jain <[email protected]>
SomilJain0112
force-pushed
the
fix/Added-fields-for-explicit-alias
branch
from
bcc7b86 to
83eb73c
Compare
Contributor
Author
|
Hii @yurishkuro , |
Contributor
Author
|
Hii @yurishkuro , I have resolved comments. Please review here! |
yurishkuro
reviewed
Oct 19, 2025
| serviceIndexPrefix = p.ServiceIndexOverride | ||
| } | ||
|
|
||
| useAliasMode := p.UseReadWriteAliases || hasSpanOverride || hasServiceOverride |
Member
There was a problem hiding this comment.
Suggested change
| useAliasMode := p.UseReadWriteAliases || hasSpanOverride || hasServiceOverride | |
| useAliasMode := p.UseReadWriteAliases |
yurishkuro
reviewed
Oct 19, 2025
| useAliasMode := p.UseReadWriteAliases || hasSpanOverride || hasServiceOverride | ||
|
|
||
| maxSpanAge := p.MaxSpanAge | ||
| // Setting the maxSpanAge to a large duration will ensure all spans in the "read" alias are accessible by queries (query window = [now - maxSpanAge, now]). |
yurishkuro
reviewed
Oct 19, 2025
| } | ||
|
|
||
| var timeRangeFn TimeRangeIndexFn | ||
| if hasSpanOverride || hasServiceOverride { |
Member
There was a problem hiding this comment.
spaghetti. Keep all index logic in TimeRangeIndicesFn
yurishkuro
reviewed
Oct 19, 2025
Comment on lines
108
to
111
| hasSpanOverride := p.SpanIndexOverride != "" | ||
| if hasSpanOverride { | ||
| spanIndexPrefix = p.SpanIndexOverride | ||
| } |
Member
There was a problem hiding this comment.
why is this needed? There is a very simple function in L133 if p.UseReadWriteAliases { which covers the overrides condition and where overrides can be applied instead of composing index name from pieces
yurishkuro
reviewed
Oct 19, 2025
| // SpanIndexOverride allows full control over the name of the index alias. | ||
| // Overrides any index prefix / suffix settings. | ||
| // Can only be used with UseReadWriteAliases=true. | ||
| SpanIndexOverride string `mapstructure:"span_index_override"` |
Member
There was a problem hiding this comment.
how is this supposed to work with UseReadWriteAliases=true? When aliases are used the read and write indices are still different. So what does it mean to have a single SpanIndexOverride?
Member
There was a problem hiding this comment.
When set, it replaces the prefix but read/write suffixes are still appended.
doesn't that go against the requirement expressed by the user?
Signed-off-by: Somil Jain <[email protected]>
Contributor
Author
|
Hii @yurishkuro , |
Signed-off-by: Somil Jain <[email protected]>
Comment on lines
+748
to
+757
| hasSpanAliases := c.SpanReadAlias != "" || c.SpanWriteAlias != "" | ||
| hasServiceAliases := c.ServiceReadAlias != "" || c.ServiceWriteAlias != "" | ||
|
|
||
| if hasSpanAliases && (c.SpanReadAlias == "" || c.SpanWriteAlias == "") { | ||
| return errors.New("both span_read_alias and span_write_alias must be set together") | ||
| } | ||
|
|
||
| if hasServiceAliases && (c.ServiceReadAlias == "" || c.ServiceWriteAlias == "") { | ||
| return errors.New("both service_read_alias and service_write_alias must be set together") | ||
| } |
Contributor
There was a problem hiding this comment.
The validation logic enforces paired read/write aliases (for spans and services separately), but doesn't enforce consistency between span and service aliases. This creates a potential scenario where a user configures only span aliases without service aliases, or vice versa.
Consider enhancing the validation to either:
- Require all four aliases to be set when any are used, or
- Document the expected behavior when only span aliases or only service aliases are configured
The current implementation in reader.go handles this case by using explicit aliases when provided and falling back to prefix patterns, but this mixed approach should be clearly documented if it's the intended behavior.
Suggested change
| hasSpanAliases := c.SpanReadAlias != "" || c.SpanWriteAlias != "" | |
| hasServiceAliases := c.ServiceReadAlias != "" || c.ServiceWriteAlias != "" | |
| if hasSpanAliases && (c.SpanReadAlias == "" || c.SpanWriteAlias == "") { | |
| return errors.New("both span_read_alias and span_write_alias must be set together") | |
| } | |
| if hasServiceAliases && (c.ServiceReadAlias == "" || c.ServiceWriteAlias == "") { | |
| return errors.New("both service_read_alias and service_write_alias must be set together") | |
| } | |
| hasSpanAliases := c.SpanReadAlias != "" || c.SpanWriteAlias != "" | |
| hasServiceAliases := c.ServiceReadAlias != "" || c.ServiceWriteAlias != "" | |
| hasAnyAliases := hasSpanAliases || hasServiceAliases | |
| if hasSpanAliases && (c.SpanReadAlias == "" || c.SpanWriteAlias == "") { | |
| return errors.New("both span_read_alias and span_write_alias must be set together") | |
| } | |
| if hasServiceAliases && (c.ServiceReadAlias == "" || c.ServiceWriteAlias == "") { | |
| return errors.New("both service_read_alias and service_write_alias must be set together") | |
| } | |
| if hasAnyAliases && (!hasSpanAliases || !hasServiceAliases) { | |
| return errors.New("all aliases (span_read_alias, span_write_alias, service_read_alias, service_write_alias) must be set together") | |
| } | |
Spotted by Graphite Agent
Is this helpful? React 👍 or 👎 to let us know.
Contributor
Author
|
Hii @yurishkuro |
Contributor
Author
|
Hii @yurishkuro |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Which problem is this PR solving?
#7223
Description of the changes
a. Add IndexSpanAlias and IndexServiceAlias config fields
b. Use explicit aliases when provided instead of prefix pattern
How was this change tested?
Through local testing
Checklist
jaeger:make lint testjaeger-ui:npm run lintandnpm run test