Skip to content

Commit

Permalink
[docs] Update surfacers docs to reflect recent changes (cloudprober#650)
Browse files Browse the repository at this point in the history
  • Loading branch information
manugarg committed Dec 16, 2023
1 parent e31acf1 commit e3883ec
Showing 1 changed file with 8 additions and 10 deletions.
18 changes: 8 additions & 10 deletions docs/content/docs/surfacers/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ Cloudprober currently supports following surfacer types:
([config](https://cloudprober.org/docs/config/surfacer/#cloudprober_surfacer_prometheus_SurfacerConf))
- OpenTelemetry (OTEL)
([config](https://cloudprober.org/docs/config/surfacer/#cloudprober_surfacer_otel_SurfacerConf))
[New in v0.13.2]
- [Stackdriver (Google Cloud Monitoring)](../stackdriver)
- Google Pub/Sub
([config](https://cloudprober.org/docs/config/surfacer/#cloudprober_surfacer_pubsub_SurfacerConf))
Expand Down Expand Up @@ -76,8 +77,8 @@ Cloudwatch to save on the costs.

### Filtering by Label

To filter metrics by labels, use one of the following keys in the surfacer
configuration:
To filter metrics by labels, use one of the following options in the
[surfacers config](https://cloudprober.org/docs/config/surfacer/#cloudprober_surfacer_SurfacerDef):

- `allow_metrics_with_label` (`allowMetricsWithLabel` in yaml)
- `ignore_metrics_with_label` (`ignoreMetricsWithLabel` in yaml)
Expand Down Expand Up @@ -113,14 +114,8 @@ surfacer {

#### Filtering by Metric Name

For certain surfacers, cloudprober can filter metrics by name as well. Surfacers
that support this functionality are:

- Cloudwatch
- Prometheus
- Stackdriver

Within the surfacer configuration, use one of the following options:
To filter metrics by name, use one of the following options in the
[surfacers config](https://cloudprober.org/docs/config/surfacer/#cloudprober_surfacer_SurfacerDef):

- `allow_metrics_with_name ` (`allowMetricsWithName` in yaml)
- `ignore_metrics_with_name` (`ignoreMetricsWithName` in yaml)
Expand Down Expand Up @@ -155,6 +150,9 @@ backend monitoring system:
}
```

_NOTE: This option is now enabled by default for all surfacers, except for
FILE and PUBSUB surfacers._

2. **export_as_gauge**: Export gauge metrics instead of cumulative. Cloudprober
exports cumulative metrics (sum of values so far) by default, but you can
configure it to export gauge metrics instead. Gauge metrics make
Expand Down

0 comments on commit e3883ec

Please sign in to comment.