Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/memes/gce-metric
Synthetic metric generator for testing GCP autoscaling
https://github.com/memes/gce-metric
gcp google metrics stackdriver
Last synced: 7 days ago
JSON representation
Synthetic metric generator for testing GCP autoscaling
- Host: GitHub
- URL: https://github.com/memes/gce-metric
- Owner: memes
- License: mit
- Created: 2020-06-09T05:09:57.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-12-27T19:32:18.000Z (25 days ago)
- Last Synced: 2024-12-27T20:22:11.014Z (25 days ago)
- Topics: gcp, google, metrics, stackdriver
- Language: Go
- Size: 1.25 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# GCP custom metric generator
[](CODE_OF_CONDUCT.md)
[](https://pkg.go.dev/github.com/memes/gce-metric)
[](https://goreportcard.com/report/github.com/memes/gce-metric)
A synthetic metric generator for Google Cloud that will create a time-series of
artificial metrics that can be consumed by an autoscaler, or other metric-bound
resource. The application will automatically generate a time-series
with labels appropriate for [gce_instance] or [gke_container] metrics, if detected,
with fallback to [generic_node] metrics.
## Usage
The application has three-forms of operation; *generator*, *list*, and *delete*.
### Generator
```shell
gce-metric waveform [flags] NAME
```
- *waveform* is one of sawtooth, sine, square, or triangle, and sets the pattern
for the metrics (see images below)
- **NAME** is the custom metric type to add to GCP; this name must not conflict
with existing metrics provided by GCP, and convention suggests that it be of
the form `custom.googleapis.com/name` - see GCP [creating metrics] docs for
details.
All options have a default values which can be overridden through command line
flags, environment variables, or a configuration file.
- `--floor N` sets the minimum value for the cycles, can be an integer or floating
point value
- `--ceiling N` sets the maximum value for the cycles, can be an integer of
floating point value
- `--period T` sets the duration for one complete cycle from floor to ceiling,
must be valid Go duration string (see [time.ParseDuration])
- `--sample T` sets the interval between sending metrics to Google Monitoring,
must be valid Go duration string (see [time.ParseDuration])
- `--verbose` set the logging levels to include more details
- `--integer` forces the generated metrics to be integers, making them less smooth
and more step-like
> **NOTE:** Custom metric names can be reused as long as the type of the metric
> doesn't change; i.e. if you created a metric with floating point values, and
> then try to use `--integer` with the same metric name it will fail.
When executed on a GCE VM, or in a container with access to GCE metadata, the
project identifier (and other details) will be pulled from the metadata server.
If you run the application on a non-GCP system you will need to ensure you are
authenticated to GCP and authorised to create metric time-series.
- `--project ID` will set (or override discovered) project ID for the metrics
#### Example: Sawtooth
```shell
gce-metric sawtooth --floor 0 --ceiling 100 --period 20m --sample 30s custom.googleapis.com/gce_metric/sawtooth
```
#### Example: Sine
```shell
gce-metric sine --floor 0 --ceiling 100 --period 20m --sample 30s custom.googleapis.com/gce_metric/sine
```
#### Example: Square
```shell
gce-metric square --floor 0 --ceiling 100 --period 20m --sample 30s custom.googleapis.com/gce_metric/square
```
#### Example: Triangle
```shell
gce-metric triangle --floor 0 --ceiling 100 --period 20m --sample 30s custom.googleapis.com/gce_metric/triangle
```
### List
To list custom metrics
```shell
gce-metric list [--verbose] [--project ID --filter FILTER]
```
- `--filter` applies a [metric filter] to the list. If omitted, the default filter
will limit the results to metrics matching `custom.googleapis.com/*` in the
project.
### Delete
To delete one or more custom metrics use
```shell
gce-metric delete [--verbose] [--project ID] NAME...
```
or combine with [list](#list) to delete all custom metrics matching a criteria
```shell
gce-metric list [--project ID] --filter FILTER | \
xargs gce-metric delete [--project ID]
```
## Binaries
Binaries are published on the [Releases] page for Linux, macOS, and Windows. If
you have Go installed locally, `go install github.com/memes/gce-metric/cmd/gce-metric`
will download and install to *$GOBIN*.
A container image is also published to Docker Hub and GitHub Container Registries
that can be used in place of the binary; just append the arguments to the
`docker run` or `podman run` command.
E.g.
```shell
podman run -d --rm --name gce-metric \
ghcr.io/memes/gce-metric:v1.2.3 \
sawtooth -period 1h -sample 2m
```
## Verifying releases
For each tagged release, an tarball of the source and a [syft] SBOM is created,
along with SHA256 checksums for all files. [cosign] is used to automatically generate
a signing certificate for download and verification of container images.
### Verify release files
1. Download the checksum, signature, and signing certificate file from GitHub
```shell
curl -sLO https://github.com/memes/gce-metric/releases/download/v1.2.3/gce-metric_1.2.3_SHA256SUMS
curl -sLO https://github.com/memes/gce-metric/releases/download/v1.2.3/gce-metric_1.2.3_SHA256SUMS.sig
curl -sLO https://github.com/memes/gce-metric/releases/download/v1.2.3/gce-metric_1.2.3_SHA256SUMS.pem
```
2. Verify the SHA256SUMS have been signed with [cosign]
```shell
cosign verify-blob \
--cert gce-metric_1.2.3_SHA256SUMS.pem \
--signature gce-metric_1.2.3_SHA256SUMS.sig \
gce-metric_1.2.3_SHA256SUMS
```
```text
verified OK
```
3. Download and verify files
Now that the checksum file has been verified, any other file can be verified
using `sha256sum`.
For example
```shell
curl -sLO https://github.com/memes/gce-metric/releases/download/v1.2.3/gce-metric-1.2.3.tar.gz.sbom
curl -sLO https://github.com/memes/gce-metric/releases/download/v1.2.3/gce-metric_1.2.3_linux_amd64
sha256sum --ignore-missing -c gce-metric_1.2.3_SHA256SUMS
```
```text
gce-metric-1.2.3.tar.gz.sbom: OK
gce-metric_1.2.3_linux_amd64: OK
```
### Verify container image
Use [cosign]s experimental OCI signature support to validate the container.
```shell
COSIGN_EXPERIMENTAL=1 cosign verify ghcr.io/memes/gce-metric:v1.2.3
```
[gce_instance]: https://cloud.google.com/monitoring/api/resources#tag_gce_instance
[gke_container]: https://cloud.google.com/monitoring/api/resources#tag_gke_container
[generic_node]: https://cloud.google.com/monitoring/api/resources#tag_generic_node
[creating metrics]: https://cloud.google.com/monitoring/custom-metrics/creating-metrics#custom_metric_names
[time.ParseDuration]: https://golang.org/pkg/time/#ParseDuration
[Releases]: https://github.com/memes/gce-metric/releases
[cosign]: https://github.com/SigStore/cosign
[syft]: https://github.com/anchore/syft
[metric filter]: https://cloud.google.com/monitoring/api/v3/filters#filter_syntax