Medium Article about rebranding yace
YACE is currently in quick iteration mode. Things will probably break in upcoming versions. However, it has been in production use at InVision AG for a couple of months already.
Only latest version gets security updates. We won't support older versions.
In case of a vulnerability please directly contact us via mail - security@nerdswords.de
Do not disclose any specifics in github issues! - Thank you.
We will contact you as soon as possible.
Stop worrying about your AWS IDs - Auto discovery of resources via tags
Structured JSON logging
Filter monitored resources via regex
Automatic adding of tag labels to metrics
Automatic adding of dimension labels to metrics
Allows to export 0 even if CloudWatch returns nil
Allows exports metrics with CloudWatch timestamps (disabled by default)
Static metrics support for all cloudwatch metrics without auto discovery
Pull data from multiple AWS accounts using cross-account roles
Supported services with auto discovery through tags:
- acm (AWS/CertificateManager) - Certificate Manager
- alb (AWS/ApplicationELB) - Application Load Balancer
- apigateway (AWS/ApiGateway) - API Gateway
- appsync (AWS/AppSync) - AppSync
- athena (AWS/Athena) - Athena
- beanstalk (AWS/ElasticBeanstalk) - Elastic Beanstalk
- billing (AWS/Billing) - Billing
- cassandra (AWS/Cassandra) - Cassandra
- cloudfront (AWS/CloudFront) - Cloud Front
- cognito-idp (AWS/Cognito) - Cognito
- dms (AWS/DocDB) - Database Migration Service
- docdb (AWS/DocDB) - DocumentDB (with MongoDB compatibility)
- dynamodb (AWS/DynamoDB) - NoSQL Key-Value Database
- ebs (AWS/EBS) - Elastic Block Storage
- ec (AWS/Elasticache) - ElastiCache
- ec2 (AWS/EC2) - Elastic Compute Cloud
- ec2Spot (AWS/EC2Spot) - Elastic Compute Cloud for Spot Instances
- ecs-svc (AWS/ECS) - Elastic Container Service (Service Metrics)
- ecs-containerinsights (ECS/ContainerInsights) - ECS/ContainerInsights (Fargate metrics)
- efs (AWS/EFS) - Elastic File System
- elb (AWS/ELB) - Elastic Load Balancer
- emr (AWS/ElasticMapReduce) - Elastic MapReduce
- es (AWS/ES) - ElasticSearch
- fsx (AWS/FSx) - FSx File System
- gamelift (AWS/GameLift) - GameLift
- glue (Glue) - AWS Glue Jobs
- iot (AWS/IoT) - IoT
- kinesis (AWS/Kinesis) - Kinesis Data Stream
- nfw (AWS/NetworkFirewall) - Network Firewall
- ngw (AWS/NATGateway) - NAT Gateway
- lambda (AWS/Lambda) - Lambda Functions
- mq (AWS/AmazonMQ) - Managed Message Broker Service
- neptune (AWS/Neptune) - Neptune
- nlb (AWS/NetworkELB) - Network Load Balancer
- redshift (AWS/Redshift) - Redshift Database
- rds (AWS/RDS) - Relational Database Service
- r53r (AWS/Route53Resolver) - Route53 Resolver
- s3 (AWS/S3) - Object Storage
- ses (AWS/SES) - Simple Email Service
- shield (AWS/DDoSProtection) - Distributed Denial of Service (DDoS) protection service
- sqs (AWS/SQS) - Simple Queue Service
- tgw (AWS/TransitGateway) - Transit Gateway
- vpn (AWS/VPN) - VPN connection
- asg (AWS/AutoScaling) - Auto Scaling Group
- kafka (AWS/Kafka) - Managed Apache Kafka
- firehose (AWS/Firehose) - Managed Streaming Service
- sns (AWS/SNS) - Simple Notification Service
- sfn (AWS/States) - Step Functions
- wafv2 (AWS/WAFV2) - Web Application Firewall v2
- workspaces (AWS/WorkSpaces) - Workspaces
ghcr.io/nerdswords/yet-another-cloudwatch-exporter:x.x.xe.g. 0.5.0- See Releases for binaries
| Option | Description |
|---|---|
| labels-snake-case | Causes labels on metrics to be output in snake case instead of camel case |
| floating-time-window | Use a floating start/end time window instead of rounding times to 5 min intervals |
| Key | Description |
|---|---|
| apiVersion | Configuration file version |
| discovery | Auto-discovery configuration |
| static | List of static configurations |
| Key | Description |
|---|---|
| exportedTagsOnMetrics | List of tags per service to export to all metrics |
| jobs | List of auto-discovery jobs |
exportedTagsOnMetrics example:
exportedTagsOnMetrics:
ec2:
- Name
- typeNote: Only tagged resources are discovered.
| Key | Description |
|---|---|
| regions | List of AWS regions |
| type | Cloudwatch service alias ("alb", "ec2", etc) or namespace name ("AWS/EC2", "AWS/S3", etc). |
| length (Default 120) | How far back to request data for in seconds |
| delay | If set it will request metrics up until current_time - delay |
| roles | List of IAM roles to assume (optional) |
| searchTags | List of Key/Value pairs to use for tag filtering (all must match), Value can be a regex. |
| period | Statistic period in seconds (General Setting for all metrics in this job) |
| addCloudwatchTimestamp | Export the metric with the original CloudWatch timestamp (General Setting for all metrics in this job) |
| customTags | Custom tags to be added as a list of Key/Value pairs |
| metrics | List of metric definitions |
searchTags example:
searchTags:
- key: envvalue: production| Key | Description |
|---|---|
| name | CloudWatch metric name |
| statistics | List of statistic types, e.g. "Minimum", "Maximum", etc. |
| period | Statistic period in seconds (Overrides job level setting) |
| length | How far back to request data for in seconds(for static jobs) |
| delay | If set it will request metrics up until current_time - delay(for static jobs) |
| nilToZero | Return 0 value if Cloudwatch returns no metrics at all. By default NaN will be reported |
| addCloudwatchTimestamp | Export the metric with the original CloudWatch timestamp (Overrides job level setting) |
- Available statistics: Maximum, Minimum, Sum, SampleCount, Average, pXX.
- Watch out using
addCloudwatchTimestampfor sparse metrics, e.g from S3, since Prometheus won't scrape metrics containing timestamps older than 2-3 hours - Setting Inheritance: Some settings at the job level are overridden by settings at the metric level. This allows for a specific setting to override a general setting. The currently inherited settings are period, and addCloudwatchTimestamp
| Key | Description |
|---|---|
| regions | List of AWS regions |
| roles | List of IAM roles to assume |
| namespace | CloudWatch namespace |
| name | Must be set with multiple block definitions per namespace |
| customTags | Custom tags to be added as a list of Key/Value pairs |
| dimensions | CloudWatch metric dimensions as a list of Name/Value pairs |
| metrics | List of metric definitions |
apiVersion: v1alpha1discovery:
exportedTagsOnMetrics:
ec2:
- Nameebs:
- VolumeIdjobs:
- type: esregions:
- eu-west-1searchTags:
- key: typevalue: ^(easteregg|k8s)$metrics:
- name: FreeStorageSpacestatistics:
- Sumperiod: 600length: 60
- name: ClusterStatus.greenstatistics:
- Minimumperiod: 600length: 60
- name: ClusterStatus.yellowstatistics:
- Maximumperiod: 600length: 60
- name: ClusterStatus.redstatistics:
- Maximumperiod: 600length: 60
- type: elbregions:
- eu-west-1length: 900delay: 120searchTags:
- key: KubernetesClustervalue: production-19metrics:
- name: HealthyHostCountstatistics:
- Minimumperiod: 600length: 600#(this will be ignored)
- name: HTTPCode_Backend_4XXstatistics:
- Sumperiod: 60length: 900#(this will be ignored)delay: 300#(this will be ignored)nilToZero: true
- type: albregions:
- eu-west-1searchTags:
- key: kubernetes.io/service-namevalue: .*metrics:
- name: UnHealthyHostCountstatistics: [Maximum]period: 60length: 600
- type: vpnregions:
- eu-west-1searchTags:
- key: kubernetes.io/service-namevalue: .*metrics:
- name: TunnelStatestatistics:
- p90period: 60length: 300
- type: kinesisregions:
- eu-west-1metrics:
- name: PutRecords.Successstatistics:
- Sumperiod: 60length: 300
- type: s3regions:
- eu-west-1searchTags:
- key: typevalue: publicmetrics:
- name: NumberOfObjectsstatistics:
- Averageperiod: 86400length: 172800
- name: BucketSizeBytesstatistics:
- Averageperiod: 86400length: 172800
- type: ebsregions:
- eu-west-1searchTags:
- key: typevalue: publicmetrics:
- name: BurstBalancestatistics:
- Minimumperiod: 600length: 600addCloudwatchTimestamp: true
- type: kafkaregions:
- eu-west-1searchTags:
- key: envvalue: devmetrics:
- name: BytesOutPerSecstatistics:
- Averageperiod: 600length: 600static:
- namespace: AWS/AutoScalingname: must_be_setregions:
- eu-west-1dimensions:
- name: AutoScalingGroupNamevalue: TestcustomTags:
- key: CustomTagvalue: CustomValuemetrics:
- name: GroupInServiceInstancesstatistics:
- Minimumperiod: 60length: 300[Source: config_test.yml]
### Metrics with exportedTagsOnMetrics
aws_ec2_cpuutilization_maximum{dimension_InstanceId="i-someid", name="arn:aws:ec2:eu-west-1:472724724:instance/i-someid", tag_Name="jenkins"} 57.2916666666667
### Info helper with tags
aws_elb_info{name="arn:aws:elasticloadbalancing:eu-west-1:472724724:loadbalancer/a815b16g3417211e7738a02fcc13bbf9",tag_KubernetesCluster="production-19",tag_Name="",tag_kubernetes_io_cluster_production_19="owned",tag_kubernetes_io_service_name="nginx-ingress/private-ext",region="eu-west-1"} 0
aws_ec2_info{name="arn:aws:ec2:eu-west-1:472724724:instance/i-someid",tag_Name="jenkins"} 0
### Track cloudwatch requests to calculate costs
yace_cloudwatch_requests_total 168
# CPUUtilization + Name tag of the instance id - No more instance id needed for monitoring
aws_ec2_cpuutilization_average + on (name) group_left(tag_Name) aws_ec2_info
# Free Storage in Megabytes + tag Type of the elasticsearch cluster
(aws_es_free_storage_space_sum + on (name) group_left(tag_Type) aws_es_info) / 1024
# Add kubernetes / kops tags on 4xx elb metrics
(aws_elb_httpcode_backend_4_xx_sum + on (name) group_left(tag_KubernetesCluster,tag_kubernetes_io_service_name) aws_elb_info)
# Availability Metric for ELBs (Successful requests / Total Requests) + k8s service name
# Use nilToZero on all metrics else it won't work
((aws_elb_request_count_sum - on (name) group_left() aws_elb_httpcode_backend_4_xx_sum) - on (name) group_left() aws_elb_httpcode_backend_5_xx_sum) + on (name) group_left(tag_kubernetes_io_service_name) aws_elb_info
# Forecast your elasticsearch disk size in 7 days and report metrics with tags type and version
predict_linear(aws_es_free_storage_space_minimum[2d], 86400 * 7) + on (name) group_left(tag_type, tag_version) aws_es_info
# Forecast your cloudwatch costs for next 32 days based on last 10 minutes
# 1.000.000 Requests free
# 0.01 Dollar for 1.000 GetMetricStatistics Api Requests (https://aws.amazon.com/cloudwatch/pricing/)
((increase(yace_cloudwatch_requests_total[10m]) * 6 * 24 * 32) - 100000) / 1000 * 0.01
The following IAM permissions are required for YACE to work.
"tag:GetResources",
"cloudwatch:GetMetricData",
"cloudwatch:GetMetricStatistics",
"cloudwatch:ListMetrics"The following IAM permissions are required for the transit gateway attachment (tgwa) metrics to work.
"ec2:DescribeTags",
"ec2:DescribeInstances",
"ec2:DescribeRegions",
"ec2:DescribeTransitGateway*"The following IAM permission is required to discover tagged API Gateway REST APIs:
"apigateway:GET"docker run -d --rm -v $PWD/credentials:/exporter/.aws/credentials -v $PWD/config.yml:/tmp/config.yml \
-p 5000:5000 --name yace ghcr.io/nerdswords/yet-another-cloudwatch-exporter:vx.xx.x # release version as tag - Do not forget the version 'v'---
apiVersion: v1kind: ConfigMapmetadata:
name: yacedata:
config.yml: |- --- # Start of config file---
apiVersion: apps/v1kind: Deploymentmetadata:
name: yacespec:
replicas: 1selector:
matchLabels:
name: yacetemplate:
metadata:
labels:
name: yacespec:
containers:
- name: yaceimage: ghcr.io/nerdswords/yet-another-cloudwatch-exporter:vx.x.x # release version as tag - Do not forget the version 'v'imagePullPolicy: IfNotPresentargs:
- "--config.file=/tmp/config.yml"ports:
- name: appcontainerPort: 5000volumeMounts:
- name: config-volumemountPath: /tmpvolumes:
- name: config-volumeconfigMap:
name: yaceMultiple roleArns are useful, when you are monitoring multi-account setup, where all accounts are using same AWS services. For example, you are running yace in monitoring account and you have number of accounts (for example newspapers, radio and television) running ECS clusters. Each account gives yace permissions to assume local IAM role, which has all the necessary permissions for Cloudwatch metrics. On this kind of setup, you could simply list:
jobs:
- type: ecs-svcregions:
- eu-north-1roles:
- roleArn: "arn:aws:iam:1111111111111:role/prometheus"# newspaper
- roleArn: "arn:aws:iam:2222222222222:role/prometheus"# radio
- roleArn: "arn:aws:iam:3333333333333:role/prometheus"# televisionmetrics:
- name: MemoryReservationstatistics:
- Average
- Minimum
- Maximumperiod: 600length: 600Additionally, if the IAM role you want to assume requires an External ID you can specify it this way:
roles:
- roleArn: "arn:aws:iam:1111111111111:role/prometheus"externalId: "shared-external-identifier"The flags 'cloudwatch-concurrency' and 'tag-concurrency' define the number of concurrent request to cloudwatch metrics and tags. Their default value is 5.
Setting a higher value makes faster scraping times but can incur in throttling and the blocking of the API.
The exporter scraped cloudwatch metrics in the background in fixed interval. This protects from the abuse of API requests that can cause extra billing in AWS account.
The flag 'scraping-interval' defines the seconds between scrapes. The default value is 300.
- Please, try out a bigger length e.g. for elb try out a length of 600 and a period of 600. Then test how low you can go without losing data. ELB metrics on AWS are written every 5 minutes (300) in default.
- Please, try to set a lower value for the 'scraping-interval' flag or set the 'decoupled-scraping' to false.
- Justin Santa Barbara - For telling me about AWS tags api which simplified a lot - Thanks!
- Brian Brazil - Who gave a lot of feedback regarding UX and prometheus lib - Thanks!