https://github.com/prozz/aws-embedded-metrics-golang
Go implementation of AWS CloudWatch Embedded Metric Format
https://github.com/prozz/aws-embedded-metrics-golang
aws-cloudwatch aws-cloudwatch-logs aws-cloudwatch-metrics aws-lambda aws-lambda-golang golang-package
Last synced: 4 months ago
JSON representation
Go implementation of AWS CloudWatch Embedded Metric Format
- Host: GitHub
- URL: https://github.com/prozz/aws-embedded-metrics-golang
- Owner: prozz
- License: mit
- Created: 2020-06-08T21:02:53.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-08-10T09:27:17.000Z (almost 3 years ago)
- Last Synced: 2024-06-18T20:26:32.097Z (almost 2 years ago)
- Topics: aws-cloudwatch, aws-cloudwatch-logs, aws-cloudwatch-metrics, aws-lambda, aws-lambda-golang, golang-package
- Language: Go
- Size: 29.3 KB
- Stars: 56
- Watchers: 4
- Forks: 10
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# aws-embedded-metrics-golang
Go implementation of AWS CloudWatch [Embedded Metric Format](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Embedded_Metric_Format_Specification.html)
It's aim is to simplify reporting metrics to CloudWatch:
- using EMF avoids additional HTTP API calls to CloudWatch as metrics are logged in JSON format to stdout
- no need for additional dependencies in your services (or mocks in tests) to report metrics from inside your code
- built in support for default dimensions and properties for Lambda functions
Supports namespaces, setting dimensions and properties as well as different contexts (at least partially).
## Installation
```shell
go get github.com/prozz/aws-embedded-metrics-golang
```
## Usage
```
emf.New().Namespace("mtg").Metric("totalWins", 1500).Log()
emf.New().Dimension("colour", "red").
MetricAs("gameLength", 2, emf.Seconds).Log()
emf.New().DimensionSet(
emf.NewDimension("format", "edh"),
emf.NewDimension("commander", "Muldrotha")).
MetricAs("wins", 1499, emf.Count).Log()
```
You may also use the lib together with `defer`.
```
m := emf.New() // sets up whatever you fancy here
defer m.Log()
// any reporting metrics calls
```
Customizing the logger:
```
emf.New(
emf.WithWriter(os.Stderr), // Log to stderr.
emf.WithTimestamp(time.Now().Add(-time.Hour)), // Record past metrics.
emf.WithoutDimensions(), // Do not include useful Lambda related dimensions.
emf.WithLogGroup("my-logs") // Add specific log group.
)
```
Functions for reporting metrics:
```
func Metric(name string, value int)
func Metrics(m map[string]int)
func MetricAs(name string, value int, unit MetricUnit)
func MetricsAs(m map[string]int, unit MetricUnit)
func MetricFloat(name string, value float64)
func MetricsFloat(m map[string]float64)
func MetricFloatAs(name string, value float64, unit MetricUnit)
func MetricsFloatAs(m map[string]float64, unit MetricUnit)
```
Functions for setting up dimensions:
```
func Dimension(key, value string)
func DimensionSet(dimensions ...Dimension) // use `func NewDimension` for creating one
```
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests.
## License
[MIT](https://choosealicense.com/licenses/mit/)