Skip to content

Commit

Permalink
chore(docs): Replicate custom histograms CHANGELOG to v1.46.0. (#5351)
Browse files Browse the repository at this point in the history
  • Loading branch information
abernix authored Jun 6, 2024
1 parent bad3b55 commit 3d2269f
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -423,6 +423,41 @@ For details about the caching behavior, see [PR #4855](https://github.com/apollo

By [@Geal](https://github.com/Geal) in https://github.com/apollographql/router/pull/4855

### Add configurable histogram buckets per metric ([Issue #4543](https://github.com/apollographql/router/issues/4543))

> [!NOTE]
>
> This feature was introduced in v1.40.0 but was prevented from working best until subsequent fixes in later versions. Therefore, this v1.46.0 release is the first release in which we recommend its use.

The router supports overriding instrument settings for metrics with [OpenTelemetry views](https://opentelemetry.io/docs/concepts/signals/metrics/#views). You can use views to override default histogram buckets.

Configure views with the `views` option. For example:

```yaml
telemetry:
exporters:
metrics:
common:
service_name: apollo-router
views:
- name: apollo_router_http_request_duration_seconds # Instrument name you want to edit. You can use wildcard in names. If you want to target all instruments just use '*'
unit: "ms" # (Optional) override the unit
description: "my new description of this metric" # (Optional) override the description
aggregation: # (Optional)
histogram:
buckets: # Override default buckets configured for this histogram
- 1
- 2
- 3
- 4
- 5
allowed_attribute_keys: # (Optional) Keep only listed attributes on the metric
- status
```

By [@bnjjj](https://github.com/bnjjj) in https://github.com/apollographql/router/pull/4572


### Add support of custom events defined by YAML for telemetry ([Issue #4320](https://github.com/apollographql/router/issues/4320))

Users can now [configure telemetry events via YAML](https://www.apollographql.com/docs/router/configuration/telemetry/instrumentation/events/)
Expand Down Expand Up @@ -1475,6 +1510,10 @@ By [@bnjjj](https://github.com/bnjjj) in https://github.com/apollographql/router

### Add configurable histogram buckets per metric ([Issue #4543](https://github.com/apollographql/router/issues/4543))

> [!NOTE]
>
> While this feature was introduced in this v1.40.0 release, it was prevented from working best subsequent fixes in later versions. We recommend using _at least_ Router v1.46.0 to use this feature.

The router supports overriding instrument settings for metrics with [OpenTelemetry views](https://opentelemetry.io/docs/concepts/signals/metrics/#views). You can use views to override default histogram buckets.

Configure views with the `views` option. For example:
Expand Down

0 comments on commit 3d2269f

Please sign in to comment.