metrics_cloudwatch

KO | EN

gitlite — search

#python #rust #linux #docker #nodejs #macos #java #cli #kubernetes #vue #awesome-list #ios #openai #open-source

metrics_cloudwatch

(★ 11)

CloudWatch emitter for the metrics crate

metrics_cloudwatch 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

metrics_cloudwatch
==================
[![crates.io](https://meritbadge.herokuapp.com/metrics_cloudwatch)](https://crates.io/crates/metrics_cloudwatch)
[![Docs](https://docs.rs/metrics_cloudwatch/badge.svg)](https://docs.rs/metrics_cloudwatch)
![Build status](https://github.com/ramn/metrics_cloudwatch/workflows/build/badge.svg)

Purpose
-------

Provide a backend for the [`metrics` facade
crate](https://crates.io/crates/metrics), pushing metrics to CloudWatch.

How to use
----------

Credentials for AWS needs to be available in the environment, see [AWS docs
on setting up AWS credentials](
https://github.com/awslabs/aws-sdk-rust#getting-started-with-the-sdk)

```bash
cargo add -s metrics metrics_cloudwatch
```

```rust

use futures_util::FutureExt;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let sdk_config = aws_config::defaults(aws_config::BehaviorVersion::latest())
        .load()
        .await;
    let client = aws_sdk_cloudwatch::Client::new(&sdk_config);

let (shutdown_sender, receiver) = tokio::sync::oneshot::channel::<()>();

// Initialize the backend
    let driver = metrics_cloudwatch::Builder::new()
        .shutdown_signal(receiver.map(|_| ()).boxed())
        .cloudwatch_namespace("my-namespace")
        .init_async(client, metrics::set_global_recorder)
        .await?;

// `metrics_cloudwatch` uses a background task to buffer and send metrics to CloudWatch
    let metrics_task = tokio::spawn(driver);

// Run your application, emitting metrics as needed
    metrics::counter!("requests").increment(1);

// Signal `metrics_task` to shutdown
    drop(shutdown_sender);

// Wait for `metrics_task` to flush all buffered metrics before shutting down
    metrics_task.await?;

Ok(())
}
```

Any labels specified will map to Cloudwatch dimensions

```rust
metrics::histogram!("histogram", "dimension_name" => "dimension_value").record(100.0);
```

Specifying the empty string for the value will remove the default dimension of the same name from the metric.

```rust
metrics::histogram!("histogram", "dimension_name" => "").record(100.0);
```

The special `@unit` label accepts a `metrics_cloudwatch::Unit` which specifies the unit for the metric (the unit can also be specified when registering the metric). Other `@` prefixed labels are ignored.

```rust
metrics::histogram!("histogram", "@unit" => metrics_cloudwatch::Unit::Seconds).record(100.0);
```

Limitations
-----------

The CloudWatch metrics API imposes some limitations.

* Max 30 labels (dimensions) per metric
* Max 150 unique histogram values (used by `timing!()` and `value!()`) per API
call. Going beyond this works but will incur one API call per batch of 150
unique values. Could be a good idea to measure timing in milliseconds rather
than nanoseconds, to keep down the number of unique values.

metrics_cloudwatch

metrics_cloudwatch 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

metrics_cloudwatch

metrics_cloudwatch 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README