Make metrics optional #767
Merged
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
WalkthroughThe changes introduce optional handling for the metrics exporter URL and metric reader initialization. Now, metrics are only enabled if both the metrics flag and exporter URL are present. Related method signatures are updated to return Option/Optional types, ensuring safe initialization and preventing errors if the exporter URL is missing. Changes
Sequence Diagram(s)sequenceDiagram
participant Launcher
participant OtelMetricsReporter
participant Metrics
participant OpenTelemetry
Launcher->>OtelMetricsReporter: getExporterUrl()
OtelMetricsReporter-->>Launcher: Option[String]
alt Exporter URL defined
Launcher->>Metrics: Initialize metrics (enabled, url present)
Metrics->>OtelMetricsReporter: buildOtelMetricReader()
OtelMetricsReporter-->>Metrics: Option[MetricReader]
alt MetricReader present
Metrics->>OpenTelemetry: build client with reader
else MetricReader absent
Metrics->>OpenTelemetry: use no-op client
end
else Exporter URL missing
Launcher->>Metrics: Skip metrics initialization
end
Poem
Tip ⚡️ Faster reviews with caching
Enjoy the performance boost—your workflow just got faster. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
piyush-zlai
requested review from
varant-zlai,
chewy-zlai,
tchow-zlai and
david-zlai
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
online/src/main/scala/ai/chronon/online/metrics/OtelMetricsReporter.scala (1)
115-117: Consider returning None for unknown metrics readers.Instead of throwing an exception, consider returning None for unknown metrics readers to maintain consistency with the optional approach.
case _ => - throw new IllegalArgumentException(s"Unknown metrics reader (only http / prometheus supported): $metricReader") + None
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro (Legacy)
📒 Files selected for processing (3)
online/src/main/scala/ai/chronon/online/metrics/Metrics.scala(1 hunks)online/src/main/scala/ai/chronon/online/metrics/OtelMetricsReporter.scala(1 hunks)service_commons/src/main/java/ai/chronon/service/ChrononServiceLauncher.java(1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (2)
service_commons/src/main/java/ai/chronon/service/ChrononServiceLauncher.java (1)
online/src/main/scala/ai/chronon/online/metrics/OtelMetricsReporter.scala (3)
OtelMetricsReporter(19-79)OtelMetricsReporter(81-149)getExporterUrl(93-95)
online/src/main/scala/ai/chronon/online/metrics/OtelMetricsReporter.scala (1)
api/src/main/java/ai/chronon/api/thrift/Option.java (2)
Option(25-143)Some(93-111)
⏰ Context from checks skipped due to timeout of 90000ms (16)
- GitHub Check: service_tests
- GitHub Check: service_tests
- GitHub Check: service_commons_tests
- GitHub Check: online_tests
- GitHub Check: cloud_aws_tests
- GitHub Check: cloud_gcp_tests
- GitHub Check: cloud_gcp_tests
- GitHub Check: cloud_aws_tests
- GitHub Check: api_tests
- GitHub Check: api_tests
- GitHub Check: flink_tests
- GitHub Check: aggregator_tests
- GitHub Check: aggregator_tests
- GitHub Check: flink_tests
- GitHub Check: scala_compile_fmt_fix
- GitHub Check: online_tests
🔇 Additional comments (8)
service_commons/src/main/java/ai/chronon/service/ChrononServiceLauncher.java (3)
30-30: LGTM: Added URL existence check.This check properly verifies if the metrics exporter URL is defined.
32-32: Metrics initialization now only occurs when both conditions are met.The code now ensures metrics are only initialized when both enabled and URL is defined, making metrics truly optional.
39-39: Safe URL access with.get().Since we only enter this code when URL is defined, using
.get()is safe here.online/src/main/scala/ai/chronon/online/metrics/Metrics.scala (1)
138-143: LGTM: Safe handling of optional metric reader.The code now gracefully handles potentially undefined metric readers by mapping over the Option and defaulting to a no-op client when needed.
online/src/main/scala/ai/chronon/online/metrics/OtelMetricsReporter.scala (4)
93-95: LGTM: Properly returns Optional value.Method now correctly returns an Option to represent the potentially missing exporter URL.
97-97: Updated return type to Optional.Return type now matches the optional nature of the metric reader.
101-106: LGTM: Properly maps over Optional URL.Using map here ensures the metric exporter is only created when URL exists.
111-114: Wrapped Prometheus server in Some.Ensures consistent Option return type when using Prometheus.
david-zlai
approved these changes
May 12, 2025
tchow-zlai
approved these changes
May 12, 2025
chewy-zlai
pushed a commit
that referenced
this pull request
May 15, 2025
## Summary Pulling out from PR - #751 as we're waiting on an r there and it shows up as noise in various places so lets just fix. ## Checklist - [ ] Added Unit Tests - [ ] Covered by existing CI - [ ] Integration tested - [ ] Documentation update <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Bug Fixes** - Improved handling of metrics exporter URL configuration to prevent errors when the URL is not defined. - Ensured metrics are only initialized when both metrics are enabled and an exporter URL is present. - **Refactor** - Enhanced internal logic for safer initialization of metrics reporting, reducing the risk of misconfiguration. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
chewy-zlai
pushed a commit
that referenced
this pull request
May 15, 2025
## Summary Pulling out from PR - #751 as we're waiting on an r there and it shows up as noise in various places so lets just fix. ## Checklist - [ ] Added Unit Tests - [ ] Covered by existing CI - [ ] Integration tested - [ ] Documentation update <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Bug Fixes** - Improved handling of metrics exporter URL configuration to prevent errors when the URL is not defined. - Ensured metrics are only initialized when both metrics are enabled and an exporter URL is present. - **Refactor** - Enhanced internal logic for safer initialization of metrics reporting, reducing the risk of misconfiguration. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
chewy-zlai
pushed a commit
that referenced
this pull request
May 16, 2025
## Summary Pulling out from PR - #751 as we're waiting on an r there and it shows up as noise in various places so lets just fix. ## Cheour clientslist - [ ] Added Unit Tests - [ ] Covered by existing CI - [ ] Integration tested - [ ] Documentation update <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Bug Fixes** - Improved handling of metrics exporter URL configuration to prevent errors when the URL is not defined. - Ensured metrics are only initialized when both metrics are enabled and an exporter URL is present. - **Refactor** - Enhanced internal logic for safer initialization of metrics reporting, reducing the risk of misconfiguration. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Pulling out from PR - #751 as we're waiting on an r there and it shows up as noise in various places so lets just fix.
Checklist
Summary by CodeRabbit
Bug Fixes
Refactor