prometheus_exporter.h

/* Copyright 2018 Google Inc. All Rights Reserved.
 
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 TENSORFLOW_SERVING_UTIL_PROMETHEUS_EXPORTER_H_
#define TENSORFLOW_SERVING_UTIL_PROMETHEUS_EXPORTER_H_
 
#include <vector>
 
#include "tensorflow/core/lib/core/status.h"
#include "tensorflow/core/lib/monitoring/collected_metrics.h"
#include "tensorflow/core/lib/monitoring/collection_registry.h"
 
namespace tensorflow {
namespace serving {
 
// Exports metrics in Prometheus monitoring format.
class PrometheusExporter {
 public:
  // Default path to expose the metrics.
  static const char* const kPrometheusPath;
 
  PrometheusExporter();
 
  // Generates text page in Prometheus format:
  // https://prometheus.io/docs/instrumenting/exposition_formats/#text-format-example
  // If an error status returned, http_page is unchanged.
  Status GeneratePage(string* http_page);
 
 private:
  // The metrics registry.
  monitoring::CollectionRegistry* collection_registry_;
};
 
}  // namespace serving
}  // namespace tensorflow
 
#endif  // TENSORFLOW_SERVING_UTIL_PROMETHEUS_EXPORTER_H_