This repository was archived by the owner on Aug 19, 2019. It is now read-only.
Add instrumentation and expose measurement in prometheus format #210
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
Submodule opencensus-cpp
added at
f44923
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 |
|---|---|---|
| @@ -1,4 +1,5 @@ | ||
| init-submodules | ||
| build-cpp-netlib | ||
| build-yaml-cpp | ||
| build-opencensus-cpp | ||
| metadatad |
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,77 @@ | ||
| /* | ||
| * Copyright 2018 Google Inc. | ||
| * | ||
| * 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 "metrics.h" | ||
|
|
||
| #include <opencensus/exporters/stats/prometheus/prometheus_exporter.h> | ||
| #include <opencensus/stats/stats.h> | ||
| #include <prometheus/text_serializer.h> | ||
|
|
||
| namespace google { | ||
|
|
||
| namespace { | ||
|
|
||
| constexpr const char kCount[] = "1"; | ||
StevenYCChou marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ::opencensus::stats::TagKey MethodTagKey() { | ||
| static const auto method_tag_key = | ||
| ::opencensus::stats::TagKey::Register("method"); | ||
| return method_tag_key; | ||
| } | ||
|
|
||
| } // namespace | ||
|
|
||
| const char Metrics::kGceApiRequestErrors[] = | ||
| "container.googleapis.com/internal/metadata_agent/gce_api_request_errors"; | ||
|
|
||
| void Metrics::RecordGceApiRequestErrors(int64_t value, | ||
| const std::string& method) { | ||
| ::opencensus::stats::Record( | ||
| {{GceApiRequestErrors(), value}}, | ||
| {{MethodTagKey(), method}}); | ||
| } | ||
|
|
||
| ::opencensus::stats::MeasureInt64 Metrics::GceApiRequestErrors() { | ||
| static const auto measure = Metrics::GceApiRequestErrorsInitialize(); | ||
| return measure; | ||
| } | ||
|
|
||
| ::opencensus::stats::MeasureInt64 Metrics::GceApiRequestErrorsInitialize() { | ||
| const auto measure = | ||
| ::opencensus::stats::MeasureInt64::Register( | ||
| kGceApiRequestErrors, | ||
| "Number of API request errors encountered.", | ||
| kCount); | ||
| Metrics::GceApiRequestErrorsCumulativeViewDescriptor().RegisterForExport(); | ||
| return measure; | ||
| } | ||
|
|
||
| const ::opencensus::stats::ViewDescriptor | ||
| Metrics::GceApiRequestErrorsCumulativeViewDescriptor() { | ||
| return ::opencensus::stats::ViewDescriptor() | ||
| .set_name(kGceApiRequestErrors) | ||
| .set_measure(kGceApiRequestErrors) | ||
| .set_aggregation(::opencensus::stats::Aggregation::Count()) | ||
| .set_description("The total number of HTTP request errors.") | ||
| .add_column(MethodTagKey()); | ||
| } | ||
|
|
||
| std::string Metrics::SerializeMetricsToPrometheusTextFormat() { | ||
| return ::prometheus::TextSerializer().Serialize( | ||
| ::opencensus::exporters::stats::PrometheusExporter().Collect()); | ||
| } | ||
|
|
||
| } // namespace google | ||
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,47 @@ | ||
| /* | ||
| * Copyright 2018 Google Inc. | ||
| * | ||
| * 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. | ||
| **/ | ||
|
|
||
| #ifndef METADATA_AGENT_METRICS_H_ | ||
| #define METADATA_AGENT_METRICS_H_ | ||
|
|
||
| #include <opencensus/stats/stats.h> | ||
| #include <string> | ||
|
|
||
| namespace google { | ||
|
|
||
| class Metrics { | ||
| public: | ||
| static const char kGceApiRequestErrors[]; | ||
|
|
||
| // Record an API request error on a method, e.g. oauth2 is one of the methods. | ||
| static void RecordGceApiRequestErrors(int64_t value, const std::string& method); | ||
|
|
||
| // Serialize all the available metrics as prometheus text format. | ||
| static std::string SerializeMetricsToPrometheusTextFormat(); | ||
|
|
||
| // View Descriptor accessors. If the view descriptor variable is not | ||
| // initialized, these methods will initialize the variable. | ||
| static const ::opencensus::stats::ViewDescriptor | ||
|
There was a problem hiding this comment. no. I tried to implement In order to create a view from the view descriptor, and run There was a problem hiding this comment. See my comment about There was a problem hiding this comment. Also note that the standard trick for accessing private functions in tests is to mark them |
||
| GceApiRequestErrorsCumulativeViewDescriptor(); | ||
|
|
||
| private: | ||
| static ::opencensus::stats::MeasureInt64 GceApiRequestErrorsInitialize(); | ||
| static ::opencensus::stats::MeasureInt64 GceApiRequestErrors(); | ||
| }; | ||
|
|
||
| } // namespace google | ||
|
|
||
| #endif /* METADATA_AGENT_METRICS_H_ */ | ||
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
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.
I'm always wary of targeting an untagged and unreleased commit. We can fix this later, but just wanted to note this as a concern.
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.
acknowledged. I just follow the pattern we used on other submodules. Once opencensus-cpp offically release their new version, we should check in that specific version. for now, I targeted on a commit which includes all the functionality we need, including prometheus-exporter.