Repository: ivx/yet-another-cloudwatch-exporter
Branch: master
Commit: cbafcecb8da1
Files: 202
Total size: 836.9 KB
Directory structure:
gitextract_8d8x638_/
├── .dockerignore
├── .github/
│ ├── FUNDING.yml
│ ├── ISSUE_TEMPLATE/
│ │ ├── bug.yml
│ │ └── feature.yml
│ ├── dependabot.yml
│ └── workflows/
│ ├── ci.yml
│ ├── container_description.yml
│ └── golangci-lint.yml
├── .gitignore
├── .golangci.yml
├── .promu.yml
├── .yamllint
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTE.md
├── Dockerfile
├── LICENSE
├── MAINTAINERS.md
├── Makefile
├── Makefile.common
├── NOTICE
├── README.md
├── SECURITY.md
├── VERSION
├── cmd/
│ └── yace/
│ ├── main.go
│ ├── main_test.go
│ └── scraper.go
├── docker-compose/
│ ├── README.md
│ ├── docker-compose.yaml
│ ├── grafana/
│ │ └── datasource.yaml
│ ├── prometheus.yaml
│ └── yace-config.yaml
├── docs/
│ ├── configuration.md
│ ├── embedding.md
│ ├── feature_flags.md
│ └── installation.md
├── examples/
│ ├── alb.yml
│ ├── apigw.yml
│ ├── apprunner.yaml
│ ├── appstream.yml
│ ├── backup.yml
│ ├── cwagent.yml
│ ├── ds.yml
│ ├── dx.yml
│ ├── ebs.yml
│ ├── ec.yml
│ ├── ec2.yml
│ ├── ecs.yml
│ ├── elb.yml
│ ├── es.yml
│ ├── historic-data.yml
│ ├── kafka.yml
│ ├── kinesis.yml
│ ├── kms.yml
│ ├── lambda.yml
│ ├── lambda_edge.yml
│ ├── logs.yml
│ ├── mq.yml
│ ├── networkmanager.yml
│ ├── ngw.yml
│ ├── nlb.yml
│ ├── private-link-endpoints.yaml
│ ├── private-link-services.yaml
│ ├── qldb.yml
│ ├── quicksight.yml
│ ├── rds.yml
│ ├── redshift-serverless.yml
│ ├── s3.yml
│ ├── ses.yaml
│ ├── sns.yml
│ ├── sqs.yml
│ ├── usage.yml
│ └── vpn.yml
├── go.mod
├── go.sum
├── mixin/
│ ├── README.md
│ ├── config.libsonnet
│ ├── dashboards/
│ │ ├── all.libsonnet
│ │ ├── common.libsonnet
│ │ ├── ebs.libsonnet
│ │ ├── ec2.libsonnet
│ │ ├── lambda.libsonnet
│ │ ├── rds.libsonnet
│ │ └── s3.libsonnet
│ ├── jsonnetfile.json
│ ├── jsonnetfile.lock.json
│ ├── mixin.libsonnet
│ └── util.libsonnet
└── pkg/
├── clients/
│ ├── README.md
│ ├── account/
│ │ └── client.go
│ ├── cloudwatch/
│ │ ├── client.go
│ │ ├── client_test.go
│ │ ├── concurrency_client.go
│ │ └── input.go
│ ├── factory.go
│ ├── factory_test.go
│ └── tagging/
│ ├── client.go
│ ├── concurrency_client.go
│ ├── filters.go
│ └── filters_test.go
├── config/
│ ├── config.go
│ ├── config_test.go
│ ├── feature_flags.go
│ ├── feature_flags_test.go
│ ├── services.go
│ ├── services_test.go
│ └── testdata/
│ ├── config_test.yml
│ ├── custom_namespace.ok.yml
│ ├── custom_namespace_without_name.bad.yml
│ ├── custom_namespace_without_namespace.bad.yml
│ ├── custom_namespace_without_region.bad.yml
│ ├── discovery_job_exported_tags_alias.bad.yml
│ ├── discovery_job_exported_tags_mismatch.bad.yml
│ ├── discovery_job_type_alias.bad.yml
│ ├── discovery_job_type_unknown.bad.yml
│ ├── empty_rolearn.ok.yml
│ ├── externalid_with_empty_rolearn.bad.yml
│ ├── externalid_without_rolearn.bad.yml
│ ├── multiple_roles.ok.yml
│ ├── sts_region.ok.yml
│ └── unknown_version.bad.yml
├── exporter.go
├── exporter_enhancedmetrics_test.go
├── exporter_test.go
├── internal/
│ └── enhancedmetrics/
│ ├── config/
│ │ └── provider.go
│ ├── registry.go
│ ├── registry_test.go
│ ├── service/
│ │ ├── dynamodb/
│ │ │ ├── client.go
│ │ │ ├── client_test.go
│ │ │ ├── service.go
│ │ │ └── service_test.go
│ │ ├── elasticache/
│ │ │ ├── client.go
│ │ │ ├── client_test.go
│ │ │ ├── service.go
│ │ │ └── service_test.go
│ │ ├── lambda/
│ │ │ ├── client.go
│ │ │ ├── client_test.go
│ │ │ ├── service.go
│ │ │ └── service_test.go
│ │ ├── rds/
│ │ │ ├── client.go
│ │ │ ├── client_test.go
│ │ │ ├── service.go
│ │ │ └── service_test.go
│ │ └── services.go
│ ├── service.go
│ └── service_test.go
├── job/
│ ├── cloudwatchrunner/
│ │ ├── customnamespace.go
│ │ ├── discovery.go
│ │ └── runner.go
│ ├── custom.go
│ ├── discovery.go
│ ├── discovery_test.go
│ ├── getmetricdata/
│ │ ├── compact.go
│ │ ├── compact_test.go
│ │ ├── iterator.go
│ │ ├── iterator_test.go
│ │ ├── processor.go
│ │ ├── processor_test.go
│ │ ├── windowcalculator.go
│ │ └── windowcalculator_test.go
│ ├── listmetrics/
│ │ └── processor.go
│ ├── maxdimassociator/
│ │ ├── associator.go
│ │ ├── associator_api_gateway_test.go
│ │ ├── associator_client_vpn_test.go
│ │ ├── associator_ddosprotection_test.go
│ │ ├── associator_directoryservice_test.go
│ │ ├── associator_dx_test.go
│ │ ├── associator_ec2_test.go
│ │ ├── associator_ec_test.go
│ │ ├── associator_ecs_test.go
│ │ ├── associator_event_roles_test.go
│ │ ├── associator_globalaccelerator_test.go
│ │ ├── associator_gwlb_test.go
│ │ ├── associator_ipam_test.go
│ │ ├── associator_kms_test.go
│ │ ├── associator_lambda_test.go
│ │ ├── associator_logging_test.go
│ │ ├── associator_logs_test.go
│ │ ├── associator_mediaconvert_test.go
│ │ ├── associator_memorydb_test.go
│ │ ├── associator_mq_test.go
│ │ ├── associator_qldb_test.go
│ │ ├── associator_redshift_serverless_test.go
│ │ ├── associator_sagemaker_endpoint_test.go
│ │ ├── associator_sagemaker_inf_component_test.go
│ │ ├── associator_sagemaker_inf_rec_test.go
│ │ ├── associator_sagemaker_pipeline_test.go
│ │ ├── associator_sagemaker_processing_test.go
│ │ ├── associator_sagemaker_test.go
│ │ ├── associator_sagemaker_training_test.go
│ │ └── associator_sagemaker_transform_test.go
│ ├── resourcemetadata/
│ │ └── resource.go
│ ├── scrape.go
│ ├── scraper.go
│ ├── scraper_test.go
│ └── static.go
├── model/
│ ├── model.go
│ └── model_test.go
└── promutil/
├── migrate.go
├── migrate_test.go
├── prometheus.go
└── prometheus_test.go
================================================
FILE CONTENTS
================================================
================================================
FILE: .dockerignore
================================================
data/
.build/
.tarballs/
!.build/linux-amd64/
!.build/linux-arm64/
!.build/linux-armv7/
!.build/linux-ppc64le/
!.build/linux-riscv64/
!.build/linux-s390x/
================================================
FILE: .github/FUNDING.yml
================================================
# These are supported funding model platforms
patreon: thomaspeitz
================================================
FILE: .github/ISSUE_TEMPLATE/bug.yml
================================================
name: 🐞 Bug
description: File a bug report
title: "[BUG] "
labels: [bug]
body:
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: YACE version
description: The output of running `yace version`.
validations:
required: false
- type: textarea
attributes:
label: Config file
description: The config file passed to the `--config.file` option.
validations:
required: false
- type: textarea
attributes:
label: Current Behavior
description: A concise description of what you're experiencing.
validations:
required: false
- type: textarea
attributes:
label: Expected Behavior
description: A concise description of what you expected to happen.
validations:
required: false
- type: textarea
attributes:
label: Steps To Reproduce
description: Steps to reproduce the behavior.
placeholder: |
1. In this environment...
2. With this config...
3. Run '...'
4. See error...
validations:
required: false
- type: textarea
attributes:
label: Anything else?
description: |
Links? References? Anything that will give us more context about the issue you are encountering!
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false
================================================
FILE: .github/ISSUE_TEMPLATE/feature.yml
================================================
name: 🆕 Feature
description: Request a new feature
title: "[FEATURE] <title>"
labels: [enhancement]
body:
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the feature you are requesting.
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: Feature description
description: A concise description of what you're expecting.
validations:
required: true
- type: textarea
attributes:
label: What might the configuration look like?
description: Example configuration (useful as a baseline during development).
placeholder: |
```yml
discovery:
jobs:
- type: <name of service>
period: 30
length: 600
metrics:
- name: SomeExportedMetric
statistics: [Minimum, Maximum]
```
validations:
required: false
- type: textarea
attributes:
label: Anything else?
description: |
Links? References? Anything that will give us more context about the issue you are encountering!
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false
================================================
FILE: .github/dependabot.yml
================================================
version: 2
updates:
- package-ecosystem: gomod
directory: /
schedule:
interval: monthly
open-pull-requests-limit: 10
groups:
aws-sdk-v2:
patterns:
- "github.com/aws/aws-sdk-go-v2*"
- package-ecosystem: github-actions
directory: /
schedule:
interval: monthly
open-pull-requests-limit: 10
================================================
FILE: .github/workflows/ci.yml
================================================
name: CI
on:
push:
tags:
- 'v*'
branches:
- master
pull_request:
workflow_call:
jobs:
test_go:
name: Go tests
runs-on: ubuntu-latest
container:
image: quay.io/prometheus/golang-builder:1.26-base
steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
- uses: prometheus/promci-setup@5af30ba8c199a91d6c04ebdc3c48e630e355f62d # v0.1.0
- run: make test
build:
name: Build for common architectures
runs-on: ubuntu-latest
if: |
!(github.event_name == 'push' && github.event.ref == 'refs/heads/master')
&&
!(github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v'))
strategy:
matrix:
thread: [ 0, 1, 2 ]
steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
- uses: prometheus/promci/build@769ee18070cd21cfc2a24fa912349fd3e48dee58 # v0.6.0
with:
promu_opts: "-p linux/amd64 -p windows/amd64 -p darwin/amd64 -p linux/arm64 -p windows/arm64 -p darwin/arm64"
parallelism: 3
thread: ${{ matrix.thread }}
build_all:
name: Build for all architectures
runs-on: ubuntu-latest
if: |
(github.event_name == 'push' && github.event.ref == 'refs/heads/master')
||
(github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v'))
strategy:
matrix:
thread: [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 ]
steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
- uses: prometheus/promci/build@769ee18070cd21cfc2a24fa912349fd3e48dee58 # v0.6.0
with:
parallelism: 12
thread: ${{ matrix.thread }}
verify-example-configs:
name: Verify
runs-on: ubuntu-latest
container:
image: quay.io/prometheus/golang-builder:1.26-base
steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
- run: make build
- name: Verify example configs
run: find ./examples -name "*.yml" -print0 | xargs -0 -I % ./yace verify-config -config.file %
publish_master:
name: Publish master branch artifacts
runs-on: ubuntu-latest
needs: [test_go, build_all, verify-example-configs]
if: |
(github.repository == 'prometheus-community/yet-another-cloudwatch-exporter')
&&
(github.event_name == 'push' && github.event.ref == 'refs/heads/master')
steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
- uses: prometheus/promci/publish_main@769ee18070cd21cfc2a24fa912349fd3e48dee58 # v0.6.0
with:
docker_hub_organization: prometheuscommunity
docker_hub_login: ${{ secrets.docker_hub_login }}
docker_hub_password: ${{ secrets.docker_hub_password }}
quay_io_organization: prometheuscommunity
quay_io_login: ${{ secrets.quay_io_login }}
quay_io_password: ${{ secrets.quay_io_password }}
publish_release:
name: Publish release artifacts
runs-on: ubuntu-latest
needs: [test_go, build_all, verify-example-configs]
if: |
(github.repository == 'prometheus-community/yet-another-cloudwatch-exporter')
&&
(github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v0.'))
steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
- uses: prometheus/promci/publish_release@769ee18070cd21cfc2a24fa912349fd3e48dee58 # v0.6.0
with:
docker_hub_organization: prometheuscommunity
docker_hub_login: ${{ secrets.docker_hub_login }}
docker_hub_password: ${{ secrets.docker_hub_password }}
quay_io_organization: prometheuscommunity
quay_io_login: ${{ secrets.quay_io_login }}
quay_io_password: ${{ secrets.quay_io_password }}
github_token: ${{ secrets.PROMBOT_GITHUB_TOKEN }}
================================================
FILE: .github/workflows/container_description.yml
================================================
---
name: Push README to Docker Hub
on:
push:
paths:
- "README.md"
- "README-containers.md"
- ".github/workflows/container_description.yml"
branches: [ main, master ]
permissions:
contents: read
jobs:
PushDockerHubReadme:
runs-on: ubuntu-latest
name: Push README to Docker Hub
if: github.repository_owner == 'prometheus' || github.repository_owner == 'prometheus-community' # Don't run this workflow on forks.
steps:
- name: git checkout
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
persist-credentials: false
- name: Set docker hub repo name
run: echo "DOCKER_REPO_NAME=$(make docker-repo-name)" >> $GITHUB_ENV
- name: Push README to Dockerhub
uses: christian-korneck/update-container-description-action@d36005551adeaba9698d8d67a296bd16fa91f8e8 # v1
env:
DOCKER_USER: ${{ secrets.DOCKER_HUB_LOGIN }}
DOCKER_PASS: ${{ secrets.DOCKER_HUB_PASSWORD }}
with:
destination_container_repo: ${{ env.DOCKER_REPO_NAME }}
provider: dockerhub
short_description: ${{ env.DOCKER_REPO_NAME }}
# Empty string results in README-containers.md being pushed if it
# exists. Otherwise, README.md is pushed.
readme_file: ''
PushQuayIoReadme:
runs-on: ubuntu-latest
name: Push README to quay.io
if: github.repository_owner == 'prometheus' || github.repository_owner == 'prometheus-community' # Don't run this workflow on forks.
steps:
- name: git checkout
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
persist-credentials: false
- name: Set quay.io org name
run: echo "DOCKER_REPO=$(echo quay.io/${GITHUB_REPOSITORY_OWNER} | tr -d '-')" >> $GITHUB_ENV
- name: Set quay.io repo name
run: echo "DOCKER_REPO_NAME=$(make docker-repo-name)" >> $GITHUB_ENV
- name: Push README to quay.io
uses: christian-korneck/update-container-description-action@d36005551adeaba9698d8d67a296bd16fa91f8e8 # v1
env:
DOCKER_APIKEY: ${{ secrets.QUAY_IO_API_TOKEN }}
with:
destination_container_repo: ${{ env.DOCKER_REPO_NAME }}
provider: quay
# Empty string results in README-containers.md being pushed if it
# exists. Otherwise, README.md is pushed.
readme_file: ''
================================================
FILE: .github/workflows/golangci-lint.yml
================================================
---
# This action is synced from https://github.com/prometheus/prometheus
name: golangci-lint
on:
push:
branches: [main, master, 'release-*']
paths:
- "go.sum"
- "go.mod"
- "**.go"
- "scripts/errcheck_excludes.txt"
- ".github/workflows/golangci-lint.yml"
- ".golangci.yml"
tags: ['v*']
pull_request:
permissions: # added using https://github.com/step-security/secure-repo
contents: read
jobs:
golangci:
permissions:
contents: read # for actions/checkout to fetch code
pull-requests: read # for golangci/golangci-lint-action to fetch pull requests
name: lint
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
persist-credentials: false
- name: Install Go
uses: actions/setup-go@4a3601121dd01d1626a1e23e37211e3254c1c06c # v6.4.0
with:
go-version: 1.26.x
- name: Install snmp_exporter/generator dependencies
run: sudo apt-get update && sudo apt-get -y install libsnmp-dev
if: github.repository == 'prometheus/snmp_exporter'
- name: Get golangci-lint version
id: golangci-lint-version
run: echo "version=$(make print-golangci-lint-version)" >> $GITHUB_OUTPUT
- name: Lint
uses: golangci/golangci-lint-action@1e7e51e771db61008b38414a730f564565cf7c20 # v9.2.0
with:
args: --verbose
version: ${{ steps.golangci-lint-version.outputs.version }}
================================================
FILE: .gitignore
================================================
.build
yet-another-cloudwatch-exporter
!charts/yet-another-cloudwatch-exporter
vendor
dist
/yace
*.tar.gz
================================================
FILE: .golangci.yml
================================================
version: "2"
output:
formats:
text:
path: stderr
colors: false
linters:
default: none
enable:
- asasalint
- bodyclose
- copyloopvar
- errcheck
- errorlint
- exhaustive
- govet
- ineffassign
- misspell
- nilerr
- nolintlint
- nonamedreturns
- predeclared
- revive
- sloglint
- staticcheck
- unconvert
- unused
exclusions:
generated: lax
presets:
- comments
- common-false-positives
- legacy
- std-error-handling
paths:
- third_party$
- builtin$
- examples$
formatters:
enable:
- gofmt
- gofumpt
- goimports
settings:
goimports:
local-prefixes:
- github.com/prometheus-community/yet-another-cloudwatch-exporter
exclusions:
generated: lax
paths:
- third_party$
- builtin$
- examples$
================================================
FILE: .promu.yml
================================================
go:
# This must match .circle/config.yml.
version: 1.26
repository:
path: github.com/prometheus-community/yet-another-cloudwatch-exporter
build:
binaries:
- name: yace
path: ./cmd/yace
ldflags: |
-X github.com/prometheus/common/version.Version={{.Version}}
-X github.com/prometheus/common/version.Revision={{.Revision}}
-X github.com/prometheus/common/version.Branch={{.Branch}}
-X github.com/prometheus/common/version.BuildUser={{user}}@{{host}}
-X github.com/prometheus/common/version.BuildDate={{date "20060102-15:04:05"}}
tarball:
files:
- LICENSE
- NOTICE
================================================
FILE: .yamllint
================================================
---
extends: default
ignore: |
**/node_modules
web/api/v1/testdata/openapi_*_golden.yaml
rules:
braces:
max-spaces-inside: 1
level: error
brackets:
max-spaces-inside: 1
level: error
commas: disable
comments: disable
comments-indentation: disable
document-start: disable
indentation:
spaces: consistent
indent-sequences: consistent
key-duplicates:
ignore: |
config/testdata/section_key_dup.bad.yml
line-length: disable
truthy:
check-keys: false
================================================
FILE: CHANGELOG.md
================================================
## main / (unreleased)
## 0.64.0 / 2026-03-27
**Important news and breaking changes**
- BREAKING CHANGE: AWS SDK v1 support has been removed. The `aws-sdk-v1` feature flag is now a no-op and will be silently ignored. AWS SDK v1 reached end-of-support on July 31, 2025. SDK v2 has been the default since v0.63.0 (September 2025). Users who were passing `--enable-feature aws-sdk-v1` should remove the flag, as it no longer has any effect. If you use YACE as a library, the `v1` and `v2` sub-packages under `pkg/clients/` have been removed. All client implementations now live directly in their parent packages (e.g. `pkg/clients/cloudwatch`, `pkg/clients/tagging`, `pkg/clients/account`). Import paths like `pkg/clients/v1`, `pkg/clients/cloudwatch/v2`, etc. must be updated accordingly.
* [CHANGE] Remove AWS SDK v1 support and deprecate `aws-sdk-v1` feature flag by @tristanburgess. #1825
* [CHANGE] Add Andrii Kushch and Tristan Burgess as maintainers by @cristiangreco. #1788
* [FEATURE] Implement Enhanced Metrics framework and initial set of metrics by @andriikushch. #1795
* [FEATURE] Add support for `AWS/EKS` namespace by @LS80. #1760
* [FEATURE] Split out Bedrock metrics into all needed namespaces by @tristanburgess. #1766
* [FEATURE] Separate aliases for Bedrock namespaces by @tristanburgess. #1767
* [ENHANCEMENT] Update Go build to 1.26, replace `gopkg.in/yaml.v2` with supported fork, sync upstream Prometheus files and migrate PromCI tooling by @SuperQ. #1831
* [ENHANCEMENT] Add AWS/Bedrock GuardrailArn dimension-based resource tagging by @tristanburgess. #1761
* [ENHANCEMENT] Add DimensionRegexps support for AWS Backup service by @amitshl. #1775
* [ENHANCEMENT] Add DimensionRegexps for AWS/Cassandra by @bdeore. #1693
* [ENHANCEMENT] Add DimensionRegexp to ElasticBeanstalk by @benbridts. #1690
* [ENHANCEMENT] Test exporter with mocked clients by @jeschkies. #1791
* [ENHANCEMENT] Add privatelink examples to docs by @cuscal-brad. #1765
* [BUGFIX] Fix AWS SageMaker dimension name handling for case sensitivity by @andriikushch. #1793
* [BUGFIX] Fix Docker configuration paths for AWS credentials by @andriikushch. #1804
## 0.63.0 / 2025-09-25
**Important news and breaking changes**
- NOTE: As of Prometheus 3.0, UTF-8 strings are valid for metric names and label names. However, for backward compatibility, this release of YACE still uses the old, stricter legacy validation scheme. UTF-8 validation will be enabled in a feature version of YACE, thus requiring that your remote destination is compatible with UTF-8 support.
- BREAKING CHANGE: the AWS SDK v2 is now the default in YACE. Use the flag `aws-sdk-v1` to switch back to SDK v2. Flag `aws-sdk-v2` has been removed.
- NEW FEATURE: `exportAllDataPoints`, enables the inclusion of past metric data points from the CloudWatch response if available.
* [CHANGE] Make aws sdk v2 the default choice by @cristiangreco
* [FEATURE] Support history data export by @woehrl01
* [FEATURE] Add AWS/Transfer as available service by @thepalbi
* [FEATURE] Add auto-discovery for Directory Services(MicrosoftAD) by @RuslanMustaev
* [FEATURE] Add support for Redshift-Serverless by @nickbazinet
* [FEATURE] Add db connections avg panel to RDS dashboard by @yduartep
* [FEATURE] Add example for lambda_edge by @tyagian
* [FEATURE] sagemaker: additional InferenceComponent support by @tristanburgess
* [ENHANCEMENT] Update Go version by @SuperQ
* [ENHANCEMENT] Use Prometheus common version library by @SuperQ
* [ENHANCEMENT] Update container repositories by @SuperQ
* [ENHANCEMENT] Speed up build metric name by @jeschkies
* [ENHANCEMENT] Add guard to hot logging location in associator by @thepalbi
* [ENHANCEMENT] Update resource association logic to try both with and without dimension fixes by @tristanburgess
* [ENHANCEMENT] Change discovery runtime model field from Type -> Namespace by @kgeckhart
* [BUGFIX] Fix `CachingFactory` concurrent usage issues by @andriikushch
* [BUGFIX] Correctly run tests in CI and fix failing tests by @jeschkies
* [BUGFIX] Fix doc about non-existing `debug` flag by @zipkid
* [BUGFIX] Update URL to Helm Chart in docs by @koralowiec
* [BUGFIX] Add missing license header to `associator_logging_test.go` by @cristiangreco
* [BUGFIX] Dashboards: replace `scrape_job` label with `job` by @yduartep
* [BUGFIX] RDS dashboard: use average for cpu utilization to align with AWS best practices by @yduartep
## 0.62.1 / 2025-01-03
**Important news and breaking changes**
Bugfix release to address artifacts build error. The most important news is the same as 0.62.0: as of November 2024, YACE is part of prometheus-community. Read more about it in these announcement posts:
- https://prometheus.io/blog/2024/11/19/yace-joining-prometheus-community/
- https://grafana.com/blog/2024/11/19/yace-moves-to-prometheus-community/
* [ENHANCEMENT] Adopt log/slog, drop custom logging pkg by @tjhop
* [ENHANCEMENT] Bump github.com/prometheus/common from 0.60.1 to 0.61.0
* [ENHANCEMENT] Bump golang.org/x/sync from 0.9.0 to 0.10.0
* [ENHANCEMENT] Bump the aws-sdk-v2 group
* [ENHANCEMENT] Synchronize common files from prometheus/prometheus
* [ENHANCEMENT] Update CHANGELOG format by @SuperQ
* [BUGFIX] Fix artifact publishing by @SuperQ
## 0.62.0 / 2024-12-19
**Important news and breaking changes**
* As of November 2024, YACE is part of prometheus-community. Read more about it in these announcement posts:
- https://prometheus.io/blog/2024/11/19/yace-joining-prometheus-community/
- https://grafana.com/blog/2024/11/19/yace-moves-to-prometheus-community/
**Bugfixes and features**
Features:
* Add ContainerInsights service by @JetSquirrel
* Add AWS/Scheduler and AWS/ECR services by @andriikushch
* Add AWS/VpcLattice service by @greymd
* Add AWS/QuickSight service by @choppedpork
* Add AWS/Timestream service by @andriikushch
* Add Network Manager / Cloud WAN support by @kylehodgetts
* RDS: include RDS Proxy metrics within the RDS namespace by @vitaliyf
* Mediapackage: include mediapackagev2 namespace by @henrylaiBrightcove
Bugs:
* Add parentheses to sanitize list to prevent invalid metric name generation by @nixargh
Docs:
* Review and update supported services in README by @cristiangreco
* Mention support for AWS/MediaPackage by @prathamesh-sonpatki
* Update README and MAINTAINERS files to mention the move to prometheus-community by @cristiangreco
Refactoring:
* Start a unified scraper by @kgeckhart
* Refactor prom metric creation by @kgeckhart
* Update for Prometheus Community by @SuperQ
* Update Docker build by @SuperQ
* Fix linting issues detected by golangci-lint 1.60.3 by @cristiangreco
* Update build tools and CI to Go 1.23 by @cristiangreco
**Dependencies**
* Bump actions/checkout from 4.2.0 to 4.2.2
* Bump alpine from 3.20.1 to 3.20.3
* Bump github.com/aws/aws-sdk-go from 1.54.7 to 1.55.5
* Bump github.com/aws/smithy-go from 1.22.0 to 1.22.1
* Bump github.com/prometheus/client_golang from 1.19.1 to 1.20.5
* Bump github.com/prometheus/common from 0.54.0 to 0.60.1
* Bump github.com/stretchr/testify from 1.9.0 to 1.10.0
* Bump github.com/urfave/cli/v2 from 2.27.2 to 2.27.5
* Bump golang from 1.22 to 1.23
* Bump golang.org/x/sync from 0.7.0 to 0.9.0
* Bump golangci/golangci-lint-action from 6.0.1 to 6.1.1
* Bump grafana/regexp to `20240607082908-2cb410fa05da`
* Bump the aws-sdk-v2 group
**New contributors**
* @prathamesh-sonpatki made their first contribution in https://github.com/prometheus-community/yet-another-cloudwatch-exporter/pull/1465
* @JetSquirrel made their first contribution in https://github.com/prometheus-community/yet-another-cloudwatch-exporter/pull/1463
* @greymd made their first contribution in https://github.com/prometheus-community/yet-another-cloudwatch-exporter/pull/1506
* @choppedpork made their first contribution in https://github.com/prometheus-community/yet-another-cloudwatch-exporter/pull/1477
* @SuperQ made their first contribution in https://github.com/prometheus-community/yet-another-cloudwatch-exporter/pull/1568
* @prombot made their first contribution in https://github.com/prometheus-community/yet-another-cloudwatch-exporter/pull/1570
* @nixargh made their first contribution in https://github.com/prometheus-community/yet-another-cloudwatch-exporter/pull/1563
* @kylehodgetts made their first contribution in https://github.com/prometheus-community/yet-another-cloudwatch-exporter/pull/1580
* @vitaliyf made their first contribution in https://github.com/prometheus-community/yet-another-cloudwatch-exporter/pull/1501
* @henrylaiBrightcove made their first contribution in https://github.com/prometheus-community/yet-another-cloudwatch-exporter/pull/1544
**Full Changelog**: https://github.com/prometheus-community/yet-another-cloudwatch-exporter/compare/v0.61.2...v0.62.0
## 0.61.2 / 2024-06-25
Bugfix release to update the `goreleaser` configuration (again!), please refer to the release notes for `0.61.0` for actual code changes.
https://github.com/prometheus-community/yet-another-cloudwatch-exporter/releases/tag/v0.61.0
## 0.61.1 / 2024-06-25
Bugfix release to update the `goreleaser` configuration, please refer to the release notes for `0.61.0` for actual code changes.
https://github.com/prometheus-community/yet-another-cloudwatch-exporter/releases/tag/v0.61.0
## 0.61.0 / 2024-06-25
**Important news and breaking changes**
* This release adds support for AWS account aliases (by @thepalbi). If the role used by YACE has `"iam:ListAccountAliases"` permission, the account alias (if any) is added as a label to the `aws_account_info` metric.
**Bugfixes and features**
Features:
* Add AWS/EC2CapacityReservations to the services list by @luismy
* Add support for MediaPackage metrics by @theunissenne
* Add AWS/AppRunner as supported service by @fabiiw05
Bugs:
* Fix association with gwlb by @vainiusd
Refactoring:
* Add support for batching by time params by @kgeckhart
**Dependencies**
* Bump alpine from 3.19.1 to 3.20.1
* Bump github.com/aws/aws-sdk-go from 1.53.1 to 1.54.7
* Bump github.com/aws/aws-sdk-go-v2/service/ec2 from 1.161.4 to 1.162.0 in the aws-sdk-v2 group
* Bump github.com/prometheus/common from 0.53.0 to 0.54.0
* Bump golangci/golangci-lint-action from 5.3.0 to 6.0.1
* Bump goreleaser/goreleaser-action from 5 to 6
* Bump the aws-sdk-v2 group
**New contributors**
* @luismy made their first contribution in https://github.com/prometheus-community/yet-another-cloudwatch-exporter/pull/1341
* @fabiiw05 made their first contribution in https://github.com/prometheus-community/yet-another-cloudwatch-exporter/pull/1433
**Full Changelog**: https://github.com/prometheus-community/yet-another-cloudwatch-exporter/compare/v0.60.0...v0.61.0
## 0.60.0 / 2024-05-14
**Bugfixes and features**
Features:
* add cloudwatch log metric support by @vainiusd
* feat: add AWS/RUM as supported service by @hexionas
Bugs:
* Fix all value for function_name variable in lambda dashboard by @thepalbi
* Fix rounding period deprecation notice by @cristiangreco
Docs:
* README: update config example by @cristiangreco
* Fix ElastiCache metric namespace typo on README by @Roberdvs
Refactoring:
* getmetricdata: Move batching to an iterator by @kgeckhart
**Dependencies**
* Bump github.com/aws/aws-sdk-go from 1.51.21 to 1.53.1
* Bump github.com/aws/aws-sdk-go-v2/service/ec2 from 1.156.0 to 1.160.0
* Bump github.com/prometheus/client_golang from 1.19.0 to 1.19.1
* Bump github.com/prometheus/common from 0.52.3 to 0.53.0
* Bump github.com/urfave/cli/v2 from 2.27.1 to 2.27.2
* Bump golangci/golangci-lint-action from 4.0.0 to 5.3.0
* Bump the aws-sdk-v2 group with 13 updates
**New contributors**
* @Roberdvs made their first contribution
* @hexionas made their first contribution
**Full Changelog**: https://github.com/prometheus-community/yet-another-cloudwatch-exporter/compare/v0.59.0...v0.60.0
## 0.59.0 / 2024-04-18
**Important news and breaking changes**
This release brings a bunch of breaking changes:
* Setting `roundingPeriod` for discovery jobs is deprecated, a warning will be logged at startup. This is being deprecated in favor of always using the metric period. The implementation for `roundingPeriod` can result in inconsistent Start and EndTime between batches. This negates its intent to ensure Start and EndTimes align with the metric period for [CloudWatch best practices](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html). This has the potential to produce data which will look inaccurate when compared against CloudWatch itself driving a lot of confusion. See https://github.com/prometheus-community/yet-another-cloudwatch-exporter/issues/1290 for further context.
* Setting `delay` at the metric level is deprecated, a warning will be logged at startup. This `delay` configuration has existed for a long time but was never utilized. Deprecating it and eventually removing it was chosen to simplify the configuration. See https://github.com/prometheus-community/yet-another-cloudwatch-exporter/issues/1290#issuecomment-1948904375 for further context.
* For discovery jobs, the `type` field and the keys of `exportedTagsOnMetrics` must be the AWS namespace rather than the alias (the README contains an up-to-date list of namespaces). Aliases are not allowed anymore. An error will be thrown at startup in an invalid namespace or an alias is used.
* Some metric names have been changed to avoid duplicating the namespace. This includes:
- `aws_es_esreporting_failed_request_sys_err_count` is `aws_es_reporting_failed_request_sys_err_count`
- `aws_es_esreporting_failed_request_user_err_count` is `aws_es_reporting_failed_request_user_err_count`
- `aws_es_esreporting_request_count` is `aws_es_reporting_request_count`
- `aws_es_esreporting_success_count` is `aws_es_reporting_success_count`
- `aws_kafka_kafka_app_logs_disk_used` is `aws_kafka_app_logs_disk_used`
- `aws_kafka_kafka_data_logs_disk_used` is `aws_kafka_data_logs_disk_used`
- `aws_rds_rdsto_aurora_postgre_sqlreplica_lag` is `aws_rds_to_aurora_postgre_sqlreplica_lag`
- `aws_glue_glue_.*` is `aws_glue_.*`
These breaking changes will allow making the configuration easier to understand and less error prone, and also to build better documentation around supported services.
**Bugfixes and features**
Features:
* Add AWS/SecretsManager to the services list by @taraspos
* Support partner events buses by @HristoStoyanovYotpo
* `discovery.exportedTagsOnMetrics`: validate that keys match one of the job types defined by @cristiangreco
Refactoring:
* Update comment in factory.go by @andriikushch
* getmetricdata: move window calculator to processor by @kgeckhart
* promutil: clean up prom metric names that duplicate parts of the namespace by @tristanburgess
* promutil: rewrite sanitisation funcs for memory optimisation by @cristiangreco
* Do not allow using aliases as job types in discovery jobs by @cristiangreco
**Dependencies**
* Bump github.com/aws/aws-sdk-go from 1.51.16 to 1.51.21
* Bump github.com/aws/aws-sdk-go-v2 group
* Bump github.com/prometheus/common from 0.52.2 to 0.52.3
**New contributors**
* @taraspos made their first contribution in https://github.com/prometheus-community/yet-another-cloudwatch-exporter/pull/1330
* @HristoStoyanovYotpo made their first contribution in https://github.com/prometheus-community/yet-another-cloudwatch-exporter/pull/1359
**Full Changelog**: https://github.com/prometheus-community/yet-another-cloudwatch-exporter/compare/v0.58.0...v0.59.0
## 0.58.0 / 2024-04-06
**Bugfixes and features**
Features:
* Simplify CloudWatch API call counters by @kgeckhart
Bugs:
* Fixed issue with generated Prometheus metric name when working with AWS namespaces which have a leading special character, like `/aws/sagemaker/TrainingJobs` by @tristanburgess
Refactoring:
* Add abstraction for `GetMetricsData` processing by @kgeckhart
* `GetMetricData`: refactor QueryID generation and result mapping by @kgeckhart
* Refactored out the name-building part of `promutil.BuildNamespaceInfoMetrics()` and `promutil.BuildMetrics()` into `promutil.BuildMetricName()` by @tristanburgess
* Set initial maps size in promutil/migrate by @cristiangreco
**Dependencies**
* Bump github.com/aws/aws-sdk-go from 1.50.30 to 1.51.16
* Bump github.com/prometheus/common from 0.49.0 to 0.52.2
* Bump golang.org/x/sync from 0.6.0 to 0.7.0
* Bump the aws-sdk-v2 group with 14 updates
**New contributors**
* @tristanburgess made their first contribution in https://github.com/prometheus-community/yet-another-cloudwatch-exporter/pull/1351
**Full Changelog**: https://github.com/prometheus-community/yet-another-cloudwatch-exporter/compare/v0.57.1...v0.58.0
## 0.57.1 / 2024-03-07
**Important news and breaking changes**
* Reverted a change from 0.57.0 to fix scraping of ApiGateway resources.
**Bugfixes and features**
Bugs:
* ApiGateway: bugfix to restore FilterFunc for correct mapping of resources by @cristiangreco
**Dependencies**
## What's Changed
* Bump github.com/aws/aws-sdk-go from 1.50.26 to 1.50.30
* Bump github.com/prometheus/client_golang from 1.18.0 to 1.19.0
* Bump github.com/prometheus/common from 0.48.0 to 0.49.0
* Bump github.com/stretchr/testify from 1.8.4 to 1.9.0
* Bump the aws-sdk-v2 group
**Full Changelog**: https://github.com/prometheus-community/yet-another-cloudwatch-exporter/compare/v0.57.0...v0.57.1
# v0.57.0
**Important news and breaking changes**
* New job setting `includeContextOnInfoMetrics` can be used to include contextual information (account_id, region, and customTags) on "info" metrics and cloudwatch metrics. This can be particularly useful when cloudwatch metrics might not be present or when using "info" metrics to understand where your resources exist.
* No more need to add the `apigateway:GET` permissions for ApiGateway discovery jobs, as that API is not being used anymore.
**Bugfixes and features**
Features:
* Add serverless ElastiCache support by @pkubicsek-sb
* Add GWLB support by @vainiusd
* Add support for KMS metrics by @daharon
* Optionally include context labels (account, region, customTags) on info metrics with `includeContextOnInfoMetrics` by @kgeckhart
* Improve usability and performance of searchTags by @kgeckhart
* Add metric yace_cloudwatch_getmetricdata_metrics_total by @keyolk
Bugs:
* Fix race condition in scraper registry usage by @cristiangreco
* Restore default behaviour of returning nil/absent metrics as NaN by @nhinds
* Remove filtering of ApiGateway namespace resources by @cristiangreco
Refactoring:
* Refactor dimensions regexp usage for discovery jobs by @cristiangreco
* Simplify associator usage by @kgeckhart
* Update build tools and CI to go 1.22 by @cristiangreco
* Restructure fields on CloudwatchData by @kgeckhart
**Dependencies**
* Bump alpine from 3.19.0 to 3.19.1
* Bump github.com/aws/aws-sdk-go from 1.49.19 to 1.50.26
* Bump github.com/aws/smithy-go from 1.19.0 to 1.20.1
* Bump github.com/prometheus/common from 0.45.0 to 0.48.0
* Bump golang from 1.21 to 1.22
* Bump golangci/golangci-lint-action from 3.7.0 to 4.0.0
* Bump the aws-sdk-v2 group
**New contributors**
* @vainiusd made their first contribution in https://github.com/prometheus-community/yet-another-cloudwatch-exporter/pull/1093
* @daharon made their first contribution in https://github.com/prometheus-community/yet-another-cloudwatch-exporter/pull/1306
* @keyolk made their first contribution in https://github.com/prometheus-community/yet-another-cloudwatch-exporter/pull/939
**Full Changelog**: https://github.com/prometheus-community/yet-another-cloudwatch-exporter/compare/v0.56.0...v0.57.0
# v0.56.0
**Important news and breaking changes**
* Release v0.55.0 didn't include binaries artifact due to an issue with the release pipeline.
* The `list-metrics-callback` and `max-dimensions-associator` feature flags have been removed: their behaviour is now the new default.
**Bugfixes and features**
Features:
* Add new CloudWatch API concurrency limiter by @thepalbi
* Remove feature flag `list-metrics-callback` by @cristiangreco
* Remove feature flag `max-dimensions-associator` by @cristiangreco
* Add support for AWS/Bedrock metrics by @thepalbi
* Add support for AWS/Events by @raanand-dig
* Add support for AWS/DataSync by @wkneewalden
* Add support for AWS/IPAM by @pkubicsek-sb
Bugs:
* Remove unsupported MWAA resource filter by @matej-g
* DDoSProtection: Include regionless protectedResources in us-east-1 by @kgeckhart
* aws sdk v2: ensure region is respected for all aws clients by @kgeckhart
* SageMaker: Associator buildLabelsMap to lower case EndpointName to match ARN by @GGonzalezGomez
* Update goreleaser action by @cristiangreco
Refactoring:
* Decouple config models from internal models by @cristiangreco
* Change config Validate() signature to include model conversion by @cristiangreco
**Dependencies**
* Bump actions/setup-go from 4 to 5
* Bump alpine from 3.18.3 to 3.19.0
* Bump docker/setup-buildx-action from 2 to 3
* Bump docker/setup-qemu-action from 2 to 3
* Bump github.com/aws/aws-sdk-go from 1.45.24 to 1.49.19
* Bump github.com/aws/smithy-go from 1.17.0 to 1.19.0
* Bump github.com/prometheus/client_golang from 1.16.0 to 1.18.0
* Bump github.com/prometheus/common from 0.44.0 to 0.45.0
* Bump github.com/urfave/cli/v2 from 2.25.7 to 2.27.1
* Bump golang.org/x/sync from 0.3.0 to 0.6.0
* Bump goreleaser/goreleaser-action from 4 to 5
* Bump the aws-sdk-v2 group dependencies
**New contributors**
* @GGonzalezGomez
* @wkneewalden
* @pkubicsek-sb
**Full Changelog**: https://github.com/prometheus-community/yet-another-cloudwatch-exporter/compare/v0.55.0...v0.56.0
# v0.55.0
**Important news and breaking changes**
* jobs of type `customNamespace`, which were deprecated in `v0.51.0`, are now **un-deprecated** due to customers' feedback
* new feature flag `always-return-info-metrics`: return info metrics even if there are no CloudWatch metrics for the resource. This is useful if you want to get a complete picture of your estate, for example if you have some resources which have not yet been used.
**Bugfixes and features**
Features:
* Un-deprecate custom namespace jobs by @cristiangreco
* scrape: Return resources even if there are no metrics by @iainlane
* kinesisanalytics application: add tags support by @raanand-dig
* Add support for AWS/ClientVPN by @hc2p
* Add support for QLDB by @alexandre-alvarengazh
Bugs:
* main: Initialise logger when exiting if needed by @iainlane
Docs:
* Create sqs.yml example file by @dverzolla
Refactoring:
* Update code to go 1.21 by @cristiangreco
* aws sdk v2 use EndpointResolverV2 by @kgeckhart
* move duplicated fields from CloudwatchData to a new JobContext by @kgeckhart
**Dependencies**
* Bump github.com/aws/aws-sdk-go from 1.44.328 to 1.45.7
* Bump the aws-sdk-v2 group with 2 updates
* Bump actions/checkout from 3 to 4 by
**New Contributors**
* @raanand-dig
* @dverzolla
* @iainlane
* @hc2p
* @alexandre-alvarengazh
**Full Changelog**: https://github.com/prometheus-community/yet-another-cloudwatch-exporter/compare/v0.54.1...v0.55.0
# v0.54.1
Bugs:
* sdk v2: Set RetryMaxAttempts on root config instead client options by @kgeckhart
* Match FIPS implementation between sdk v1 and sdk v2 by @kgeckhart
* Fix regex for vpc-endpoint-service by @cristiangreco
**Dependencies**
* Bump golangci/golangci-lint-action from 3.6.0 to 3.7.0
* Bump github.com/aws/aws-sdk-go from 1.44.327 to 1.44.328
**Full Changelog**: https://github.com/prometheus-community/yet-another-cloudwatch-exporter/compare/v0.54.0...v0.54.1
# v0.54.0
**Bugfixes and features**
Features:
* Log features enabled at startup by @cristiangreco
* Use go-kit logger and add `log.format` flag by @cristiangreco
Bugs:
* Remove tagged resource requirement from TrustedAdvisor by @kgeckhart
* Fix: RDS dashboard filtering by job value by @andriikushch
* Review dimensions regexps for APIGateway by @cristiangreco
* Fix syntax in rds.libsonnet by @andriikushch
* Fix the `FilterId` label value selection for s3 dashboard by @andriikushch
* MaxDimAssociator: loop through all mappings by @cristiangreco
* MaxDimAssociator: wrap some expensive debug logs by @cristiangreco
* MaxDimAssociator: compile AmazonMQ broker suffix regex once by @cristiangreco
* Limit number of goroutines for GetMetricData calls by @cristiangreco
* Reduce uncessary pointer usage in getmetricdata code path by @kgeckhart
* Improve perf in discovery jobs metrics to data lookup by @thepalbi
* Improve FIPS endpoints resolve logic for sdk v1 by @thepalbi
Docs:
* Add more config examples (ApiGW, SES, SNS, ECS) by @cristiangreco
Refactoring:
* Refactor clients.Cache -> clients.Factory by @kgeckhart
* dependabot: use group updates for aws sdk v2 by @cristiangreco
* Add debug logging to maxdimassociator by @cristiangreco
**Dependencies**
New dependecies:
* github.com/go-kit/log v0.2.1
Updates:
* Docker image: bump alpine from 3.18.2 to 3.18.3
* Docker image: bump golang from 1.20 to 1.21
* Bump github.com/aws/smithy-go from 1.13.5 to 1.14.2
* Bump github.com/aws/aws-sdk-go and aws-sdk-go-v2 to latest versions
**Full Changelog**: https://github.com/prometheus-community/yet-another-cloudwatch-exporter/compare/v0.53.0...v0.54.0
# v0.53.0
**Bugfixes and features**
Services:
* Add Auto Discovery Support For Sagemaker by @charleschangdp
* Add support for AWS/TrustedAdvisor by @cristiangreco
Bugs:
* fix(kafkaconnect): update resource filter by @cgowthaman
* Validate should fail when no roles are configured by @thepalbi
* Fix default value for nilToZero and addCloudwatchTimestamp in static job by @cristiangreco
* ddos protection: Discover resources outside us-east-1
**Dependencies**
* Bump github.com/aws/aws-sdk-go from 1.44.284 to 1.44.290
* Bump github.com/aws/aws-sdk-go-v2/service/amp from 1.16.12 to 1.16.13
* Bump github.com/aws/aws-sdk-go-v2/service/apigatewayv2 from 1.13.12 to 1.13.13
* Bump github.com/aws/aws-sdk-go-v2/service/cloudwatch from 1.26.1 to 1.26.2
* Bump github.com/aws/aws-sdk-go-v2/service/ec2 from 1.100.0 to 1.102.0
* Bump github.com/prometheus/client_golang from 1.15.1 to 1.16.0
* Bump github.com/prometheus/common from 0.43.0 to 0.44.0
* Bump github.com/urfave/cli/v2 from 2.25.6 to 2.25.7
**Full Changelog**: https://github.com/prometheus-community/yet-another-cloudwatch-exporter/compare/v0.52.0...v0.53.0
# v0.52.0
**Important news and breaking changes**
This releases introduces the feature flag `aws-sdk-v2` (by @kgeckhart), which changes YACE networking layer to use the AWS sdk v2 package. Read on for more details and considerations.
* The main benefit of sdk v2 is deserialization/serialization is done via code generation vs reflection which drastically lowers memory/cpu usage for large scrape jobs
* Considerations before enabling sdk v2:
1. FIPS is not supported in v2 as v2 delegates all URL resolution to the sdk and AWS does not have FIPS compliant endpoints for AutoScaling API and Tagging API. The v1 implementation worked around this by hard coding FIPS URLs where they existed and using non-FIPS URLs otherwise. This work around was not ported to v2 and is unlikely to be ported.
2. sdk v2 uses regional sts endpoints by default vs global sts which is [considered legacy by aws](https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html). The `sts-region` job configuration is still respected when setting the region for sts and will be used if provided. If you still require global sts instead of regional set the `sts-region` to `aws-global`.
**Bugfixes and features**
Features:
* Discovery jobs support `recentlyActiveOnly` parameter to reduce number of old metrics returned by CloudWatch API by @PerGon
* Feature flag `aws-sdk-v2`: use the more performant AWS sdk v2 (see above section) by @kgeckhart
Services:
* Add support for API Gateway V2 by @matej-g
* Add support for MediaConvert by @theunissenne
* Add support for CWAgent by @cristiangreco
* Add support for memorydb by @glebpom
Docs:
* ALB example: use Average for ConsumedLCUs by @cristiangreco
* Update configuration.md: deprecated custom namespace jobs by @wimsymons
* Update permissions examples and docs in readme by @kgeckhart
* Add example for ElastiCache by @cristiangreco
* Update mixin readme by @cristiangreco
Bugs:
* Fix AmazonMQ Broker name dimension match by @cristiangreco
* Fix invalid GH action file and broken test case by @cristiangreco
* Fix namespace case in metrics conversion by @cristiangreco
* Make exporter options a non-global type by @kgeckhart
* Fix debug logging in discovery jobs by @cristiangreco
Refactoring:
* Refactor AWS sdk client usage to hide behind new ClientCache by @kgeckhart
* Introduce model types to replace sdk types in cloudwatch client by @kgeckhart
**Dependencies**
New dependencies:
* github.com/aws/aws-sdk-go-v2/config 1.18.27
* github.com/aws/aws-sdk-go-v2/service/amp 1.16.11
* github.com/aws/aws-sdk-go-v2/service/apigateway 1.13.13
* github.com/aws/aws-sdk-go-v2/service/autoscaling 1.28.9
* github.com/aws/aws-sdk-go-v2/service/cloudwatch 1.26.1
* github.com/aws/aws-sdk-go-v2/service/databasemigrationservice 1.25.7
* github.com/aws/aws-sdk-go-v2/service/ec2 1.100.0
* github.com/aws/aws-sdk-go-v2/service/resourcegroupstaggingapi 1.14.14
* github.com/aws/aws-sdk-go-v2/service/storagegateway 1.18.14
Updates:
* Bump alpine from 3.17.3 to 3.18.2
* Bump github.com/aws/aws-sdk-go from 1.44.249 to 1.44.284
* Bump github.com/prometheus/common from 0.42.0 to 0.43.0
* Bump github.com/sirupsen/logrus from 1.9.0 to 1.9.3
* Bump github.com/stretchr/testify from 1.8.2 to 1.8.4
* Bump github.com/urfave/cli/v2 from 2.25.1 to 2.25.6
* Bump golang.org/x/sync from 0.1.0 to 0.3.0
* Bump golangci/golangci-lint-action from 3.4.0 to 3.6.0
**Full Changelog**: https://github.com/prometheus-community/yet-another-cloudwatch-exporter/compare/v0.51.0...v0.52.0
# v0.51.0
**Important breaking changes**
* Jobs of type `customNamespace` are **deprecated** and might be removed in a future release (please reach out if you're still using this feature)
**Bugfixes and features**
Features:
* Add feature flags support by @thepalbi
* Feature flag `max-dimensions-associator`: new resource-matching algorithm for discovery jobs. It fixes metrics attribution for ECS. Please test it out and report any issue!
* Feature flag `list-metrics-callback`: reduce memory usage of ListMetrics API requests
Services:
* Add support for AWS/Usage namespace by @cristiangreco
* Fix ECS regexes by @cristiangreco
Docs:
* Add docker compose support for easier development by @thepalbi
* Add more config examples by @cristiangreco
* Review docs about embedding yace by @cristiangreco
Bugs:
* Fix for Dockerfile smell DL3007 by @grosa1
Refactoring:
* Refactor Tagging/CloudWatch clients by @cristiangreco
* CloudWatch client: split out input builders into separate file by @cristiangreco
* Refactor promutils migrate functions by @cristiangreco
* Use grafana/regexp by @cristiangreco
* Refactor implementation of getFilteredMetricDatas by @cristiangreco
* Remove uneeded Describe implementation by @kgeckhart
* Add counter to see if duplicate metrics are still a problem by @kgeckhart
* Refactor label consistency and duplicates by @kgeckhart
* Refactor GetMetricData calls in discovery jobs by @cristiangreco
**Dependencies**
* Bump github.com/aws/aws-sdk-go from 1.44.235 to 1.44.249
* Bump github.com/prometheus/common from 0.41.0 to 0.42.0
**Full Changelog**: https://github.com/prometheus-community/yet-another-cloudwatch-exporter/compare/v0.50.0...v0.51.0
# v0.50.0
**Important breaking changes**
* Change `UpdateMetrics` signature to accept options and return error by @cristiangreco -- if you embed YACE as a Go library this is a breaking change.
**Bugfixes and features**
Features:
* Refactor API clients concurrency handling by @cristiangreco
* Add feature flags support by @thepalbi
* Allow discovery jobs to return result even if there are no resources by @kgeckhart
* Add flag to enable pprof profiling endpoints by @cristiangreco
Services:
* Add a ResourceFilter to ElasticBeanstalk by @benbridts
Docs:
* Update config docs format by @cristiangreco
Refactoring:
* Linting: fix revive issues by @cristiangreco
* Remove extra error log when no resources are found by @kgeckhart
* Wrap debug logging in FilterMetricData by @cristiangreco
* Minor internal refactorings by @cristiangreco
**Dependencies**
* Bump actions/setup-go from 3 to 4
* Bump github.com/aws/aws-sdk-go from 1.44.215 to 1.44.235
* Bump github.com/urfave/cli/v2 from 2.25.0 to 2.25.1
**Full Changelog**: https://github.com/prometheus-community/yet-another-cloudwatch-exporter/compare/v0.49.2...v0.50.0
# v0.49.2
## Bugfixes and features
* Update release action to use goreleaser docker image v1.16.0
# v0.49.1
## Bugfixes and features
* Update release action to use Go 1.20
# v0.49.0
## Important breaking changes
* From now on we're dropping the `-alpha` suffix from the version number. YACE will be considered alpha quality until v1.0.0.
* The helm chart is now hosted at https://github.com/nerdswords/helm-charts, please refer to the instructions in the new repo.
## Bugfixes and features
Helm chart:
* Move helm chart out of this repo by @cristiangreco
* Update helm repo link in README.md by @cristiangreco
New services:
* Add support for Container, queue, and database metrics for MWAA by @millin
* Add support for acm-pca service by @jutley
Docs updates:
* Docs review: move "install" and "configuration" in separate docs by @cristiangreco
* Docs: Fix example config link by @matej-g
* Add example config files by @cristiangreco
Internal refactoring:
* Code refactoring: split out job and api code by @cristiangreco
* Minor refactoring of pkg/apicloudwatch and pkg/apitagging by @cristiangreco
* Refactor CW metrics to resource association logic and add tests by @thepalbi
* Wrap service filter errors by @kgeckhart
## Dependencies
* Bump github.com/aws/aws-sdk-go from 1.44.194 to 1.44.215
* Bump github.com/prometheus/common from 0.37.0 to 0.41.0
* Bump github.com/stretchr/testify from 1.8.1 to 1.8.2
* Bump github.com/urfave/cli/v2 from 2.24.3 to 2.25.0
* Bump golang.org/x/sync from 0.0.0-20220722155255-886fb9371eb4 to 0.1.0
**Full Changelog**: https://github.com/prometheus-community/yet-another-cloudwatch-exporter/compare/v0.48.0-alpha...v0.49.0
# v0.48.0-alpha
**Bugfixes and features**:
* Revert "Publish helm chart before releasing binaries".
**Full Changelog**: https://github.com/prometheus-community/yet-another-cloudwatch-exporter/compare/v0.47.0-alpha...v0.48.0-alpha
# v0.47.0-alpha
**Bugfixes and features**:
* Add Elemental MediaLive, MediaConnect to supported services by @davemt
* Add support for OpenSearch Serverless by @Hussainoxious
* Makefile: always add build version ldflags by @cristiangreco
* Publish helm chart before releasing binaries by @cristiangreco
* Build with Go 1.20 by @cristiangreco
**Dependencies**:
* Bump github.com/aws/aws-sdk-go from 1.44.192 to 1.44.194
* Bump github.com/urfave/cli/v2 from 2.24.2 to 2.24.3
**Full Changelog**: https://github.com/prometheus-community/yet-another-cloudwatch-exporter/compare/v0.46.0-alpha...v0.47.0-alpha
## 0.46.0-alpha / 2023-02-02
**Breaking changes**:
- If you use Yace as a library: this release changes the package
name `pkg/logger` to `pkg/logging`.
**Bugfixes and features**:
* Fix to set logging level correctly by @cristiangreco
* ct: disable validate-maintainers by @cristiangreco
**Dependencies**:
* Bump github.com/aws/aws-sdk-go from 1.44.189 to 1.44.192
**Full Changelog**: https://github.com/prometheus-community/yet-another-cloudwatch-exporter/compare/helm-chart-0.11.0...v0.46.0-alpha
## 0.45.0-alpha / 2023-01-30
**Breaking changes**:
- Note if you use Yace as a library: this release changes the signature
of `config.Load` method.
**Bugfixes and features**:
* Helm chart update to customize port name by @nikosmeds
* Clear up docs and re-organize sections by @thepalbi
* Helm: add README file template by @cristiangreco
* Config parsing: emit warning messages for invalid configs by @cristiangreco
* Pre-compile dimensions regexps for supported services by @cristiangreco
* AWS/DX: add more dimension regexps by @cristiangreco
**Dependencies**:
* Bump github.com/aws/aws-sdk-go from 1.44.182 to 1.44.189
* Bump github.com/urfave/cli/v2 from 2.23.7 to 2.24.2
* Bump golangci/golangci-lint-action from 3.3.1 to 3.4.0
**Full Changelog**: https://github.com/prometheus-community/yet-another-cloudwatch-exporter/compare/v0.44.0-alpha...v0.45.0-alpha
## 0.44.0-alpha / 2023-01-23
**Breaking changes**:
- Note if you use Yace as a library: this release changes the packages
and funcs exported publicly, you will need to review the imports
(although signatures are mostly unchanged)
**Bugfixes and features**:
* Refactor code into separate packages by @cristiangreco
* Refactor list of supported services and filter funcs by @cristiangreco
* Wrap debug logging to avoid expensive operations by @cristiangreco
* Fix to use length of metrics level on customNamespace by @masshash
* feat: bump helm chart by @rasta-rocket
* feat: release helm chart when Chart.yml is updated by @rasta-rocket
* Add test for configuration of services list by @cristiangreco
* GolangCI: review linters settings by @cristiangreco
**Dependencies**:
* Bump azure/setup-helm from 1 to 3
* Bump docker/setup-buildx-action from 1 to 2
* Bump docker/setup-qemu-action from 1 to 2
* Bump github.com/aws/aws-sdk-go from 1.44.175 to 1.44.182
* Bump github.com/prometheus/client_golang from 1.13.0 to 1.14.0
* Bump helm/chart-releaser-action from 1.4.1 to 1.5.0
* Bump helm/kind-action from 1.2.0 to 1.5.0
**Full Changelog**: https://github.com/prometheus-community/yet-another-cloudwatch-exporter/compare/v0.43.0-alpha...v0.44.0-alpha
## 0.43.0-alpha / 2023-01-02
* add support to custom namespaces with their dimensions (by @arielly-parussulo)
* Optimise support for custom namespaces to use GetMetricData API (by @code-haven)
* GH workflows: run "publish" workflows only in this repo. (by @cristiangreco)
* Bump Go version to 1.19 for CI and docker image. (by @cristiangreco)
* Fix not to refer to loop variable in a goroutine (by @masshash)
* Validate tags when converting to prometheus labels (by @cristiangreco)
* Bump github.com/aws/aws-sdk-go from 1.44.127 to 1.44.167
* Bump golangci/golangci-lint-action from 3.3.0 to 3.3.1
* Bump github.com/urfave/cli/v2 from 2.23.0 to 2.23.7
## 0.42.0-alpha / 2022-11-03
* Resolve logging issue (@datsabk)
* MediaTailor - Correct dimension regex for MT (@scott-mccracken)
* Helm chart update for optional test-connection pod (@nikosmeds)
* Helm chart update to set priorityClassName (@nikosmeds)
* Bump github.com/aws/aws-sdk-go from 1.44.122 to 1.44.127
* Bump github.com/urfave/cli/v2 from 2.20.3 to 2.23.0
## 0.41.0-alpha / 2022-10-27
* Clean up unused variables. (@cristiangreco)
* Fix typo: sts-endpoint should be sts-region. (@cristiangreco)
* Enabled Managed prometheus metrics (@datsabk)
* Add support for AWS Kafka Connect (@cgowthaman)
* Import CloudWatch mixin. (@jeschkies)
* main.go refactoring: define cmd action as a separate func. (@cristiangreco)
* Add support for EMR Serverless (@cgowthaman)
## 0.40.0-alpha / 2022-09-15
* Fix typo in Charts.yml (@yasharne)
* Subcommand `verify-config` actually validates the config file. (@cristiangreco)
* Add dimensions regex for AmazonMQ. (@cristiangreco)
* Fix metrics with additional dimensions being not being scraped. (@cristiangreco)
* Remove unused code, add test for RemoveDuplicateMetrics. (@cristiangreco)
* Bump github.com/sirupsen/logrus
* Bump github.com/urfave/cli/v2
* Bump github.com/aws/aws-sdk-go
* Bump actions/setup-python
## 0.39.0-alpha / 2022-09-08
* Improve code quality and unblock this release (cristiangreco)
* Add helm chart (vkobets)
* Fix DX metrics (paulojmdias)
* Fix searchTags and bad dimension name (femiagbabiaka)
* Handle empty list in filter metric tests (mtt88)
* Add AWS Elemental MediaTailor support (scott-mccracken)
* Support storagegateway metrics (sedan07)
* Filter api gateway resources to skip "stages" (ch4rms)
* Bump aws-sdk, urfave/cli, prometheus/client_golang
## 0.38.0-alpha / 2022-07-13
* Set max page size for tagging API requests (#617)
* Build with Go 1.18
## 0.37.0-alpha / 2022-07-05
* New config `dimensionNameRequirements` allows autodiscovery jobs to only
fetch metrics that include specified dimensions (jutley)
* Update deps
## 0.36.2-alpha / 2022-06-29
* Cost Reduction - Use less API requests if no tagged resources are found (cristiangreco)
* Update deps
## 0.36.1-alpha / 2022-06-22
* Use structured logs for logging interface (kgeckhart)
## 0.36.0-alpha / 2022-06-20
* *BREAKING CHANGE FOR LIBRARY USERS* Major refactoring of usage of logging library (kgeckhart)
* Minor update of deps and security patches (urfave/cli/v2, golangci/golangci-lint-action, github.com/prometheus/client_golang, github.com/stretchr/testify, github.com/aws/aws-sdk-go
* Updates of Readme (markwallsgrove)
## 0.35.0-alpha / 2022-04-26
* Update dependencies
* Improve / Document way how to use the exporter as external library (kgeckhart)
* Refactor label consistency (kgeckhart)
* Add suppot for vpc-endpoint (AWS/PrivateLinkEndpoints) (aleslash)
* Add support for vpc-endpoint-service (AWS/PrivateLinkServices) (aleslash)
## 0.34.0-alpha / 2022-03-26
* Update dependencies
* Add weekly dependabot updates (jylitalo)
* Add support for regional sts endpoints (matt-mercer)
* Add multi-arch docker build (charlie-haley)
New services
* Add global accelerator support (charlie-haley)
* Add AppStream support (jhuesemann)
* Add Managed Apache Airflow support (sdenham)
* Add KinesisAnalytics support (gumpt)
Bug Fixes
* Fix targetgroup arn lookup (domcyrus)
* Fix WorkGroup Dimension are not showing in Athena Metrics (sahajavidya)
* Improve regex performance (kgeckhart)
* Fix prometheus reload causing a goroutine leak (gumpt / cristiangreco)
Docs
* Added help for new contributors (aleslash)
## 0.33.0-alpha / 2021-12-10
* Add /healthz route which allows to deploy more secure with helm (aleslash)
* Read DMS replication instance identifier from the DMS API (nhinds)
## 0.32.0-alpha / 2021-11-19
* [BREAKING] Fix the calculation of start and end times for GetMetricData (csquire)
```
floating-time-window is now replaced with roundingPeriod
Specifies how the current time is rounded before calculating start/end times for CloudWatch GetMetricData requests. This rounding is optimize performance of the CloudWatch request. This setting only makes sense to use if, for example, you specify a very long period (such as 1 day) but want your times rounded to a shorter time (such as 5 minutes). to For example, a value of 300 will round the current time to the nearest 5 minutes. If not specified, the roundingPeriod defaults to the same value as shortest period in the job.
```
* Improve testing / linting (cristiangreco)
* Verify cli parameters and improve cli parsing (a0s)
* Allow to configure yace cli parameters via env variables (a0s)
* Improve error handling of cloudwatch (matthewnolf)
* Add support for directconnect and route53 health checks
* Improve throttling handling to AWS APIs (anilkun)
* Add issue templates to improve support (NickLarsenNZ)
* Allow setting default values for statistics (surminus)
* Fix apigateway method and resouce dimension bug (aleslash)
Thanks a lot to all contributors! - Lovely to see so much efforts especially in testing
to get this project more and more stable. - I know we are far away from a nice tested
code base but we are improving in the right direction and I really love to see all
of your efforts there. It is really appreciated from my side.
I just contacted AWS to get some open source credits so we can build some kind of
end to end tests. This shoud allow us to find tricky bugs earlier and not only when we ship
things.
Love to all of you, Thomas!
## 0.31.0-alpha / 2021-09-23
* [BREAKING] Decoupled scraping is now default. Removed code which allowed to use scraper without it.
```
# Those flags are just ignored
-decoupled-scraping=false
-decoupled-scraping=true
```
* [BREAKING] Small timeframes of scraping can be used again now. In the past yace decided the scraping
interval based on config. This magic was removed for simplicity.
```
# In the past this would have in some cases still set --scraping-interval 600
--scraping-interval 10
# Now it really would scrape every 10 seconds which could introduce big API costs. So please watch
# your API requests!
--scraping-interval 10
```
* Fix problems with start/endtime of scrapes (klarrio-dlamb)
* Add support for Database Migration Service metrics
* Allow to hotreload config via /reload (antoniomerlin)
## 0.30.1-alpha / 2021-09-13
* *SECURITY* Fix issue with building binaries. Please update to mitigate (https://nvd.nist.gov/vuln/detail/CVE-2020-14039)
* Thanks jeason81 for reporting this security incident!
## 0.30.0-alpha / 2021-09-07
* *BREAKING* Introduce new version field to config file (jylitalo)
```
# Before
discovery:
jobs:
# After
apiVersion: v1alpha1
discovery:
jobs:
```
* [BUG] Fix issues with nilToZero (eminugurkenar)
* [BUG] Fix race condition setting end time for discovery jobs (cristiangreco)
* Simplify session creation code (jylitalo)
* Major improvement of aws discovery code (jylitalo)
* Major rewrite of the async scraping logic (rabunkosar-dd)
* Add support for AWS/ElasticBeanstalk (andyzasl)
* Upgrade golang to 1.17
* Upgrade golang libraries to newest versions
## 0.29.0-alpha / 2021-09-01
Okay, private things settled. We have a new organisation for
the project. Lets boost it and get the open PRs merged!
This version is like 0.28.0-alpha but docker images hosted on ghcr.io
and published via new github organisation nerdswords. Find
details [here](https://medium.com/@IT_Supertramp/reorganizing-yace-79d7149b9584).
Thanks to all there waiting and using the product! :)
- *BREAKING CHANGE* Using a new docker registry / organisation:
```yaml
# Before
quay.io/invisionag/yet-another-cloudwatch-exporter:v0.29.0-alpha
# Now
ghcr.io/nerdswords/yet-another-cloudwatch-exporter:v0.29.0-alpha
```
## 0.28.0-alpha / 2021-07-09
Sorry folks, I currently struggle a little bit
to get things merged fast due to a lot of private
stuff. Really appreciate all your PRs and
hope to get the bigger ones (which are sadly
still not merged yet) into next release.
Really appreciate any person working on this
project! - Have a nice day :)
- *BREAKING CHANGE* Added support for specifying an External ID with IAM role Arns (cristiangreco)
```yaml
# Before
discovery:
jobs:
- type: rds
roleArns:
- "arn:aws:iam::123456789012:role/Prometheus"
# After
discovery:
jobs:
- type: rds
roles:
- roleArn: "arn:aws:iam::123456789012:role/Prometheus"
externalId: "shared-external-identifier" # optional
```
- Add alias for AWS/Cognito service (tohjustin)
- Fix logic in dimensions for Transit Gateway Attachments (rhys-evans)
- Fix bug with scraping intervals (boazreicher)
- Support arm64 builds (alias-dev)
- Fix IgnoreLength logic (dctrwatson)
- Simplify code base (jylitalo)
- Simplify k8s deployments for new users (mahmoud-abdelhafez)
- Handle metrics with '%' in their name (darora)
- Fix classic elb name (nhinds)
- Skip metrics in edge cases (arvidsnet)
Freshly shipped new integrations:
- Certificate Manager (mksh)
- WorkSpaces (kl4w)
- DDoSProtection / Shield (arvidsnet)
## 0.27.0-alpha / 2021-05-07
- Make exporter a library. (jeschkies)
- Add CLI option to validate config file (zswanson)
- Fix multidimensional static metric (nmiculinic)
- Fix scrapes running in EKS fail after first scrape (rrusso1982)
- Fix Docker build (jeschkies)
- Allow to use this project in China (insectme)
- Fix error retrieving kafka metrics (friedrichg)
Freshly integrated:
- Add AWS/NetworkFirewall (rhys-evans)
- Add AWS/Cassandra (bjhaid)
- Add AWS/AmazonMQ (saez0pub)
- Add AWS/Athena (haarchri)
- Add AWS/Neptune (benjaminaaron)
Thanks to doc fixes: calvinbui
## 0.26.3-alpha / 2021-03-15
## 0.26.2-alpha / 2021-03-15
- Fix CI issue
## 0.26.0-alpha / 2021-03-15
- *BREAKING CHANGE* Removed a need to use static dimensions in dynamic jobs in cases, when they cannot be parsed from ARNs (AndrewChubatiuk)
```
# Before
metrics:
- name: NumberOfObjects
statistics:
- Average
additionalDimensions:
- name: StorageType
value: AllStorageTypes
# After
metrics:
- name: NumberOfObjects
statistics:
- Average
```
* *BREAKING CHANGE* Use small case for searchTags config option (AndrewChubatiuk)
```
# Before
searchTags:
- Key: type
Value: public
# After
searchTags:
- key: type
value: public
```
* *BREAKING CHANGE* CloudFront renamed from `cf` to `cloudfront`
```
# Before
- type: cf
# After
- type: cloudfront
```
- Added regular expressions to parse dimensions from resources (AndrewChubatiuk)
- Added option to use floating time windows (zqad)
- Added CLI option to validate config file (zswanson)
- Added AWS network Firewall (rhys-evans)
- Fixed multidimensional static metric (nmiculinic)
- Tidy up code (jylitalo)
## 0.25.0-alpha / 2021-01-05
- *BREAKING CHANGE* Use NaN as default if AWS returns nil (arnitolog)
- Add autodiscovery for AWS/EC2Spot (singhjagmohan1000)
- Add autodiscovery for DocumentDB (haarchri)
- Add autodiscovery for GameLift (jp)
- Added support for fips compliant endpoints (smcavallo)
- Update deps and build with golang 1.15 (smcavallo)
## 0.24.0-alpha / 2020-12-07
- Add API Gateway IAM info to README (Botono)
- Fix sorting of datapoints, add test util functions (Botono)
- Fix missing DataPoints and improve yace in various ways (vishalraina)
- Added Github action file to basic validation of incoming PR (vishalraina)
- Fix info metrics missing (goya)
- Add rds db clusters (goya)
- Fix missing labels (goya)
## 0.23.0-alpha / 2020-10-02
- Add sampleCount statistics (udhos)
- Add WAFv2 support (mksh)
## 0.22.0-alpha / 2020-10-02
- Fix alb issues (reddoggad)
- Add nlb support (reddoggad)
## 0.21.0-alpha / 2020-09-21
- Big tidy up of code, remove old methods and refactor used ones (jylitalo)
- Fix crashes where labels are not collected correctly (rrusso1982)
- Fix pointer bug causing metrics to be missing (jylitalo)
- Allow more then 25 apigateways to be discovered (udhos)
## 0.20.0-alpha / 2020-07-31
- Add api-gateway support (smcavallo)
- Improve metrics validation (jylitalo)
- Fix metrics with '<', '>' chars
## 0.19.1-alpha / 2020-07-17
- Remove error during build
## 0.19.0-alpha / 2020-07-17
Wow what a release. Thanks to all contributors. This is
our biggest release and it made me a lot of fun to see all those
contributions. From small doc changes (love those) to major rewrites
of big components or new complex features. Thanks!
* *BREAKING CHANGE* Add support for multiple roleArns (jylitalo)
```yaml
# Before
---
discovery:
jobs:
- type: rds
roleArn: "arn:aws:iam::123456789012:role/Prometheus"
# After
discovery:
jobs:
- type: rds
roleArns:
- "arn:aws:iam::123456789012:role/Prometheus"
```
* Upgrade golang from 1.12 to 1.14
* Major linting of code and improving global code quality. (jylitalo)
* Improve logging (jylitalo)
* Add config validation. (daviddetorres)
* Added support for tags with '@' char included (afroschauer )
* Added Transit Gateway Attachment Metrics (rhys-evans)
* Fix information gathering if no data is retrieved by cloudwatch (daviddetorres)
* Improve docs (calvinbui)
* Add redshift support (smcavallo)
* Allow easier configuration through adding period / addCloudwatchTimestamp setting additionally
to job level. (rrusso1982)
* Add initial unit tests (smcavallo)
* Add new configuration to allow snake case labels (rrusso1982)
* Fix complex metric dimension bug (rrusso1982)
* Upgrade golang packages (smcavallo)
* Set up correct partition for ASG for AWS China and GovCloud Regions (smcavallo)
* Add ability to set custom tags to discovery job metrics (goya)
## 0.18.0-alpha / 2020-06-15
* *BREAKING CHANGE* Add support for multiple regions (goya)
```yaml
# Before
---
discovery:
jobs:
- type: rds
region: eu-west-1
# After
discovery:
jobs:
- type: rds
regions:
- eu-west-1
```
* Fix missing alb target group metrics (abhi4890 )
* Added support for step functions (smcavallo)
## 0.17.0-alpha / 2020-05-14
* Added support for sns / firehose (rhys-evans)
* Added support for fsx / appsync (arnitolog)
## 0.16.0-alpha / 2020-04-06
* Hugh rewrite: Decouple scraping and serving metrics. Thanks so much daviddetorres!
* *BREAKING CHANGE* Decoupled scraping and set scraping interval to 5 minutes.
```
The flag 'decoupled-scraping' makes the exporter to scrape Cloudwatch metrics in background in fixed intervals, in stead of each time that the '/metrics' endpoint is fetched. This protects from the abuse of API requests that can cause extra billing in AWS account. This flag is activated by default.
If the flag 'decoupled-scraping' is activated, the flag 'scraping-interval' defines the seconds between scrapes. Its default value is 300.
```
* Hugh rewrite: Rewrite of metric gathering to reduce API Limit problems. Thanks so much daviddetorres!
* Improvment of ALB data gathering and filtering (daviddetorres)
* Detect and fix bug after merge (deanrock)
* Add cloudfront support (mentos1386)
## 0.15.0-alpha / 2020-02-21
* Fixed docker run command in README.md (daviddetorres)
* Added support for Nat Gateway / Transit Gateway / Route 53 Resolver (j-nix)
* Added support for ECS/ContainerInsights (daviddetorres)
* Fix pagination for getMetricList (eminugurkenar)
## 0.14.7-alpha / 2020-01-09
* Change logging to json format (bheight-Zymergen)
## 0.14.6-alpha / 2020-01-03
* Add support for kafka (eminugurkenar)
* Add structured json logging (bheight-Zymergen)
* Increase code readability (bheight-Zymergen)
* Fix ecs scraping bug (rabunkosar-dd)
* Fix aws cloudwatch period bug (rabunkosar-dd)
## 0.14.5-alpha / 2019-10-29
* Fix sts api calls without specifying a region (nhinds)
* Update aws-sdk to v1.25.21 (nhinds)
## 0.14.4-alpha / 2019-10-25
* Fix github actions (nhinds)
* Update aws-sdk-go (deanrock)
* Avoid appending to a shared dimensions variable from inside a loop (nhinds)
* Remove hardcoded StorageType dimension from S3 metric (nhinds)
## 0.14.3-alpha / 2019-10-11
* Fix problems and crashes with ALBs and ELBs (Deepak1100)
## 0.14.2-alpha / 2019-10-04
* **BREAKING** Changing user in Docker image to be non root to adhere to potential security requirements. (whitlekx)
* Fix prometheus metric bug with new services with '-' e.g. ecs-svc.
## 0.14.1-alpha / 2019-09-06
* Was accidentally with code from 01.14.0-alpha released.
## 0.14.0-alpha / 2019-08-24
* **BREAKING** Default command in Dockerfile is changed to yace. This removes the need to add yace as command.
```yaml
# Before
command:
- "yace"
- "--config.file=/tmp/config.yml"
# After
args:
- "--config.file=/tmp/config.yml"
```
* Add support for Elastic MapReduce (nhinds)
* Add support for SQS - (alext)
* Add support for ECS Services as ecs-svc
* Add support for NLB
* Add retries to cloudwatch api calls (Deepak1100)
* Fix dimension labels for static jobs (alext)
## 0.13.7 / 2019-07-09
* Add region as exported label to metrics
## 0.13.6 / 2019-06-24
* Fix errors with "=" in tags (cdchris12)
* Add curl to container for easy debugging (cdchris12)
## 0.13.5-alpha / 2019-06-09
* Limit concurrency of aws calls
## 0.13.4 / 2019-06-03
* Add Autoscaling group support (wjam)
* Fix strange AWS namespace bug for static exports (AWS/EC2/API)
* Add warning if metric length of less than 300s is configured / Interminent metrics
## 0.13.3 / 2019-04-26
* Fix ALB problems. Target Group metrics are now exported as aws_albtg
```
aws_albtg_request_count_sum{dimension_LoadBalancer="app/Test-ALB/fec38de4cf0cacb1",dimension_TargetGroup="targetgroup/Test/708ecba11979327b",name="arn:aws:elasticloadbalancing:eu-west-1:237935892384916:targetgroup/Test/708dcba119793234"} 0
```
## 0.13.2 / 2019-04-26
* CI problem
## 0.13.1-alpha / 2019-04-03
* **BREAKING** For some metrics `cloudwatch:ListMetrics` iam permissions are needed. Please update your role!
* **BREAKING** Add 'v' to indicate it is a version number in docker tag / version output
```
# Before
image: quay.io/invisionag/yet-another-cloudwatch-exporter:0.13.0
# After
image: quay.io/invisionag/yet-another-cloudwatch-exporter:v0.13.0
```
* Use golang 1.12.0 to build
* Use goreleaser to release
* Update aws dependencies
* Use github actions as CI
* Migrate dependency management to golang modules
## 0.13.0-alpha / 2019-03-18
* **BREAKING** For some metrics `cloudwatch:ListMetrics` iam permissions are needed. Please update your role!
* **BREAKING** As adding cloudwatch timestamp breaks some metrics I decided to not set it as default anymore.
This should make it easier for new users to have fun with this project.
It fixes for some users `non-histogram and non-summary metrics should not have "_sum" suffix` bug.
```yaml
# Before
metrics:
- name: FreeStorageSpace
disableTimestamp: true
# After
metrics:
- name: FreeStorageSpace
# Before
metrics:
- name: FreeStorageSpace
# After
metrics:
- name: FreeStorageSpace
useCloudwatchTimestamp: true
```
* Add ability to specify additional dimensions on discovery jobs e.g. for BucketSizeBytes metrics on S3 (abuchananTW)
* Fix incorrect dimension value in case of alb in discovery config (GeeksWine)
* Add CLI command to debug output
* Add DynamoDB support
## 0.12.0 / 2019-02-04
* **BREAKING** Add the exact timestamps from CloudWatch to the exporter Prometheus metrics (LeePorte)
* Add a new option `disableTimestamp` to not include a timestamp for a specific metric (it can be useful for sparse metrics, e.g. from S3) (LeePorte)
* Add support for kinesis (AndrewChubatiuk)
## 0.11.0 / 2018-12-28
* **BREAKING** Add snake_case to prometheus metrics (sanchezpaco)
```yaml
# Before
aws_elb_requestcount_sum
# After
aws_elb_request_count_sum
```
* Add optional delay setting to scraping (Deepak1100)
```yaml
period: 60
length: 900
delay: 300
```
## 0.10.0 / 2018-12-03
* Reduce usage of listMetrics calls (nhinds)
* Add support of iam roles (nhinds)
* Add optional roleArn setting, which allows scraping with different roles e.g. pull data from mulitple AWS accounts using cross-acount roles (nhinds)
```yaml
metrics:
- name: FreeStorageSpace
roleArn: xxx
statistics:
- 'Sum'
period: 600
length: 60
```
## 0.9.0 / 2018-11-16
* Add lambda support (nhinds)
* Fix support for listing multiple statistics per metric (nhinds)
* Add tag labels on metrics for easy querying (nhinds)
```
# Before
aws_ec2_cpuutilization_average + on (name) group_left(tag_Name) aws_ec2_info
# After, now name tags are on metrics and no grouping needed
aws_ec2_cpuutilization_average
```
* **BREAKING** Change config syntax. Now you can define tags which are exported as labels on metrics.
Before:
```yaml
discovery:
- region: eu-west-1
type: "es"
searchTags:
- Key: type
Value: ^(easteregg|k8s)$
metrics:
- name: FreeStorageSpace
statistics:
- 'Sum'
period: 600
length: 60
```
New Syntax with optional exportedTagsOnMetrics:
```yaml
discovery:
exportedTagsOnMetrics:
ec2:
- Name
jobs:
- region: eu-west-1
type: "es"
searchTags:
- Key: type
Value: ^(easteregg|k8s)$
metrics:
- name: FreeStorageSpace
statistics:
- 'Sum'
period: 600
length: 60
```
## 0.8.0 / 2018-11-02
* Added VPN connection metrics (AndrewChubatiuk)
* Added ExtendedStatistics / percentiles (linefeedse)
* Added Average Statistic (AndrewChubatiuk)
## 0.7.0-alpha / 2018-10-19
* ALB Support (linefeedse)
* Custom lables for static metrics
Example
```yaml
static:
- namespace: AWS/AutoScaling
region: eu-west-1
dimensions:
- name: AutoScalingGroupName
value: Test
customTags:
- Key: CustomTag
Value: CustomValue
metrics:
- name: GroupInServiceInstances
statistics:
- 'Minimum'
period: 60
length: 300
```
## 0.6.1 / 2018-10-09
* Sanitize colons in tags (linefeedse)
## 0.6.0 / 2018-09-20
* **BREAKING**: Period/length uses now seconds instead of minutes
* **BREAKING**: Config file uses new syntax to support static
* Support of --debug flag which outputs some dev debug informations
* Support of metrics who are not included in tags api (e.g. autoscaling metrics)
Before
```yaml
jobs:
- discovery:
region: eu-west-1
metrics:
- name: HealthyHostCount
statistics:
- 'Minimum'
period: 60
length: 300
```
New Syntax:
```yaml
discovery:
- region: eu-west-1
type: elb
searchTags:
- Key: KubernetesCluster
Value: production
metrics:
- name: HealthyHostCount
statistics:
- 'Minimum'
period: 60
length: 300
static:
- namespace: AWS/AutoScaling
region: eu-west-1
dimensions:
- name: AutoScalingGroupName
value: Test
metrics:
- name: GroupInServiceInstances
statistics:
- 'Minimum'
period: 60
length: 300
```
## 0.5.0 / 2018-08-07
* Support of EFS - Elastic File System
* Support of EBS - Elastic Block Storage
## 0.4.0 / 2018-08-07
* **BREAKING**: Config file uses list as statistics config option,
this should reduce api calls for more than one statistics.
Before:
```yaml
jobs:
- discovery:
metrics:
statistics: 'Maximum'
```
After:
```yaml
jobs:
- discovery:
metrics:
statistics:
- 'Maximum'
```
* Start to track changes in CHANGELOG.md
* Better error handling (discordianfish)
* Increase speed, not only each jobs threaded but now each metric
* Add s3 support
* Fix potential race condition during cloudwatch access
* Fix bug ignoring period in cloudwatch config
* Use interfaces for aws access and prepare code for unit tests
* Implement minimum, average, maximum, sum for cloudwatch api
* Implement way to handle multiple data returned by cloudwatch
* Update go dependencies
================================================
FILE: CODE_OF_CONDUCT.md
================================================
# Prometheus Community Code of Conduct
Prometheus follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md).
================================================
FILE: CONTRIBUTE.md
================================================
# CONTRIBUTE
## Steps to Contribute
* We use [golangci-lint](https://github.com/golangci/golangci-lint) for linting the code. Make it sure to install it first.
* Check out repository running `git clone https://github.com/prometheus-community/yet-another-cloudwatch-exporter.git`
* For linting, please run `make lint`
* For building, please run `make build`
* For running locally, please run `./yace`
* Best practices:
* commit should be as small as possible
* branch from the *master* branch
* add tests relevant to the fixed bug or new feature
## How to release
* `git tag v0.13.1-alpha && git push --tags`
================================================
FILE: Dockerfile
================================================
ARG ARCH="amd64"
ARG OS="linux"
FROM quay.io/prometheus/busybox-${OS}-${ARCH}:latest
LABEL maintainer="The Prometheus Authors <prometheus-developers@googlegroups.com>"
ARG ARCH="amd64"
ARG OS="linux"
COPY .build/${OS}-${ARCH}/yace /bin/yace
COPY examples/ec2.yml /etc/yace/config.yml
EXPOSE 5000
USER nobody
ENTRYPOINT [ "/bin/yace" ]
CMD [ "--config.file=/etc/yace/config.yml" ]
================================================
FILE: LICENSE
================================================
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright 2024 The Prometheus Authors
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
================================================
FILE: MAINTAINERS.md
================================================
# Maintainers
- Thomas Peitz (info@thomas-peitz.de / @thomaspeitz)
- Cristian Greco (cristian.greco@grafana.com / @cristiangreco)
- Andrii Kushch (andrii.kushch@grafana.com / @andriikushch)
- Tristan Burgess (tristan.burgess@grafana.com / @tristanburgess)
================================================
FILE: Makefile
================================================
# Copyright 2024 The Prometheus Authors
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# Needs to be defined before including Makefile.common to auto-generate targets
DOCKER_ARCHS ?= amd64 armv7 arm64
DOCKER_REPO ?= prometheuscommunity
include Makefile.common
STATICCHECK_IGNORE =
DOCKER_IMAGE_NAME ?= yet-another-cloudwatch-exporter
================================================
FILE: Makefile.common
================================================
# Copyright The Prometheus Authors
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# A common Makefile that includes rules to be reused in different prometheus projects.
# !!! Open PRs only against the prometheus/prometheus/Makefile.common repository!
# Example usage :
# Create the main Makefile in the root project directory.
# include Makefile.common
# customTarget:
# @echo ">> Running customTarget"
#
# Ensure GOBIN is not set during build so that promu is installed to the correct path
unexport GOBIN
GO ?= go
GOFMT ?= $(GO)fmt
FIRST_GOPATH := $(firstword $(subst :, ,$(shell $(GO) env GOPATH)))
GOOPTS ?=
GOHOSTOS ?= $(shell $(GO) env GOHOSTOS)
GOHOSTARCH ?= $(shell $(GO) env GOHOSTARCH)
GO_VERSION ?= $(shell $(GO) version)
GO_VERSION_NUMBER ?= $(word 3, $(GO_VERSION))
PRE_GO_111 ?= $(shell echo $(GO_VERSION_NUMBER) | grep -E 'go1\.(10|[0-9])\.')
PROMU := $(FIRST_GOPATH)/bin/promu
pkgs = ./...
ifeq (arm, $(GOHOSTARCH))
GOHOSTARM ?= $(shell GOARM= $(GO) env GOARM)
GO_BUILD_PLATFORM ?= $(GOHOSTOS)-$(GOHOSTARCH)v$(GOHOSTARM)
else
GO_BUILD_PLATFORM ?= $(GOHOSTOS)-$(GOHOSTARCH)
endif
GOTEST := $(GO) test
GOTEST_DIR :=
ifneq ($(CIRCLE_JOB),)
ifneq ($(shell command -v gotestsum 2> /dev/null),)
GOTEST_DIR := test-results
GOTEST := gotestsum --junitfile $(GOTEST_DIR)/unit-tests.xml --
endif
endif
PROMU_VERSION ?= 0.18.1
PROMU_URL := https://github.com/prometheus/promu/releases/download/v$(PROMU_VERSION)/promu-$(PROMU_VERSION).$(GO_BUILD_PLATFORM).tar.gz
SKIP_GOLANGCI_LINT :=
GOLANGCI_LINT :=
GOLANGCI_LINT_OPTS ?=
GOLANGCI_LINT_VERSION ?= v2.11.4
GOLANGCI_FMT_OPTS ?=
# golangci-lint only supports linux, darwin and windows platforms on i386/amd64/arm64.
# windows isn't included here because of the path separator being different.
ifeq ($(GOHOSTOS),$(filter $(GOHOSTOS),linux darwin))
ifeq ($(GOHOSTARCH),$(filter $(GOHOSTARCH),amd64 i386 arm64))
# If we're in CI and there is an Actions file, that means the linter
# is being run in Actions, so we don't need to run it here.
ifneq (,$(SKIP_GOLANGCI_LINT))
GOLANGCI_LINT :=
else ifeq (,$(CIRCLE_JOB))
GOLANGCI_LINT := $(FIRST_GOPATH)/bin/golangci-lint
else ifeq (,$(wildcard .github/workflows/golangci-lint.yml))
GOLANGCI_LINT := $(FIRST_GOPATH)/bin/golangci-lint
endif
endif
endif
PREFIX ?= $(shell pwd)
BIN_DIR ?= $(shell pwd)
DOCKER_IMAGE_TAG ?= $(subst /,-,$(shell git rev-parse --abbrev-ref HEAD))
DOCKERBUILD_CONTEXT ?= ./
DOCKER_REPO ?= prom
# Check if deprecated DOCKERFILE_PATH is set
ifdef DOCKERFILE_PATH
$(error DOCKERFILE_PATH is deprecated. Use DOCKERFILE_VARIANTS ?= $(DOCKERFILE_PATH) in the Makefile)
endif
DOCKER_ARCHS ?= amd64 arm64 armv7 ppc64le riscv64 s390x
DOCKERFILE_ARCH_EXCLUSIONS ?=
DOCKER_REGISTRY_ARCH_EXCLUSIONS ?= quay.io:riscv64
DOCKERFILE_VARIANTS ?= $(wildcard Dockerfile Dockerfile.*)
# Function to extract variant from Dockerfile label.
# Returns the variant name from io.prometheus.image.variant label, or "default" if not found.
define dockerfile_variant
$(strip $(or $(shell sed -n 's/.*io\.prometheus\.image\.variant="\([^"]*\)".*/\1/p' $(1)),default))
endef
# Check for duplicate variant names (including default for Dockerfiles without labels).
DOCKERFILE_VARIANT_NAMES := $(foreach df,$(DOCKERFILE_VARIANTS),$(call dockerfile_variant,$(df)))
DOCKERFILE_VARIANT_NAMES_SORTED := $(sort $(DOCKERFILE_VARIANT_NAMES))
ifneq ($(words $(DOCKERFILE_VARIANT_NAMES)),$(words $(DOCKERFILE_VARIANT_NAMES_SORTED)))
$(error Duplicate variant names found. Each Dockerfile must have a unique io.prometheus.image.variant label, and only one can be without a label (default))
endif
# Build variant:dockerfile pairs for shell iteration.
DOCKERFILE_VARIANTS_WITH_NAMES := $(foreach df,$(DOCKERFILE_VARIANTS),$(call dockerfile_variant,$(df)):$(df))
# Shell helper to check whether a dockerfile/arch pair is excluded.
define dockerfile_arch_is_excluded
case " $(DOCKERFILE_ARCH_EXCLUSIONS) " in \
*" $$dockerfile:$(1) "*) true ;; \
*) false ;; \
esac
endef
# Shell helper to check whether a registry/arch pair is excluded.
# Extracts registry from DOCKER_REPO (e.g., quay.io/prometheus -> quay.io)
define registry_arch_is_excluded
registry=$$(echo "$(DOCKER_REPO)" | cut -d'/' -f1); \
case " $(DOCKER_REGISTRY_ARCH_EXCLUSIONS) " in \
*" $$registry:$(1) "*) true ;; \
*) false ;; \
esac
endef
BUILD_DOCKER_ARCHS = $(addprefix common-docker-,$(DOCKER_ARCHS))
PUBLISH_DOCKER_ARCHS = $(addprefix common-docker-publish-,$(DOCKER_ARCHS))
TAG_DOCKER_ARCHS = $(addprefix common-docker-tag-latest-,$(DOCKER_ARCHS))
SANITIZED_DOCKER_IMAGE_TAG := $(subst +,-,$(DOCKER_IMAGE_TAG))
ifeq ($(GOHOSTARCH),amd64)
ifeq ($(GOHOSTOS),$(filter $(GOHOSTOS),linux freebsd darwin windows))
# Only supported on amd64
test-flags := -race
endif
endif
# This rule is used to forward a target like "build" to "common-build". This
# allows a new "build" target to be defined in a Makefile which includes this
# one and override "common-build" without override warnings.
%: common-% ;
.PHONY: common-all
common-all: precheck style check_license lint yamllint unused build test
.PHONY: common-style
common-style:
@echo ">> checking code style"
@fmtRes=$$($(GOFMT) -d $$(git ls-files '*.go' ':!:vendor/*' || find . -path ./vendor -prune -o -name '*.go' -print)); \
if [ -n "$${fmtRes}" ]; then \
echo "gofmt checking failed!"; echo "$${fmtRes}"; echo; \
echo "Please ensure you are using $$($(GO) version) for formatting code."; \
exit 1; \
fi
.PHONY: common-check_license
common-check_license:
@echo ">> checking license header"
@licRes=$$(for file in $$(git ls-files '*.go' ':!:vendor/*' || find . -path ./vendor -prune -o -type f -iname '*.go' -print) ; do \
awk 'NR<=3' $$file | grep -Eq "(Copyright|generated|GENERATED)" || echo $$file; \
done); \
if [ -n "$${licRes}" ]; then \
echo "license header checking failed:"; echo "$${licRes}"; \
exit 1; \
fi
@echo ">> checking for copyright years 2026 or later"
@futureYearRes=$$(git grep -E 'Copyright (202[6-9]|20[3-9][0-9])' -- '*.go' ':!:vendor/*' || true); \
if [ -n "$${futureYearRes}" ]; then \
echo "Files with copyright year 2026 or later found (should use 'Copyright The Prometheus Authors'):"; echo "$${futureYearRes}"; \
exit 1; \
fi
.PHONY: common-deps
common-deps:
@echo ">> getting dependencies"
$(GO) mod download
.PHONY: update-go-deps
update-go-deps:
@echo ">> updating Go dependencies"
@for m in $$($(GO) list -mod=readonly -m -f '{{ if and (not .Indirect) (not .Main)}}{{.Path}}{{end}}' all); do \
$(GO) get $$m; \
done
$(GO) mod tidy
.PHONY: common-test-short
common-test-short: $(GOTEST_DIR)
@echo ">> running short tests"
$(GOTEST) -short $(GOOPTS) $(pkgs)
.PHONY: common-test
common-test: $(GOTEST_DIR)
@echo ">> running all tests"
$(GOTEST) $(test-flags) $(GOOPTS) $(pkgs)
$(GOTEST_DIR):
@mkdir -p $@
.PHONY: common-format
common-format: $(GOLANGCI_LINT)
@echo ">> formatting code"
$(GO) fmt $(pkgs)
ifdef GOLANGCI_LINT
@echo ">> formatting code with golangci-lint"
$(GOLANGCI_LINT) fmt $(GOLANGCI_FMT_OPTS)
endif
.PHONY: common-vet
common-vet:
@echo ">> vetting code"
$(GO) vet $(GOOPTS) $(pkgs)
.PHONY: common-lint
common-lint: $(GOLANGCI_LINT)
ifdef GOLANGCI_LINT
@echo ">> running golangci-lint"
$(GOLANGCI_LINT) run $(GOLANGCI_LINT_OPTS) $(pkgs)
endif
.PHONY: common-lint-fix
common-lint-fix: $(GOLANGCI_LINT)
ifdef GOLANGCI_LINT
@echo ">> running golangci-lint fix"
$(GOLANGCI_LINT) run --fix $(GOLANGCI_LINT_OPTS) $(pkgs)
endif
.PHONY: common-yamllint
common-yamllint:
@echo ">> running yamllint on all YAML files in the repository"
ifeq (, $(shell command -v yamllint 2> /dev/null))
@echo "yamllint not installed so skipping"
else
yamllint .
endif
# For backward-compatibility.
.PHONY: common-staticcheck
common-staticcheck: lint
.PHONY: common-unused
common-unused:
@echo ">> running check for unused/missing packages in go.mod"
$(GO) mod tidy
@git diff --exit-code -- go.sum go.mod
.PHONY: common-build
common-build: promu
@echo ">> building binaries"
$(PROMU) build --prefix $(PREFIX) $(PROMU_BINARIES)
.PHONY: common-tarball
common-tarball: promu
@echo ">> building release tarball"
$(PROMU) tarball --prefix $(PREFIX) $(BIN_DIR)
.PHONY: common-docker-repo-name
common-docker-repo-name:
@echo "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)"
.PHONY: common-docker $(BUILD_DOCKER_ARCHS)
common-docker: $(BUILD_DOCKER_ARCHS)
$(BUILD_DOCKER_ARCHS): common-docker-%:
@for variant in $(DOCKERFILE_VARIANTS_WITH_NAMES); do \
dockerfile=$${variant#*:}; \
variant_name=$${variant%%:*}; \
if $(call dockerfile_arch_is_excluded,$*); then \
echo "Skipping $$variant_name variant for linux-$* (excluded by DOCKERFILE_ARCH_EXCLUSIONS)"; \
continue; \
fi; \
distroless_arch="$*"; \
if [ "$*" = "armv7" ]; then \
distroless_arch="arm"; \
fi; \
if [ "$$dockerfile" = "Dockerfile" ]; then \
echo "Building default variant ($$variant_name) for linux-$* using $$dockerfile"; \
docker build -t "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$*:$(SANITIZED_DOCKER_IMAGE_TAG)" \
-f $$dockerfile \
--build-arg ARCH="$*" \
--build-arg OS="linux" \
--build-arg DISTROLESS_ARCH="$$distroless_arch" \
$(DOCKERBUILD_CONTEXT); \
if [ "$$variant_name" != "default" ]; then \
echo "Tagging default variant with $$variant_name suffix"; \
docker tag "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$*:$(SANITIZED_DOCKER_IMAGE_TAG)" \
"$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$*:$(SANITIZED_DOCKER_IMAGE_TAG)-$$variant_name"; \
fi; \
else \
echo "Building $$variant_name variant for linux-$* using $$dockerfile"; \
docker build -t "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$*:$(SANITIZED_DOCKER_IMAGE_TAG)-$$variant_name" \
-f $$dockerfile \
--build-arg ARCH="$*" \
--build-arg OS="linux" \
--build-arg DISTROLESS_ARCH="$$distroless_arch" \
$(DOCKERBUILD_CONTEXT); \
fi; \
done
.PHONY: common-docker-publish $(PUBLISH_DOCKER_ARCHS)
common-docker-publish: $(PUBLISH_DOCKER_ARCHS)
$(PUBLISH_DOCKER_ARCHS): common-docker-publish-%:
@for variant in $(DOCKERFILE_VARIANTS_WITH_NAMES); do \
dockerfile=$${variant#*:}; \
variant_name=$${variant%%:*}; \
if $(call dockerfile_arch_is_excluded,$*); then \
echo "Skipping push for $$variant_name variant on linux-$* (excluded by DOCKERFILE_ARCH_EXCLUSIONS)"; \
continue; \
fi; \
if $(call registry_arch_is_excluded,$*); then \
echo "Skipping push for $$variant_name variant on linux-$* to $(DOCKER_REPO) (excluded by DOCKER_REGISTRY_ARCH_EXCLUSIONS)"; \
continue; \
fi; \
if [ "$$dockerfile" != "Dockerfile" ] || [ "$$variant_name" != "default" ]; then \
echo "Pushing $$variant_name variant for linux-$*"; \
docker push "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$*:$(SANITIZED_DOCKER_IMAGE_TAG)-$$variant_name"; \
fi; \
if [ "$$dockerfile" = "Dockerfile" ]; then \
echo "Pushing default variant ($$variant_name) for linux-$*"; \
docker push "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$*:$(SANITIZED_DOCKER_IMAGE_TAG)"; \
fi; \
if [ "$(DOCKER_IMAGE_TAG)" = "latest" ]; then \
if [ "$$dockerfile" != "Dockerfile" ] || [ "$$variant_name" != "default" ]; then \
echo "Pushing $$variant_name variant version tags for linux-$*"; \
docker push "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$*:v$(DOCKER_MAJOR_VERSION_TAG)-$$variant_name"; \
fi; \
if [ "$$dockerfile" = "Dockerfile" ]; then \
echo "Pushing default variant version tag for linux-$*"; \
docker push "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$*:v$(DOCKER_MAJOR_VERSION_TAG)"; \
fi; \
fi; \
done
DOCKER_MAJOR_VERSION_TAG = $(firstword $(subst ., ,$(shell cat VERSION)))
.PHONY: common-docker-tag-latest $(TAG_DOCKER_ARCHS)
common-docker-tag-latest: $(TAG_DOCKER_ARCHS)
$(TAG_DOCKER_ARCHS): common-docker-tag-latest-%:
@for variant in $(DOCKERFILE_VARIANTS_WITH_NAMES); do \
dockerfile=$${variant#*:}; \
variant_name=$${variant%%:*}; \
if $(call dockerfile_arch_is_excluded,$*); then \
echo "Skipping tag for $$variant_name variant on linux-$* (excluded by DOCKERFILE_ARCH_EXCLUSIONS)"; \
continue; \
fi; \
if $(call registry_arch_is_excluded,$*); then \
echo "Skipping tag for $$variant_name variant on linux-$* for $(DOCKER_REPO) (excluded by DOCKER_REGISTRY_ARCH_EXCLUSIONS)"; \
continue; \
fi; \
if [ "$$dockerfile" != "Dockerfile" ] || [ "$$variant_name" != "default" ]; then \
echo "Tagging $$variant_name variant for linux-$* as latest"; \
docker tag "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$*:$(SANITIZED_DOCKER_IMAGE_TAG)-$$variant_name" "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$*:latest-$$variant_name"; \
docker tag "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$*:$(SANITIZED_DOCKER_IMAGE_TAG)-$$variant_name" "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$*:v$(DOCKER_MAJOR_VERSION_TAG)-$$variant_name"; \
fi; \
if [ "$$dockerfile" = "Dockerfile" ]; then \
echo "Tagging default variant ($$variant_name) for linux-$* as latest"; \
docker tag "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$*:$(SANITIZED_DOCKER_IMAGE_TAG)" "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$*:latest"; \
docker tag "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$*:$(SANITIZED_DOCKER_IMAGE_TAG)" "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$*:v$(DOCKER_MAJOR_VERSION_TAG)"; \
fi; \
done
.PHONY: common-docker-manifest
common-docker-manifest:
@for variant in $(DOCKERFILE_VARIANTS_WITH_NAMES); do \
dockerfile=$${variant#*:}; \
variant_name=$${variant%%:*}; \
if [ "$$dockerfile" != "Dockerfile" ] || [ "$$variant_name" != "default" ]; then \
echo "Creating manifest for $$variant_name variant"; \
refs=""; \
for arch in $(DOCKER_ARCHS); do \
if $(call dockerfile_arch_is_excluded,$$arch); then \
echo " Skipping $$arch for $$variant_name (excluded by DOCKERFILE_ARCH_EXCLUSIONS)"; \
continue; \
fi; \
if $(call registry_arch_is_excluded,$$arch); then \
echo " Skipping $$arch for $$variant_name on $(DOCKER_REPO) (excluded by DOCKER_REGISTRY_ARCH_EXCLUSIONS)"; \
continue; \
fi; \
refs="$$refs $(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$$arch:$(SANITIZED_DOCKER_IMAGE_TAG)-$$variant_name"; \
done; \
if [ -z "$$refs" ]; then \
echo "Skipping manifest for $$variant_name variant (no supported architectures)"; \
continue; \
fi; \
DOCKER_CLI_EXPERIMENTAL=enabled docker manifest create -a "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME):$(SANITIZED_DOCKER_IMAGE_TAG)-$$variant_name" $$refs; \
DOCKER_CLI_EXPERIMENTAL=enabled docker manifest push "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME):$(SANITIZED_DOCKER_IMAGE_TAG)-$$variant_name"; \
fi; \
if [ "$$dockerfile" = "Dockerfile" ]; then \
echo "Creating default variant ($$variant_name) manifest"; \
refs=""; \
for arch in $(DOCKER_ARCHS); do \
if $(call dockerfile_arch_is_excluded,$$arch); then \
echo " Skipping $$arch for default variant (excluded by DOCKERFILE_ARCH_EXCLUSIONS)"; \
continue; \
fi; \
if $(call registry_arch_is_excluded,$$arch); then \
echo " Skipping $$arch for default variant on $(DOCKER_REPO) (excluded by DOCKER_REGISTRY_ARCH_EXCLUSIONS)"; \
continue; \
fi; \
refs="$$refs $(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$$arch:$(SANITIZED_DOCKER_IMAGE_TAG)"; \
done; \
if [ -z "$$refs" ]; then \
echo "Skipping default variant manifest (no supported architectures)"; \
continue; \
fi; \
DOCKER_CLI_EXPERIMENTAL=enabled docker manifest create -a "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME):$(SANITIZED_DOCKER_IMAGE_TAG)" $$refs; \
DOCKER_CLI_EXPERIMENTAL=enabled docker manifest push "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME):$(SANITIZED_DOCKER_IMAGE_TAG)"; \
fi; \
if [ "$(DOCKER_IMAGE_TAG)" = "latest" ]; then \
if [ "$$dockerfile" != "Dockerfile" ] || [ "$$variant_name" != "default" ]; then \
echo "Creating manifest for $$variant_name variant version tag"; \
refs=""; \
for arch in $(DOCKER_ARCHS); do \
if $(call dockerfile_arch_is_excluded,$$arch); then \
echo " Skipping $$arch for $$variant_name version tag (excluded by DOCKERFILE_ARCH_EXCLUSIONS)"; \
continue; \
fi; \
if $(call registry_arch_is_excluded,$$arch); then \
echo " Skipping $$arch for $$variant_name version tag on $(DOCKER_REPO) (excluded by DOCKER_REGISTRY_ARCH_EXCLUSIONS)"; \
continue; \
fi; \
refs="$$refs $(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$$arch:v$(DOCKER_MAJOR_VERSION_TAG)-$$variant_name"; \
done; \
if [ -z "$$refs" ]; then \
echo "Skipping version-tag manifest for $$variant_name variant (no supported architectures)"; \
continue; \
fi; \
DOCKER_CLI_EXPERIMENTAL=enabled docker manifest create -a "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME):v$(DOCKER_MAJOR_VERSION_TAG)-$$variant_name" $$refs; \
DOCKER_CLI_EXPERIMENTAL=enabled docker manifest push "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME):v$(DOCKER_MAJOR_VERSION_TAG)-$$variant_name"; \
fi; \
if [ "$$dockerfile" = "Dockerfile" ]; then \
echo "Creating default variant version tag manifest"; \
refs=""; \
for arch in $(DOCKER_ARCHS); do \
if $(call dockerfile_arch_is_excluded,$$arch); then \
echo " Skipping $$arch for default variant version tag (excluded by DOCKERFILE_ARCH_EXCLUSIONS)"; \
continue; \
fi; \
if $(call registry_arch_is_excluded,$$arch); then \
echo " Skipping $$arch for default variant version tag on $(DOCKER_REPO) (excluded by DOCKER_REGISTRY_ARCH_EXCLUSIONS)"; \
continue; \
fi; \
refs="$$refs $(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$$arch:v$(DOCKER_MAJOR_VERSION_TAG)"; \
done; \
if [ -z "$$refs" ]; then \
echo "Skipping default variant version-tag manifest (no supported architectures)"; \
continue; \
fi; \
DOCKER_CLI_EXPERIMENTAL=enabled docker manifest create -a "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME):v$(DOCKER_MAJOR_VERSION_TAG)" $$refs; \
DOCKER_CLI_EXPERIMENTAL=enabled docker manifest push "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME):v$(DOCKER_MAJOR_VERSION_TAG)"; \
fi; \
fi; \
done
.PHONY: promu
promu: $(PROMU)
$(PROMU):
$(eval PROMU_TMP := $(shell mktemp -d))
curl -s -L $(PROMU_URL) | tar -xvzf - -C $(PROMU_TMP)
mkdir -p $(FIRST_GOPATH)/bin
cp $(PROMU_TMP)/promu-$(PROMU_VERSION).$(GO_BUILD_PLATFORM)/promu $(FIRST_GOPATH)/bin/promu
rm -r $(PROMU_TMP)
.PHONY: common-proto
common-proto:
@echo ">> generating code from proto files"
@./scripts/genproto.sh
ifdef GOLANGCI_LINT
$(GOLANGCI_LINT):
mkdir -p $(FIRST_GOPATH)/bin
curl -sfL https://raw.githubusercontent.com/golangci/golangci-lint/$(GOLANGCI_LINT_VERSION)/install.sh \
| sed -e '/install -d/d' \
| sh -s -- -b $(FIRST_GOPATH)/bin $(GOLANGCI_LINT_VERSION)
endif
.PHONY: common-print-golangci-lint-version
common-print-golangci-lint-version:
@echo $(GOLANGCI_LINT_VERSION)
.PHONY: precheck
precheck::
define PRECHECK_COMMAND_template =
precheck:: $(1)_precheck
PRECHECK_COMMAND_$(1) ?= $(1) $$(strip $$(PRECHECK_OPTIONS_$(1)))
.PHONY: $(1)_precheck
$(1)_precheck:
@if ! $$(PRECHECK_COMMAND_$(1)) 1>/dev/null 2>&1; then \
echo "Execution of '$$(PRECHECK_COMMAND_$(1))' command failed. Is $(1) installed?"; \
exit 1; \
fi
endef
govulncheck: install-govulncheck
govulncheck ./...
install-govulncheck:
command -v govulncheck > /dev/null || go install golang.org/x/vuln/cmd/govulncheck@latest
================================================
FILE: NOTICE
================================================
Copyright 2018-2021 Invision AG
Copyright 2021-2024 NERDSWORDS
Copyright 2024 The Prometheus Authors
================================================
FILE: README.md
================================================
# YACE - yet another cloudwatch exporter
[][quay]
[][docker]
YACE, or `yet another cloudwatch exporter`, is a [Prometheus exporter](https://prometheus.io/docs/instrumenting/exporters/#exporters-and-integrations) for [AWS CloudWatch](http://aws.amazon.com/cloudwatch/) metrics. It is written in Go and uses the official AWS SDK.
## News
As of November 2024, YACE is part of [prometheus-community](https://github.com/prometheus-community). Read more about it in these announcement posts:
* https://prometheus.io/blog/2024/11/19/yace-joining-prometheus-community/
* https://grafana.com/blog/2024/11/19/yace-moves-to-prometheus-community/
## Alternatives
Consider using the official [CloudWatch Exporter](https://github.com/prometheus/cloudwatch_exporter) if you prefer a Java implementation.
## Project Status
While YACE is at version less than 1.0.0, expect that any new release might introduce breaking changes. We'll document changes in [CHANGELOG.md](CHANGELOG.md).
Where feasible, features will be deprecated instead of being immediately changed or removed. This means that YACE will continue to work but might log warning messages. Expect deprecated features to be permanently changed/removed within the next 2/3 releases.
## Security
Read more how to report a security vulnerability in [SECURITY.md](SECURITY.md).
### Supported Versions
Only the latest version gets security updates. We won't support older versions.
## Features
* Stop worrying about your AWS IDs - Auto discovery of resources via tags
* Structured logging (json and logfmt)
* 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
* Can be used as a library in an external application
* Support the scraping of custom namespaces metrics with the CloudWatch Dimensions.
* Supported services with auto discovery through tags:
* `/aws/sagemaker/Endpoints` - Sagemaker Endpoints
* `/aws/sagemaker/InferenceRecommendationsJobs` - Sagemaker Inference Recommender Jobs
* `/aws/sagemaker/ProcessingJobs` - Sagemaker Processing Jobs
* `/aws/sagemaker/TrainingJobs` - Sagemaker Training Jobs
* `/aws/sagemaker/TransformJobs` - Sagemaker Batch Transform Jobs
* `AmazonMWAA` - Managed Apache Airflow
* `AWS/ACMPrivateCA` - ACM Private CA
* `AWS/AmazonMQ` - Managed Message Broker Service
* `AWS/AOSS` - OpenSearch Serverless
* `AWS/ApiGateway` - ApiGateway (V1 and V2)
* `AWS/ApplicationELB` - Application Load Balancer
* `AWS/AppRunner` - Managed Container Apps Service
* `AWS/AppStream` - AppStream
* `AWS/AppSync` - AppSync
* `AWS/Athena` - Athena
* `AWS/AutoScaling` - Auto Scaling Group
* `AWS/Backup` - Backup
* `AWS/Bedrock` - GenerativeAI
* `AWS/Billing` - Billing
* `AWS/Cassandra` - Cassandra
* `AWS/CertificateManager` - Certificate Manager
* `AWS/ClientVPN` - Client-based VPN
* `AWS/CloudFront` - Cloud Front
* `AWS/Cognito` - Cognito
* `AWS/DataSync` - DataSync
* `AWS/DDoSProtection` - Distributed Denial of Service (DDoS) protection service
* `AWS/DirectoryService` - Directory Services (MicrosoftAD)
* `AWS/DMS` - Database Migration Service
* `AWS/DocDB` - DocumentDB (with MongoDB compatibility)
* `AWS/DX` - Direct Connect
* `AWS/DynamoDB` - NoSQL Key-Value Database
* `AWS/EBS` - Elastic Block Storage
* `AWS/EC2` - Elastic Compute Cloud
* `AWS/EC2Spot` - Elastic Compute Cloud for Spot Instances
* `AWS/ECR` - Elastic Container Registry
* `AWS/ECS` - Elastic Container Service (Service Metrics)
* `AWS/EFS` - Elastic File System
* `AWS/ElastiCache` - ElastiCache
* `AWS/ElasticBeanstalk` - Elastic Beanstalk
* `AWS/ElasticMapReduce` - Elastic MapReduce
* `AWS/ELB` - Elastic Load Balancer
* `AWS/EMRServerless` - Amazon EMR Serverless
* `AWS/ES` - ElasticSearch
* `AWS/Events` - EventBridge
* `AWS/Firehose` - Managed Streaming Service
* `AWS/FSx` - FSx File System
* `AWS/GameLift` - GameLift
* `AWS/GatewayELB` - Gateway Load Balancer
* `AWS/GlobalAccelerator` - AWS Global Accelerator
* `AWS/IoT` - IoT
* `AWS/IPAM` - IP address manager
* `AWS/Kafka` - Managed Apache Kafka
* `AWS/KafkaConnect` - AWS MSK Connectors
* `AWS/Kinesis` - Kinesis Data Stream
* `AWS/KinesisAnalytics` - Kinesis Data Analytics for SQL Applications
* `AWS/KMS` - Key Management Service
* `AWS/Lambda` - Lambda Functions
* `AWS/Logs` - CloudWatch Logs
* `AWS/MediaConnect` - AWS Elemental MediaConnect
* `AWS/MediaConvert` - AWS Elemental MediaConvert
* `AWS/MediaLive` - AWS Elemental MediaLive
* `AWS/MediaPackage` - AWS Elemental MediaPackage
* `AWS/MediaTailor` - AWS Elemental MediaTailor
* `AWS/MemoryDB` - AWS MemoryDB
* `AWS/MWAA` - Managed Apache Airflow (Container, queue, and database metrics)
* `AWS/NATGateway` - NAT Gateway
* `AWS/Neptune` - Neptune
* `AWS/NetworkELB` - Network Load Balancer
* `AWS/NetworkFirewall` - Network Firewall
* `AWS/Network Manager` - Network Manager
* `AWS/PrivateLinkEndpoints` - VPC Endpoint
* `AWS/PrivateLinkServices` - VPC Endpoint Service
* `AWS/Prometheus` - Managed Service for Prometheus
* `AWS/QLDB` - Quantum Ledger Database
* `AWS/QuickSight` - QuickSight (Business Intelligence)
* `AWS/RDS` - Relational Database Service
* `AWS/Redshift` - Redshift Database
* `AWS/Redshift-Serverless` - Redshift Serverless
* `AWS/Route53` - Route53 Health Checks
* `AWS/Route53Resolver` - Route53 Resolver
* `AWS/RUM` - Real User Monitoring
* `AWS/S3` - Object Storage
* `AWS/Sagemaker/ModelBuildingPipeline` - Sagemaker Model Building Pipelines
* `AWS/SageMaker` - Sagemaker invocations
* `AWS/Scheduler` - EventBridge Scheduler
* `AWS/SecretsManager` - Secrets Manager
* `AWS/SES` - Simple Email Service
* `AWS/SNS` - Simple Notification Service
* `AWS/SQS` - Simple Queue Service
* `AWS/States` - Step Functions
* `AWS/StorageGateway` - On-premises access to cloud storage
* `AWS/Timestream` - Time-series database service
* `AWS/TransitGateway` - Transit Gateway
* `AWS/TrustedAdvisor` - Trusted Advisor
* `AWS/Usage` - Usage of some AWS resources and APIs
* `AWS/VpcLattice` - VPC Lattice
* `AWS/VPN` - VPN connection
* `AWS/WAFV2` - Web Application Firewall v2
* `AWS/WorkSpaces` - Workspaces
* `ContainerInsights` - EKS ContainerInsights (Dependency on Cloudwatch agent)
* `CWAgent` - CloudWatch agent
* `ECS/ContainerInsights` - ECS/ContainerInsights (Fargate metrics)
* `Glue` - AWS Glue Jobs
## Feature flags
To provide backwards compatibility, some of YACE's new features or breaking changes might be guarded under a feature flag. Refer to [docs/feature_flags.md](./docs/feature_flags.md) for details.
## Installing and running
Refer to the [installation guide](docs/installation.md).
## Authentication
The exporter will need to be running in an environment which has access to AWS. The exporter uses the [AWS SDK for Go](https://aws.github.io/aws-sdk-go-v2/docs/getting-started/) and supports providing authentication via [AWS's default credential chain](https://aws.github.io/aws-sdk-go-v2/docs/configuring-sdk/#specifying-credentials). Regardless of the method used to acquire the credentials, some permissions are needed for the exporter to work.
As a quick start, the following IAM policy can be used to grant the all permissions required by YACE
```json
{
"Version": "2012-10-17",
"Statement": [
{
"Action": [
"tag:GetResources",
"cloudwatch:GetMetricData",
"cloudwatch:GetMetricStatistics",
"cloudwatch:ListMetrics",
"apigateway:GET",
"aps:ListWorkspaces",
"autoscaling:DescribeAutoScalingGroups",
"dms:DescribeReplicationInstances",
"dms:DescribeReplicationTasks",
"ec2:DescribeTransitGatewayAttachments",
"ec2:DescribeSpotFleetRequests",
"shield:ListProtections",
"storagegateway:ListGateways",
"storagegateway:ListTagsForResource",
"iam:ListAccountAliases"
],
"Effect": "Allow",
"Resource": "*"
}
]
}
```
If you would like to remove certain permissions based on your needs the policy can be adjusted based the CloudWatch namespaces you are scraping
These are the bare minimum permissions required to run Static and Discovery Jobs
```json
"tag:GetResources",
"cloudwatch:GetMetricData",
"cloudwatch:GetMetricStatistics",
"cloudwatch:ListMetrics"
```
This permission is required to discover resources for the AWS/ApiGateway namespace
```json
"apigateway:GET"
```
This permission is required to discover resources for the AWS/AutoScaling namespace
```json
"autoscaling:DescribeAutoScalingGroups"
```
These permissions are required to discover resources for the AWS/DMS namespace
```json
"dms:DescribeReplicationInstances",
"dms:DescribeReplicationTasks"
```
This permission is required to discover resources for the AWS/EC2Spot namespace
```json
"ec2:DescribeSpotFleetRequests"
```
This permission is required to discover resources for the AWS/Prometheus namespace
```json
"aps:ListWorkspaces"
```
These permissions are required to discover resources for the AWS/StorageGateway namespace
```json
"storagegateway:ListGateways",
"storagegateway:ListTagsForResource"
```
This permission is required to discover resources for the AWS/TransitGateway namespace
```json
"ec2:DescribeTransitGatewayAttachments"
```
This permission is required to discover protected resources for the AWS/DDoSProtection namespace
```json
"shield:ListProtections"
```
The AWS IAM API supports creating account aliases, which are human-friendly names that can be used to easily identify accounts. An account can have at most a single alias, see ([docs](https://docs.aws.amazon.com/IAM/latest/APIReference/API_ListAccountAliases.html)). Each alias must be unique across an AWS network partition ([docs](https://docs.aws.amazon.com/IAM/latest/UserGuide/console_account-alias.html#AboutAccountAlias)). The following permission is required to get the alias for an account, which is exported as a label in the `aws_account_info` metric:
```json
"iam:ListAccountAliases"
```
If running YACE inside an AWS EC2 instance, the exporter will automatically attempt to assume the associated IAM Role. If this is undesirable behavior turn off the use the metadata endpoint by setting the environment variable `AWS_EC2_METADATA_DISABLED=true`.
## Configuration
Refer to the [configuration](docs/configuration.md) docs.
## Metrics Examples
```text
### 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
```
## Query Examples without exportedTagsOnMetrics
```text
# 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
```
## Override AWS endpoint urls
to support local testing all AWS urls can be overridden with by setting an environment variable `AWS_ENDPOINT_URL`
```shell
docker run -d --rm -v $PWD/credentials:/home/.aws/credentials -v $PWD/config.yml:/tmp/config.yml \
-e AWS_ENDPOINT_URL=http://localhost:4766 -p 5000:5000 --name yace quay.io/prometheuscommunity/yet-another-cloudwatch-exporter:latest
```
## Options
### RoleArns
Multiple 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:
```yaml
apiVersion: v1alpha1
sts-region: eu-west-1
discovery:
jobs:
- type: AWS/ECS
regions:
- eu-north-1
roles:
- roleArn: "arn:aws:iam::1111111111111:role/prometheus" # newspaper
- roleArn: "arn:aws:iam::2222222222222:role/prometheus" # radio
- roleArn: "arn:aws:iam::3333333333333:role/prometheus" # television
metrics:
- name: MemoryReservation
statistics:
- Average
- Minimum
- Maximum
period: 600
length: 600
```
Additionally, if the IAM role you want to assume requires an [External ID](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html?icmpid=docs_iam_console) you can specify it this way:
```yaml
roles:
- roleArn: "arn:aws:iam::1111111111111:role/prometheus"
externalId: "shared-external-identifier"
```
### Requests concurrency
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.
### Decoupled scraping
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.
## Embedding YACE in your application
YACE can be used as a library and embedded into your application, see the [embedding guide](docs/embedding.md).
## Troubleshooting / Debugging
### Help my metrics are intermittent
* 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.
### My metrics only show new values after 5 minutes
* Please, try to set a lower value for the 'scraping-interval' flag or set the 'decoupled-scraping' to false.
## Contribute
[Development Setup / Guide](/CONTRIBUTE.md)
## Thank you
* [Justin Santa Barbara](https://github.com/justinsb) - For telling me about AWS tags api which simplified a lot - Thanks!
* [Brian Brazil](https://github.com/brian-brazil) - Who gave a lot of feedback regarding UX and prometheus lib - Thanks!
[quay]: https://quay.io/repository/prometheuscommunity/yet-another-cloudwatch-exporter
[docker]: https://hub.docker.com/r/prometheuscommunity/yet-another-cloudwatch-exporter
================================================
FILE: SECURITY.md
================================================
# Reporting a security issue
The Prometheus security policy, including how to report vulnerabilities, can be
found here:
[https://prometheus.io/docs/operating/security/](https://prometheus.io/docs/operating/security/)
================================================
FILE: VERSION
================================================
0.64.0
================================================
FILE: cmd/yace/main.go
================================================
// Copyright The Prometheus Authors
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package main
import (
"context"
"fmt"
"log/slog"
"net/http"
"net/http/pprof"
"os"
"slices"
"strings"
"github.com/prometheus/common/promslog"
promslogflag "github.com/prometheus/common/promslog/flag"
"github.com/prometheus/common/version"
"github.com/urfave/cli/v2"
"golang.org/x/sync/semaphore"
exporter "github.com/prometheus-community/yet-another-cloudwatch-exporter/pkg"
"github.com/prometheus-community/yet-another-cloudwatch-exporter/pkg/clients"
"github.com/prometheus-community/yet-another-cloudwatch-exporter/pkg/clients/cloudwatch"
"github.com/prometheus-community/yet-another-cloudwatch-exporter/pkg/config"
)
const (
enableFeatureFlag = "enable-feature"
htmlVersion = `<html>
<head><title>Yet Another CloudWatch Exporter
Thanks for using YACE :)
Version: %s
Metrics
%s