Skip to content

Commit

Permalink
Formatting fixes
Browse files Browse the repository at this point in the history
Signed-off-by: Matej Gera <[email protected]>
  • Loading branch information
matej-g committed Nov 28, 2023
1 parent f41207e commit e8cfead
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 4 deletions.
2 changes: 1 addition & 1 deletion logs/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
### v1.16.3 / 2023-11-23

* [CHANGE] Update the coralogix API

### v1.16.3 / 2023-11-22

* [UPGRADE] Upgrade Fluentd version to v1.16.3
Expand Down
4 changes: 2 additions & 2 deletions otel-integration/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@

### v0.0.37 / 2023-11-27
* [:warning: BREAKING CHANGE] [FEATURE] Add support for span metrics preset. This replaces the deprecated `spanmetricsprocessor`
with `spanmetricsconnector`. The new connector is disabled by default, as opposed the replaces processor.
To enable it, set `presets.spanMetrics.enabled` to `true`.
with `spanmetricsconnector`. The new connector is disabled by default, as opposed the replaces processor.
To enable it, set `presets.spanMetrics.enabled` to `true`.

### v0.0.36 / 2023-11-15
* [FIX] Change statsd receiver port to 8125 instead of 8127
Expand Down
1 change: 1 addition & 0 deletions otel-integration/UPGRADING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ opentelemetry-agent:
spanMetrics:
enabled: true
```
Please beware there are also breaking changes with regards to metric naming and labels. Please see the [this section of documentation](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/connector/spanmetricsconnector/README.md#span-to-metrics-processor-to-span-to-metrics-connector) for more information.
## 0.0.32 to 0.0.33
Expand Down
3 changes: 2 additions & 1 deletion otel-integration/k8s-helm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,11 +190,12 @@ env:
```
### About span metrics
The collector provides a possibility to synthesize R.E.D (Request, Error, Duration) metrics based on the incoming span data. This can be useful to obtain extra metrics about the operations you have instrumented for tracing. For more information, please refer to the [OpenTelemetry Collector documentation](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/connector/spanmetricsconnector/README.md).
This feature is disabled by default and can be enabled by setting the `spanmetrics.enabled` value to `true` in the `values.yaml` file.

Beware that enabling the feature will result in creation of additional metrics. Depending on how you instrument your applications, this can result in a significant increase in the number of metrics. This is especially true for cases where the span name includes specific values, such as user IDs or UUIDs. Such instrumentation practice is [strongly discouraged](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/api.md#span).
Beware that enabling the feature will result in creation of additional metrics. Depending on how you instrument your applications, this can result in a significant increase in the number of metrics. This is especially true for cases where the span name includes specific values, such as user IDs or UUIDs. Such instrumentation practice is [strongly discouraged](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/api.md#span).

In such cases, we recommend to either correct your instrumentation or to use the `spanMetrics.spanNameReplacePattern` parameter, to replace the problematic values with a generic placeholder. For example, if your span name corresponds to template `user-1234`, you can use the following pattern to replace the user ID with a generic placeholder. See the following configuration:

Expand Down

0 comments on commit e8cfead

Please sign in to comment.