zecfoundation
/
metrics
mirror of https://github.com/ZcashFoundation/metrics.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

metrics-exporter-prometheus: drop feature gate on build, rename other build to build_with_exporter, and fix doc comments

This commit is contained in:
kilpatty 2020-11-02 07:20:55 -06:00
parent 6e61eb493b
commit 274ca273c4
No known key found for this signature in database
GPG Key ID: 2346BDEEAEF0F2D3
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
metrics-exporter-prometheus/src/lib.rs
View File

@ -334,7 +334,7 @@ pub struct PrometheusRecorder {
}
impl PrometheusRecorder {
///Returns a [`PrometheusHandle`] from the inner struct of this recorder.
/// Gets a [`PrometheusHandle`] to this recorder.
pub fn handle(&self) -> PrometheusHandle {
PrometheusHandle {
inner: self.inner.clone(),
@ -351,7 +351,9 @@ impl PrometheusRecorder {
}
}
/// A wrapper around the Inner struct of the Prometheus recorder.
/// Handle to [`PrometheusRecorder`].
///
/// Useful for exposing a scrape endpoint on an existing HTTP/HTTPS server.
pub struct PrometheusHandle {
inner: Arc<Inner>,
}
@ -465,7 +467,6 @@ impl PrometheusBuilder {
/// Builds the recorder and returns it.
/// This function is only enabled when default features are not set.
#[cfg(not(feature = "tokio-exporter"))]
pub fn build(self) -> Result<PrometheusRecorder, Error> {
let inner = Arc::new(Inner {
registry: Registry::new(),
@ -488,7 +489,7 @@ impl PrometheusBuilder {
/// recorders, or needs to schedule the exporter to run in a particular way, this method
/// provides the flexibility to do so.
#[cfg(feature = "tokio-exporter")]
pub fn build(
pub fn build_with_exporter(
self,
) -> Result<
(