OpenTelemetry Google Cloud Monitoring Exporter

This library provides support for exporting metrics to Google Cloud Monitoring.

For resource detection see opentelemetry-resourcedetector-gcp-rust.

GCP Permissions

Role: Monitoring Metric Writer (roles/monitoring.metricWriter) or permissions: monitoring.metricDescriptors.create, monitoring.timeSeries.create

Support OpenTelemetry SDK versions

opentelemetry_sdk:0.31 | opentelemetry_gcloud_monitoring_exporter:0.22
opentelemetry_sdk:0.31 | opentelemetry_gcloud_monitoring_exporter:0.19.1
opentelemetry_sdk:0.30 | opentelemetry_gcloud_monitoring_exporter:0.18
opentelemetry_sdk:0.29 | opentelemetry_gcloud_monitoring_exporter:0.16
opentelemetry_sdk:0.28 | opentelemetry_gcloud_monitoring_exporter:0.15
opentelemetry_sdk:0.21-27 | opentelemetry_gcloud_monitoring_exporter:0.14

Installation

cargo add opentelemetry_gcloud_monitoring_exporter - exporter

cargo add opentelemetry_resourcedetector_gcp_rust - gcp resource detection

or add to cargo.toml

[dependencies]
opentelemetry_gcloud_monitoring_exporter = { path = "../..", features = [
    "tokio",
] }
tokio = { version = "1.0", features = ["full"] }
opentelemetry = { version = "0.31", features = ["metrics"] }
opentelemetry_sdk = { version = "0.31", features = [
    "metrics",
    "rt-tokio",
    "experimental_metrics_periodicreader_with_async_runtime",
] }
opentelemetry_resourcedetector_gcp_rust = "0.20.0"

Usage

use opentelemetry::{metrics::MeterProvider as _, KeyValue};
use opentelemetry_gcloud_monitoring_exporter::{GCPMetricsExporter, GCPMetricsExporterConfig};
use opentelemetry_resourcedetector_gcp_rust::GoogleCloudResourceDetector;
use opentelemetry_sdk::{
    metrics::{periodic_reader_with_async_runtime, SdkMeterProvider},
    Resource,
};
use std::time::Duration;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut cfg = GCPMetricsExporterConfig::default();
    cfg.prefix = "custom.googleapis.com/test_service".to_string();
    let exporter = GCPMetricsExporter::init(cfg).await?;
        // https://github.com/open-telemetry/opentelemetry-rust/blob/main/opentelemetry-sdk/CHANGELOG.md#0310
    let reader =
        periodic_reader_with_async_runtime::PeriodicReader::builder(exporter, runtime::Tokio)
            .build();
    // let reader = PeriodicReader::builder(exporter).build();
    let gcp_detector = Box::new(GoogleCloudResourceDetector::new().await);
    // if we deploy to cloud run or vm instance in gcp we should specify namespace
    // if we don't have namespace we can specify it how 'default'
    let res = Resource::builder_empty()
        .with_attributes(vec![KeyValue::new("service.namespace", "default")])
        .with_detector(gcp_detector)
        .build();
    let meter_provider = SdkMeterProvider::builder()
        .with_resource(res)
        .with_reader(reader)
        .build();

    let meter = meter_provider.meter("user-event-test");

    let counter = meter
        .f64_counter("counter_f64_test")
        .with_description("test_decription")
        .with_unit("test_unit")
        .build();

    loop {
        // Record measurements using the Counter instrument.
        counter.add(
            1.0,
            &[
                KeyValue::new("mykey1", "myvalue1"),
                KeyValue::new("mykey2", "myvalue2"),
            ],
        );
        tokio::time::sleep(Duration::from_millis(300)).await;
    }
}

Customize metric resource in google monitoring

    let mut cfg = GCPMetricsExporterConfig::default();
    cfg.prefix = "custom.googleapis.com/test_service".to_string();

    // customize metric resource in google monitoring
    cfg.custom_monitored_resource_data = Some(
        // https://cloud.google.com/monitoring/api/resources#tag_global
        MonitoredResourceDataConfig {
            r#type: "global".to_string(),
            labels: HashMap::from([
                ("project_id".to_string(), "my-project".to_string()),
            ]),
        },
    );
    let exporter = GCPMetricsExporter::init(cfg).await?;
    let reader = PeriodicReader::builder(exporter).build();
    SdkMeterProvider::builder()
        .with_reader(reader)
        .build();

References

• Cloud Monitoring
• OpenTelemetry Project
• Google Cloud Rust
• Google Cloud Rust Crates

Test cases from this repo

opentelemetry-exporter-gcp-monitoring python version