-
Notifications
You must be signed in to change notification settings - Fork 5.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Expose REST API to fetch runtime metrics in prometheus format
Co-authored-by:jaystarshot <jay.narale@uber.com>
- Loading branch information
1 parent
62d9641
commit 22c1820
Showing
13 changed files
with
536 additions
and
7 deletions.
There are no files selected for viewing
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
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
9 changes: 9 additions & 0 deletions
9
presto-native-execution/presto_cpp/main/common/prometheus-metrics/CMakeLists.txt
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,9 @@ | ||
| find_package(prometheus-cpp CONFIG REQUIRED) | ||
|
|
||
| add_library(prometheus_reporter PrometheusReporter.h PrometheusReporter.cpp) | ||
|
|
||
| target_link_libraries(prometheus_reporter presto_common prometheus-cpp::core) | ||
|
|
||
| set_property(TARGET prometheus_reporter PROPERTY JOB_POOL_LINK | ||
| presto_link_job_pool) | ||
| add_subdirectory(tests) |
171 changes: 171 additions & 0 deletions
171
presto-native-execution/presto_cpp/main/common/prometheus-metrics/PrometheusReporter.cpp
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,171 @@ | ||
| /* | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| #include "presto_cpp/main/common/prometheus-metrics/PrometheusReporter.h" | ||
| namespace facebook::presto::prometheus { | ||
|
|
||
| using namespace ::prometheus; | ||
|
|
||
| void PrometheusReporter::registerMetricExportType( | ||
| const char* key, | ||
| facebook::velox::StatType statType) const { | ||
| if (registeredMetrics_.count(key)) { | ||
| // Already registered; | ||
| VLOG(1) << "Trying to register already registered metric " << key; | ||
| return; | ||
| } | ||
| // Prometheus format requires '.' to be replaced. | ||
| std::string displayKey = std::string(key); | ||
| std::replace(displayKey.begin(), displayKey.end(), '.', '_'); | ||
| switch (statType) { | ||
| case facebook::velox::StatType::COUNT: { | ||
| auto& counterFamily = | ||
| BuildCounter().Name(displayKey).Register(*registry_); | ||
| auto& counter = counterFamily.Add(labels_); | ||
| countersMap_.wlock()->emplace(std::string(key), counter); | ||
| break; | ||
| } | ||
| case facebook::velox::StatType::SUM: | ||
| case facebook::velox::StatType::AVG: | ||
| case facebook::velox::StatType::RATE: { | ||
| auto& gaugeFamily = BuildGauge().Name(displayKey).Register(*registry_); | ||
| auto& gauge = gaugeFamily.Add(labels_); | ||
| gaugeMap_.wlock()->emplace(std::string(key), gauge); | ||
| break; | ||
| } | ||
| default: | ||
| VELOX_UNSUPPORTED( | ||
| "Unsupported metric type {}", std::to_string((int)statType)); | ||
| } | ||
| registeredMetrics_.emplace(key, statType); | ||
| } | ||
|
|
||
| void PrometheusReporter::registerMetricExportType( | ||
| folly::StringPiece key, | ||
| facebook::velox::StatType statType) const { | ||
| registerMetricExportType(key.start(), statType); | ||
| } | ||
|
|
||
| void PrometheusReporter::registerHistogramMetricExportType( | ||
| const char* key, | ||
| int64_t bucketWidth, | ||
| int64_t min, | ||
| int64_t max, | ||
| const std::vector<int32_t>& pcts) const { | ||
| if (registeredHistogramMetrics_.count(key)) { | ||
| // Already registered; | ||
| VLOG(1) << "Trying to register already registered metric " << key; | ||
| return; | ||
| } | ||
| int numBuckets = (max - min) / bucketWidth; | ||
| auto bound = min + bucketWidth; | ||
| std::string keyStr = std::string(key); | ||
| std::replace(keyStr.begin(), keyStr.end(), '.', '_'); | ||
|
|
||
| auto& histogramFamily = BuildHistogram().Name(keyStr).Register(*registry_); | ||
| Histogram::BucketBoundaries bucketBoundaries; | ||
| while (numBuckets) { | ||
| bucketBoundaries.push_back(bound); | ||
| bound += bucketWidth; | ||
| numBuckets--; | ||
| } | ||
| VELOX_CHECK_GE(bucketBoundaries.size(), 1); | ||
| auto& histogramMetric = histogramFamily.Add(labels_, bucketBoundaries); | ||
| histogramMap_.wlock()->emplace(key, histogramMetric); | ||
| // If percentiles are provided, create a Summary type metric and register. | ||
| if (pcts.size() > 0) { | ||
| auto& summaryFamily = | ||
| BuildSummary().Name(keyStr.append(kSummarySuffix)).Register(*registry_); | ||
| Summary::Quantiles quantiles; | ||
| for (auto pct : pcts) { | ||
| quantiles.push_back( | ||
| detail::CKMSQuantiles::Quantile(pct / (double)100, 0)); | ||
| } | ||
| auto& summaryMetric = summaryFamily.Add({labels_}, quantiles); | ||
| summaryMap_.wlock()->emplace(std::string(key), summaryMetric); | ||
| } | ||
| registeredHistogramMetrics_.insert(key); | ||
| } | ||
|
|
||
| void PrometheusReporter::registerHistogramMetricExportType( | ||
| folly::StringPiece key, | ||
| int64_t bucketWidth, | ||
| int64_t min, | ||
| int64_t max, | ||
| const std::vector<int32_t>& pcts) const { | ||
| registerHistogramMetricExportType(key.begin(), bucketWidth, min, max, pcts); | ||
| } | ||
|
|
||
| void PrometheusReporter::addMetricValue(const std::string& key, size_t value) | ||
| const { | ||
| addMetricValue(key.c_str(), value); | ||
| } | ||
|
|
||
| void PrometheusReporter::addMetricValue(const char* key, size_t value) const { | ||
| if (!registeredMetrics_.count(key)) { | ||
| VLOG(1) << "addMetricValue for unregistred metric " << key; | ||
| return; | ||
| } | ||
| auto statType = registeredMetrics_.find(key)->second; | ||
| switch (statType) { | ||
| case velox::StatType::COUNT: | ||
| countersMap_.wlock()->find(key)->second.Increment(value); | ||
| break; | ||
| case velox::StatType::SUM: | ||
| case velox::StatType::AVG: | ||
| case velox::StatType::RATE: | ||
| // Overrides the existing state. | ||
| gaugeMap_.wlock()->find(key)->second.Set(value); | ||
| break; | ||
| }; | ||
| } | ||
|
|
||
| void PrometheusReporter::addMetricValue(folly::StringPiece key, size_t value) | ||
| const { | ||
| addMetricValue(key.begin(), value); | ||
| } | ||
|
|
||
| void PrometheusReporter::addHistogramMetricValue( | ||
| const std::string& key, | ||
| size_t value) const { | ||
| addHistogramMetricValue(key.c_str(), value); | ||
| } | ||
|
|
||
| void PrometheusReporter::addHistogramMetricValue(const char* key, size_t value) | ||
| const { | ||
| if (!registeredHistogramMetrics_.count(key)) { | ||
| VLOG(1) << "addMetricValue for unregistered metric " << key; | ||
| return; | ||
| } | ||
| histogramMap_.wlock()->find(key)->second.Observe(value); | ||
| if (summaryMap_.rlock()->count(key)) { | ||
| summaryMap_.wlock()->find(key)->second.Observe(value); | ||
| } | ||
| } | ||
|
|
||
| void PrometheusReporter::addHistogramMetricValue( | ||
| folly::StringPiece key, | ||
| size_t value) const { | ||
| addHistogramMetricValue(key.begin(), value); | ||
| } | ||
|
|
||
| std::string PrometheusReporter::getSerializedMetrics() const { | ||
| if (registeredMetrics_.empty() && registeredHistogramMetrics_.empty()) { | ||
| return ""; | ||
| } | ||
| TextSerializer serializer; | ||
| // Registry::Collect() acquires lock on a mutex. | ||
| return serializer.Serialize(registry_->Collect()); | ||
| } | ||
| }; // namespace facebook::presto::prometheus |
Oops, something went wrong.