Merge pull request #40 from frigus02/metrics

Metrics

Author: frigus02

CHANGELOG.md

@@ -7,6 +7,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+- Add support for metrics.
+- Take span resource into account for tags. Before a `service.name` in the resource would not populate the Cloud role name tag. Now it does.
+
 ## [0.17.0] - 2021-08-08
 
 - Upgrade to `v0.16.0` of `opentelemetry`.

Cargo.toml

@@ -18,15 +18,21 @@ exclude = [
     "README.tpl",
 ]
 
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+
 [features]
 reqwest-blocking-client = ["reqwest-client"]
 reqwest-blocking-client-rustls = ["reqwest-client-rustls"]
 reqwest-client = ["opentelemetry-http/reqwest", "reqwest/native-tls"]
 reqwest-client-rustls = ["opentelemetry-http/reqwest", "reqwest/rustls-tls"]
 surf-client = ["opentelemetry-http/surf"]
+metrics = ["opentelemetry/metrics", "ureq"]
 
 [dependencies]
 async-trait = "0.1"
+bytes = "1"
 chrono = "0.4"
 http = "0.2"
 once_cell = "1"
@@ -37,21 +43,20 @@ reqwest = { version = "0.11", default-features = false, features = ["blocking"],
 serde = { version = "1", features = ["derive"] }
 serde_json = "1"
 thiserror = "1"
+ureq = { version = "2", optional = true }
 
 [dev-dependencies]
 async-std = { version = "1.9.0", features = ["attributes"] }
 backtrace = "0.3.60"
 env_logger = "0.9.0"
 opentelemetry = { version = "0.16", features = ["rt-tokio"] }
 opentelemetry-application-insights = { path = ".", features = ["reqwest-client", "reqwest-blocking-client"] }
+rand = "0.8.4"
 surf = "2.2.0"
 test-case = "1.1.0"
 tokio = { version = "1.7.0", features = ["rt", "macros", "process", "time"] }
 version-sync = "0.9.2"
 
-[package.metadata.docs.rs]
-all-features = true
-
 [badges]
 github = { repository = "frigus02/opentelemetry-application-insights", workflow = "CI" }
 
@@ -71,6 +76,10 @@ required-features = ["reqwest-client"]
 name = "http_client_surf"
 required-features = ["surf-client", "opentelemetry/rt-async-std"]
 
+[[example]]
+name = "metrics"
+required-features = ["metrics"]
+
 [[example]]
 name = "opentelemetry"
 required-features = ["reqwest-client", "opentelemetry/rt-tokio"]

README.md

@@ -58,7 +58,7 @@ async fn main() {
 }
 ```
 
-### Features
+### Async runtimes and HTTP clients
 
 In order to support different async runtimes, the exporter requires you to specify an HTTP
 client that works with your chosen runtime. The [`opentelemetry-http`] crate comes with support
@@ -78,6 +78,46 @@ for:
 
 Alternatively you can bring any other HTTP client by implementing the `HttpClient` trait.
 
+### Metrics
+
+Please note: Metrics are still experimental both in the OpenTelemetry specification as well as
+Rust implementation.
+
+Please note: The metrics export configuration is still a bit rough in this crate. But once
+configured it should work as expected.
+
+This requires the **metrics** feature.
+
+```rust
+use opentelemetry::{global, sdk};
+use std::time::Duration;
+
+#[tokio::main]
+async fn main() {
+    // Setup exporter
+    let instrumentation_key = std::env::var("INSTRUMENTATION_KEY").unwrap();
+    let exporter = opentelemetry_application_insights::Exporter::new(instrumentation_key, ());
+    let controller = sdk::metrics::controllers::push(
+        sdk::metrics::selectors::simple::Selector::Exact,
+        sdk::export::metrics::ExportKindSelector::Stateless,
+        exporter,
+        tokio::spawn,
+        opentelemetry::util::tokio_interval_stream,
+    )
+    .with_period(Duration::from_secs(1))
+    .build();
+    global::set_meter_provider(controller.provider());
+
+    // Record value
+    let meter = global::meter("example");
+    let value_recorder = meter.f64_value_recorder("pi").init();
+    value_recorder.record(3.14, &[]);
+
+    // Give exporter some time to export values before exiting
+    tokio::time::sleep(Duration::from_secs(5)).await;
+}
+```
+
 ## Attribute mapping
 
 OpenTelemetry and Application Insights are using different terminology. This crate tries it's
@@ -154,6 +194,23 @@ All other attributes are directly converted to custom properties.
 
 [exceptions]: https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/semantic_conventions/exceptions.md
 
+### Metrics
+
+Metrics get reported to Application Insights as Metric Data. The [`Aggregator`] (chosen through
+the [`Selector`] passed to the controller) determines how the data is represented.
+
+| Aggregator     | Data representation                                       |
+| -------------- | --------------------------------------------------------- |
+| Array          | list of measurements                                      |
+| DDSketch       | aggregation with value, min, max and count                |
+| Histogram      | aggregation with sum and count (buckets are not exported) |
+| LastValue      | one measurement                                           |
+| MinMaxSumCount | aggregation with value, min, max and count                |
+| Sum            | aggregation with only a value                             |
+
+[`Aggregator`]: https://docs.rs/opentelemetry/0.16.0/opentelemetry/sdk/export/metrics/trait.Aggregator.html
+[`Selector`]: https://docs.rs/opentelemetry/0.16.0/opentelemetry/sdk/metrics/selectors/simple/enum.Selector.html
+
 ## Application Insights integration
 
 ### Thanks

examples/metrics.rs

@@ -0,0 +1,66 @@
+use opentelemetry::{
+    global,
+    metrics::{ObserverResult, Unit},
+    sdk::{self, metrics::controllers},
+    KeyValue,
+};
+use rand::{thread_rng, Rng};
+use std::{env, time::Duration};
+
+#[tokio::main]
+async fn main() {
+    env_logger::init();
+
+    let instrumentation_key =
+        env::var("INSTRUMENTATION_KEY").expect("env var INSTRUMENTATION_KEY should exist");
+
+    let exporter = opentelemetry_application_insights::Exporter::new(instrumentation_key, ());
+    let controller = controllers::push(
+        sdk::metrics::selectors::simple::Selector::Exact,
+        sdk::export::metrics::ExportKindSelector::Stateless,
+        exporter,
+        tokio::spawn,
+        opentelemetry::util::tokio_interval_stream,
+    )
+    .with_period(Duration::from_secs(1))
+    .build();
+
+    global::set_meter_provider(controller.provider());
+
+    let meter = global::meter("custom.instrumentation");
+
+    // Observer
+    let cpu_utilization_callback = |res: ObserverResult<f64>| {
+        let mut rng = thread_rng();
+        res.observe(
+            rng.gen_range(0.1..0.2),
+            &[KeyValue::new("state", "idle"), KeyValue::new("cpu", 0)],
+        )
+    };
+    let _ = meter
+        .f64_value_observer("system.cpu.utilization", cpu_utilization_callback)
+        .with_unit(Unit::new("1"))
+        .init();
+
+    // Recorder
+    let value_recorder = meter
+        .i64_value_recorder("http.server.duration")
+        .with_unit(Unit::new("milliseconds"))
+        .init();
+    let mut rng = thread_rng();
+    for _ in 1..5 {
+        value_recorder.record(
+            rng.gen_range(200..300),
+            &[
+                KeyValue::new("http.method", "GET"),
+                KeyValue::new("http.host", "10.1.2.4"),
+                KeyValue::new("http.scheme", "http"),
+                KeyValue::new("http.target", "/hello/world?name={}"),
+                KeyValue::new("http.status_code", "200"),
+            ],
+        );
+        tokio::time::sleep(Duration::from_millis(500)).await;
+    }
+
+    tokio::time::sleep(Duration::from_secs(3)).await;
+}

src/convert.rs

@@ -4,10 +4,7 @@ use opentelemetry::{
     sdk::{trace::EvictedHashMap, Resource},
     trace::{SpanId, TraceId},
 };
-use std::{
-    sync::Arc,
-    time::{Duration, SystemTime},
-};
+use std::time::{Duration, SystemTime};
 
 pub(crate) fn trace_id_to_string(trace_id: TraceId) -> String {
     format!("{:032x}", trace_id.to_u128())
@@ -36,7 +33,7 @@ pub(crate) fn time_to_string(time: SystemTime) -> String {
 
 pub(crate) fn attrs_to_properties(
     attributes: &EvictedHashMap,
-    resource: Option<Arc<Resource>>,
+    resource: Option<&Resource>,
 ) -> Option<Properties> {
     let properties_from_attrs = attributes
         .iter()