Add Prometheus Exporter #1031
+483
−25
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,112 @@ | ||
| /* | ||
|
There was a problem hiding this comment. Simplify the copyright header as below? // Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0 |
||
| * Copyright The OpenTelemetry Authors | ||
| * | ||
| * 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. | ||
| */ | ||
|
|
||
| #pragma once | ||
| #ifdef ENABLE_METRICS_PREVIEW | ||
| # include <memory> | ||
| # include <string> | ||
| # include <vector> | ||
|
|
||
| # include "opentelemetry/exporters/prometheus/prometheus_collector.h" | ||
| # include "opentelemetry/sdk/metrics/exporter.h" | ||
| # include "opentelemetry/sdk/metrics/record.h" | ||
| # include "opentelemetry/version.h" | ||
| # include "prometheus/exposer.h" | ||
|
|
||
| /** | ||
| * This class is an implementation of the MetricsExporter interface and | ||
| * exports Prometheus metrics data. Functions in this class should be | ||
| * called by the Controller in our data pipeline. | ||
| */ | ||
|
|
||
| OPENTELEMETRY_BEGIN_NAMESPACE | ||
| namespace sdkmetrics = opentelemetry::sdk::metrics; | ||
|
There was a problem hiding this comment. nit: not recommended to use the namespace alias in the header file, as it becomes part of public API. It's been used all over the code right now and #1008 should be fixing it. |
||
|
|
||
| namespace exporter | ||
| { | ||
| namespace prometheus | ||
| { | ||
| class PrometheusExporter : public sdkmetrics::MetricsExporter | ||
| { | ||
| public: | ||
| /** | ||
| * Constructor - binds an exposer and collector to the exporter | ||
| * @param address: an address for an exposer that exposes | ||
| * an HTTP endpoint for the exporter to connect to | ||
| */ | ||
| PrometheusExporter(std::string &address); | ||
|
|
||
| /** | ||
| * Exports a batch of Metric Records. | ||
| * @param records: a collection of records to export | ||
| * @return: returns a ReturnCode detailing a success, or type of failure | ||
| */ | ||
| sdk::common::ExportResult Export( | ||
| const std::vector<sdkmetrics::Record> &records) noexcept override; | ||
|
|
||
| /** | ||
| * Shuts down the exporter and does cleanup. | ||
| * Since Prometheus is a pull based interface, | ||
| * we cannot serve data remaining in the intermediate | ||
| * collection to to client an HTTP request being sent, | ||
| * so we flush the data. | ||
| */ | ||
| void Shutdown() noexcept; | ||
|
|
||
| /** | ||
| * @return: returns a shared_ptr to | ||
| * the PrometheusCollector instance | ||
| */ | ||
| std::shared_ptr<PrometheusCollector> &GetCollector(); | ||
|
|
||
| /** | ||
| * @return: Gets the shutdown status of the exporter | ||
| */ | ||
| bool IsShutdown() const; | ||
|
|
||
| private: | ||
| /** | ||
| * exporter shutdown status | ||
| */ | ||
| bool is_shutdown_; | ||
|
|
||
| /** | ||
| * Pointer to a | ||
| * PrometheusCollector instance | ||
| */ | ||
| std::shared_ptr<PrometheusCollector> collector_; | ||
|
|
||
| /** | ||
| * Pointer to an | ||
| * Exposer instance | ||
| */ | ||
| std::unique_ptr<::prometheus::Exposer> exposer_; | ||
|
|
||
| /** | ||
| * friend class for testing | ||
| */ | ||
| friend class PrometheusExporterTest; | ||
|
|
||
| /** | ||
| * PrometheusExporter constructor with no parameters | ||
| * Used for testing only | ||
| */ | ||
| PrometheusExporter(); | ||
| }; | ||
| } // namespace prometheus | ||
| } // namespace exporter | ||
| OPENTELEMETRY_END_NAMESPACE | ||
| #endif // ENABLE_METRICS_PREVIEW | ||
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.
This should be put into the above section for "Unreleased".
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.
done